retrofit原理详解

Posted 2023-04-18

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了retrofit原理详解相关的知识，希望对你有一定的参考价值。

参考技术A 这里之所以叫Retrofit客户端。客户端提供的子系统有：
1.serviceMethodCache(自定义的接口映射对象集合)
2.baseUrl(请求地址)
3.callFactory(默认为OkHttpCall)
4.converterFactories(数据解析器工厂集合)
5.callAdapterFactories(Call适配器工厂集合)
6.callbackExecutor(回调执行，android平台默认为MainThreadExecutor)

客户端的创建有两种方式：
第一种就是使用构造函数，如下所示。
第二种就是Retrofit.Builder()。
我们一般使用第二种方式来创建客户端。

接下来看看通过构建者模式创造的Retrofit客户端，使用构建者模式，有如下好处，对外可以屏蔽创建对象的细节，同时也可以自由配置Retrofit客户端的属性。

接着就到Platform.get()方法里

接着看看这个安卓平台的做了啥事

可以看出这个Build类初始化了如下：
Platform:安卓平台对象网络请求适配器工厂：CallAdapterFactory
数据转换器工厂：converterFactory 回调执行器：callbackExecutor

先看看GsonConverterFactory.creat()里做了啥事

这就是创建了一个还有Gson对象的GsonConverterFactory，并添加进converterFactorues中

由此看出
1.Retrofit默认使用Gson进行解析
2.若使用其他解析方式（如XML或Protocobuf），也可通过自定义数据解析器来实现（必须继承 Converter.Factory），重写那两个方法。

还有最后一个步骤，build(),Retrofit客户端就创建完成了。

Retrofit是通过动态代理模式创建网络接口的实例，同时，通过解析注解("wanandroid")进行了网络请求参数的配置

现在先来看接口的实例如何创建出来的

接着看loadServiceMethod()里做了啥事

接着去看parseAnnotations里做了啥事

最后就生成了一个serviceMethod对象。

接下来去分析一下这个serviceMethod

我们知道，Retrofit是对OkHttp做了一层封装，具体的网络发起人还是OkHttp，关键是怎么样通过这个serviceMethod来完成的呢？
先来看看构造函数，接收四个，第一个就是请求工厂，包含所有的请求参数，第二个就是网络接口的参数，第三个就是网络接口转换工厂，第四个就是数据转化工厂。

这里已经可以获取到我们所有网络请求发起需要的参数了。
接着去看看adapt,这就是网络接口请求返回类型的的适配，比如用的时RxjavaCallAdapter，返回的就是observerble。

最后的请求由OkhttpCall来发起。

这个callBack就是在创建时客户端时那个ExtutorCallback。来完成线程的切换

1.Retrofit将Http请求抽象成java接口
2.接口里用注解描述和配置网络请求参数
3.动态代理的方式来生成call对象。

深度详解Retrofit2使用基础入门

前言

何为Retrofit？

借用官网的原话，

Type-safe HTTP client for Android and Java by Square, Inc.

适用于Android 和 Java 的类型安全的HTTP客户端，由Square提供的。（敲黑板）

由此我们可以得知，Retrofit是一种HTTP客户端框架，使用它，我们可以完成有关HTTP的工作！

（心中是不是会想到，Okhttp也是网络框架，到底哪一个好用而不贵呢？带着这个疑问，开始本篇文章！）

目前Retrofit最新版本是2.3.0，可以看看Retrofit的官网和Retrofit的github！本文中使用的Retrofit是Retrofit2.3.0版本。

一. Retrofit 入门

1.1 使用Retrofit前，需要先引入Retrofit 库。

1. 在Android中使用Retrofit ，只需要在build.gradle文件中添加以下代码，

compile 'com.squareup.retrofit2:retrofit:2.3.0'

然后，同步就可以了！就是这么简单！

2. 在Java中使用Retrofit ，如果没有使用Maven或者其他项目管理工具的话，那么就需要我们手动将jar 包下载下来，而且需要下载好几个jar。下载完成后，加入到项目的build path。具体的需要下载的jar截图如下所示，

如果使用了Maven或者其他项目管理工具，那么就只需要在相关的依赖管理文件中加入Retrofit 的依赖即可！例如在Maven依赖管理文件中添加如下代码，

<dependency>
  <groupId>com.squareup.retrofit2</groupId>
  <artifactId>retrofit</artifactId>
  <version>2.3.0</version>
</dependency>

a. Retrofit 的网络请求其实是交给okhttp处理的，所以需要引入okhttp，我们都知道okhttp也是Square的开源杰作。（敲黑板）

b. okio是什么玩意？okio 是一个包装了 java.io 和 java.nio api 的库，以便可以更容易的访问、存储以及处理数据，它是Square公司推出的Java IO库，也是OKHttp依赖的IO库。（敲黑板）

Retrofit ，OKhttp，Okio 应该可以称为Square全家桶吧！

PS:

因为需要服务端提供接口数据，所以我在自己电脑上搭建了一个web服务器。具体如何搭建，请看java web开发(二) 接口开发！

1.2 下面就先以一个实例开始Retrofit ！（本文是在Java使用Retrofit ，下篇文章讲解在Android使用Retrofit ！）

1. 定义接口。

使用Retrofit ，首先需要将你的HTTP API改造成Java接口。例如，

	public interface ApiService 

		@GET("StudentInq")
		Call<ResponseBody> getStudents();

ApiService 接口定义了一个方法getStudents()，@GET表示该方法是GET请求，该方法没有参数，@GET("StudentInq")中的“StudentInq”是path（相对URL），这个path和baseUrl一起组成了接口的请求全路径，例如baseUrl是“http://localhost:8080/mServer/”，那么全路径就是“http://localhost:8080/mServer/getStudent”。（baseUrl下文会提到）

2. 实例化Retrofit。

a. 首先定义了服务请求的URL，

// 服务请求url
	public static final String API_URL = "http://localhost:8080/mServer/";

这个API_URL就是baseUrl，是由ip和端口等组成。

PS: 请求URL，需要以“/”结尾，否则会报错。（敲黑板）

b. 创建Retrofit 实例，

	Retrofit retrofit = new Retrofit.Builder().baseUrl(API_URL).build();

通过构造者模式创建了Retrofit ，其中设置了请求的

baseUrl。

c. 接着创建接口实例，

ApiService service = retrofit.create(ApiService.class);

从源码中可以得知，内部使用了动态代理模式。

d. 下面就可以调用接口中的方法了，

// 调用具体接口方法
		Call<ResponseBody> call = service.getStudents();
		//异步执行请求
		call.enqueue(...);

如果是同步请求，调用execute；而发起一个异步请求则调用enqueue。
下面是完整的代码，

public class GetTest 

	// 服务请求url
	public static final String API_URL = "http://localhost:8080/mServer/";

	public interface ApiService 

		@GET("StudentInq")
		Call<ResponseBody> getStudents();
	

	public static void main(String[] args) 
		getList();
	

	/**
	 * 获取数据
	 */
	private static void getList() 
		// 创建Retrofit实例
		Retrofit retrofit = new Retrofit.Builder().baseUrl(API_URL).build();
		// 生成ApiService接口代理
		ApiService service = retrofit.create(ApiService.class);
		// 调用具体接口方法
		Call<ResponseBody> call = service.getStudents();
		//异步执行请求
		call.enqueue(new Callback<ResponseBody>() 

			@Override
			public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) 
				// TODO Auto-generated method stub
				try 
					System.out.println(response.body().string());
				 catch (IOException e) 
					// TODO Auto-generated catch block
					e.printStackTrace();
				
			

			@Override
			public void onFailure(Call<ResponseBody> arg0, Throwable arg1) 
				// TODO Auto-generated method stub

			
		);

运行后的截图如下，

使用Retrofit 完成网络请求确实很方便、快捷，并且代码量也少！

上面是使用Retrofit 的简单实例，可以看到，在定义接口时使用了注解，那么下面我们就来看看Retrofit 的注解。

二. Retrofit 注解

Retrofit 共22个注解，这些注解大致分三类，请求方法类、标记类和参数类。Retrofit 的注解是运行时注解，在运行时创建动态代理的方式来提供AOP能力。

2.1 请求方法类

1. 序号1~7。

a. 都是HTTP的请求方法；

b. 这些注解都有一个value()方法，例如，

		@GET("StudentInq")
		Call<ResponseBody> getStudents();

下面是GET注解的源码，

它有一个value()方法，接收一个字符串（StudentInq），“StudentInq”这个就是path，也就是相对URL，它与baseUrl组成全路径；

c. 这个path可以使用变量，如 id ，并使用 @Path("id") 注解为 id 提供值，例如；

@GET("StudentInq/id")
		Call<ResponseBody> getStudentById(@Path("id")int id);

2. 序号8，HTTP注解。

a. 用于替代以上7个注解，以及其他扩展方法；

b. 有三个属性，method、path、hasBody，首先看看HTTP注解的源码，

method：请求方法（区分大小写），

path：请求相对路径，

hasBody：是否有body(请求体)，

下面是HTTP注解的使用例子，

	@HTTP(method="GET",path="StudentInq/id",hasBody=false)
		Call<ResponseBody> getStudentById(@Path("id")int id);

2.2 标记类

2.3 参数类

1. @Headers

使用 @Headers 注解设置固定的请求头，所有请求头不会相互覆盖，即使名字相同。

2. @Header

使用 @Header 注解动态更新请求头，匹配的参数必须提供给 @Header ，若参数值为 null ，这个头会被省略，否则，会使用参数值的 toString 方法的返回值。

3. @Body

使用 @Body 注解，指定一个对象作为 request body。

4. @Field

表单提交，与 FieldMap、FormUrlEncoded注解配合使用。

5. @FieldMap

表单提交，与 Field、FormUrlEncoded 注解配合使用；接受 Map<String, String> 类型，非 String 类型会调用 toString() 方法。

6. @Part

表单字段，与 PartMap、@Multipart注解配合，适合文件上传情况。表示多部分请求中的单个部分。该注解的的参数类型有三种：

a. 如果类型是MultipartBody.Part，则内容将直接使用。忽略注释中的名称（即@Part MultipartBody.Part部分）；

b. 如果类型是RequestBody，则该值将直接与其内容类型一起使用。在注释中提供零件名称（例如@Part（“foo”）RequestBody foo）；

c. 其他对象类型将通过使用转换器转换为适当的表示形式。在注释中提供零件名称（例如，@Part（“foo”）Image photo）；值可以是null，它将从请求主体中被省略。

7. @PartMap

表单字段，与 Part 、@Multipart注解配合，适合文件上传情况；默认接受 Map<String, RequestBody> 类型，非 RequestBody 会通过 Converter 转换。

8. @Path

请求 URL 可以替换模块来动态改变，替换模块是包含的字母数字字符串，替换的参数必须使用 @Path 注解的相同字符串。

9. @Query和@QueryMap

将数据转换成“键=值”的形式，并且添加到URL的结尾。例如，id=110&sex=nan。

10. @Url

动态指定Path路径。

PS:

1. Query、QueryMap 与 Field、FieldMap 功能一样，生成的数据形式一样；只不过Query、QueryMap 的数据体现在 Url 上；Field、FieldMap 的数据是请求体；

2. 占位符和PATH尽量只用在URL的path部分，url中的参数使用Query和QueryMap 代替，保证接口定义的简洁。

以上就是Retrofit 的全部注解。这些概念还是比较抽象，下面就通过实例，看看这些注解的具体使用。

三. 注解实例

3.1 @Path 使用。

使用GET请求，接口请求全路径是“http://localhost:8080/mServer/getStudent/1”，下面是具体实现代码，

public class PathTest 

	// 服务请求url
	public static final String API_URL = "http://localhost:8080/mServer/";

	public interface ApiService 

		@GET("getStudent/id")//这里的id 表示是一个变量
		Call<ResponseBody> getStudents(@Path("id") int id);

	

	public static void main(String[] args) 
		// TODO Auto-generated method stub
		getList();
	

	/**
	 * 获取数据
	 */
	private static void getList() 
		// 创建Retrofit实例
		Retrofit retrofit = new Retrofit.Builder().baseUrl(API_URL).build();
		// 生成ApiService接口代理
		ApiService service = retrofit.create(ApiService.class);
		// 调用具体接口方法
		Call<ResponseBody> call = service.getStudents(1);
		// 异步执行请求
		call.enqueue(new Callback<ResponseBody>() 

			@Override
			public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) 
				// TODO Auto-generated method stub
				try 
					System.out.println(response.body().string());
				 catch (IOException e) 
					// TODO Auto-generated catch block
					e.printStackTrace();
				
			

			@Override
			public void onFailure(Call<ResponseBody> arg0, Throwable arg1) 
				// TODO Auto-generated method stub

			
		);

运行后客户端的截图，

并且我在服务端打印了RequestURI和RequestURL，下面是运行截图，

3.2 @Query、@QueryMap和@URL 使用。

1. 首先看@Query注解。定义接口，

...
@GET("StudentInq")
		Call<ResponseBody> getStudents(@Query("sex") String sex,@Query("mobile") String mobile);
...

接口调用，

...
// 调用具体接口方法
		Call<ResponseBody> call = service.getStudents("nan","123456789");
...

我在服务端doget()方法中打印了请求参数和其他信息，下面是主要代码，

...
Enumeration enu=request.getParameterNames();  
		while(enu.hasMoreElements())  
		String paraName=(String)enu.nextElement();  
		System.out.println(paraName+": "+request.getParameter(paraName));  
		
		
		System.out.println("getRequestURI: "+request.getRequestURI());  
		System.out.println("getRequestURL: "+request.getRequestURL());  
		System.out.println("getQueryString: "+request.getQueryString());  //获取get方式中的参数列表
...

运行后服务端截图，

2. 接着是@QueryMap注解。

定义接口，

...
	@GET("StudentInq")
		Call<ResponseBody> getStudents(@QueryMap Map<String, String> map);
...

接口调用，

...
Map<String, String> map=new HashMap<>();
		map.put("id", "110");
		map.put("sex", "nan");
		// 调用具体接口方法
		Call<ResponseBody> call = service.getStudents(map);
...

运行后服务端截图，

小结：

@Query注解和@QueryMap注解，他们的功能本质上是一样的，都是把数据转化成类似“id=110&sex=nan”这样的格式，并且添加到请求的路径尾部；只不过@Query是一个一个接收参数，而@QueryMap是一次性接收一个集合。

@Query注解和@QueryMap注解的参数如果不是String（或Map的第二个泛型参数不是String）时会被默认会调用toString转换成String类型。

3. @URL注解。

定义接口，

...
		@GET
		Call<ResponseBody> getStudents(@Url String name);
...

接口调用，

...
		// 调用具体接口方法
		Call<ResponseBody> call = service.getStudents("StudentInq");
...

就不显示运行后服务端截图了，前面的运行结果一样！使用@URL注解可以设置Path(相对URL)。
3.3 @Headers和@Header注解。

首先是@Headers注解。

...		
@Headers("Accept:text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
		    "User-Agent: Retrofit-Sample-App",
             "Cache-Control:no-cache")
		@GET("StudentInq")
		Call<ResponseBody> getStudents();
...

定义接口后，调用接口。我在服务端打印了请求头信息，具体代码如下，

...
		Enumeration<String> reqHeadInfos = request.getHeaderNames();// 获取所有的请求头
		while (reqHeadInfos.hasMoreElements()) 
			String headName = (String) reqHeadInfos.nextElement();
			String headValue = request.getHeader(headName);// 根据请求头的名字获取对应的请求头的值
			System.out.println(headName + ": " + headValue);
		
...

调用接口后服务端截图，

接着看@Header注解，

定义接口，

...
		@GET("StudentInq")
		Call<ResponseBody> getStudents(@Header("Pragma") String Pragma);
...

调用接口，

...
// 调用具体接口方法
		Call<ResponseBody> call = service.getStudents("no-cache");
...

调用接口后服务端截图，

小结：@Headers和@Header这两个注解都是用来设置请求头信息的，只不过@Headers是设置固定值的请求头，而@Header可以设置动态的请求头。

3.4 @Field和@FieldMap。

这两个注解，我们前面已经给出了定义，需要配合@FormUrlEncoded使用。

定义接口，

...
		
		@FormUrlEncoded
		@POST("getStudent")
		Call<ResponseBody> getStudent(@Field("id")int id,@Field("name")String name,@Field("sex")String sex);
		
		@FormUrlEncoded
		@POST("getStudent")
		Call<ResponseBody> getStudent(@FieldMap Map<String, String>map);
...

定义了两个方法，都是POST请求。第一个方法使用@Field定义了几个参数，而第二个方法使用@FieldMap定义了一个map。接口调用，

...
// 调用具体接口方法
				Call<ResponseBody> call = service.getStudent(111,"xx","nan");
		Map<String, String> map=new HashMap<>();
		map.put("id", "119");
		map.put("name", "xw");
		map.put("sex", "nan");
		// 调用具体接口方法
		Call<ResponseBody> call1 = service.getStudent(map);
...

我在服务端doPost()方法中打印请求参数列表，具体代码如下，

...
		Enumeration enu=request.getParameterNames();  
		while(enu.hasMoreElements())  
		String paraName=(String)enu.nextElement();  
		System.out.println(paraName+": "+request.getParameter(paraName));  
		
...

调用接口后服务端截图，

小结：@Field和@FieldMap这两个注解，在本质上是一样的，都是将请求的数据按照 key1=val1&key2=val2 的方式进行编码，并放置在请求体中，并且Form表单的编码格式必须是“application/x-www-form-urlencoded”（也就是POST需要使用@FormUrlEncoded）。换句话说，在使用@Field和@FieldMap这两个注解时，需要满足两个方面：

1. 接口方法必须是POST请求；

2. 接口方法必须有@FormUrlEncoded注解；

如果在使用时，缺少上面的某一条件，程序会报错！至于二者的区别也很明显，就不多说了！

至此，有关注解方面的，就到此结束了！

由于篇幅原因，有关Retrofit的其他内容，就暂时放到下篇文章！详情请看深度详解Retrofit2使用（二）实践！

欢迎大家关注我的公众号

以上是关于retrofit原理详解的主要内容，如果未能解决你的问题，请参考以下文章

决策树原理与Sklearn参数详解

SVM原理与Sklearn参数详解

图文动画详解原理系列1.MySQL 索引原理详解

深度详解Retrofit2使用实践

Android Retrofit详解