Retrofit 流程分析

Retrofit(2.0.0-beta3)

简介

UML

主要类介绍

1. Retrofit
   框架入口，记录CallAdapter.Factory,Converter.Factory和网络引擎okHttpClient，完成动态代理

2. RequestBuilder
   用于整个请求的构建，包括方法（GET，POST…）、baseUrl、relativeUrl、请求头、contentType等

3. Response
   返回结果，包括返回码(code)、信息（message）、实体（body），内部持有okhttp3.Response和ResponseBody，对okhttp的再封装

4. Call
   请求的发起者，参考okhttp中的Call接口

5. Callback
   请求的异步回调

6. Converter
   将网络返回转换为对应方法的响应类型

7. Converter.Factory
   定义Converter的工厂，如GsonConverterFactory

8. CallAdapter
   将网络返回转换为对应方法的返回值类型

9. CallAdapter.Factory
   定义CallAdapter的工厂，如RxJavaCallAdapterFactory

10. ServiceMethod
    自定义ApiService中方法的代理方法对象，在这里完成注解的解析，请求的构建

11. ParameterHandler
    自定义ApiService中每个参数有不同的注解，如Query，Field等，在ServieMethod中解析成响应名称的ParameterHandler子类，如@Field–>Filed,每个参数对应一个ParameterHandler对象；参与最后请求的构建

主要注解 <—> ParameterHandler

1. GET
2. POST
3. …

流程分析

代码调用

//ApiService,sample
public interface ApiService{
    @POST("xx/xxx/xxx")
    @FormUrlEncoded
    Observable<Response<T>> sample(@Field("xx") String xx);

ApiService service = new Retrofit.Builder()
    .baseUrl(url)
    .addConverFactory(GsonConverterFacotry.create())
    .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
    .client(okHttpClient)
    .build()
    .create(ApiService.class)

//使用
service.sample("xxx")
    .subscrib(new Subscribetion(){
        ...
    })
}

重点解析create()方法

分析：

1. 使用动态代理的方式，使用注解定义请求细节
2. 主要构建过程位于ServiceMethod.Builder的build()方法中，通过对retrofit对象的引用，获取合适的Converter和CallAdapter；其中CallAdapter通过原始方法的返回类型获得，从而得到网络结果的响应类型responseType，再由responseType获取响应的Converter
3. 解析原始方法中的方法注解，获取请求方式（GET，POST…）、请求头、表单编码/MultiPart等
4. 解析原始方法中的参数注解，拼接原始url(GET方式)、添加表单（POST）等等，完成请求参数的预组合
5. 创建OkhttpCall对象，最后通过CallAdapter的adapt()方法发起请求

设计艺术

1. Builder模式

   • Retrofit的构建
   • ServiceMethod的构建

2. 工厂模式

   • Converter的获取
   • CallAdapter的获取

3. 动态代理模式

   • create方法

4. 适配器模式

   • CallAdapter – 网络返回的类型转换