绝对值得收藏的Retrofit原理分析

本文主要讲述Retrofit的源码分析,结合个人总结的结构图,配上Retrofit源码,可以很大程度地帮助理解Retrofit的内部结构

此图是本人耗费一周时间阅读源码整理出来的结构图,点此获取pdf文件与结构文件

关于Retrofit2的使用,网上有大量的文章做了讲解,本文便不再进行重复阐述,重点来讲述Retrofit2的结构流程,废话不多说

下面是使用retrofit进行一个简单的网络请求

			Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("https://www.xxxxx.com")
                .addConverterFactory(GsonConverterFactory.create(new Gson()))
                .build();
            OKHttpService httpService = retrofit.create(OKHttpService.class);
			httpService.login("ssss", "123123").enqueue(new Callback() {
            @Override
            public void onResponse(Call call, Response response) {
                Log.i("WeiSir", "陈宫: " + Thread.currentThread());
                }

            @Override
            public void onFailure(Call call, Throwable t) {
                Log.i("WeiSir", "失败: " + Thread.currentThread());
            }

通过构建者模式创建Retrofit对象,依次来看每一行的功能

• Retrofit.Builder:在Retrofit的Builder静态类中,主要执行了Platform.get()方法,其内部的findplatform()判断当前的执行平台,因为这里是在Android平台中运行的,所以会return new Android()返回一个Platform对象,之后在网络请求结束后,默认会通过内部的主线程handler的post()将异步线程切换到主线程在结构图中有对应的源码)
• baseUrl():关于baseUrl在图中没有标注,其主要功能是将传入的地址转换为HttpUrl,return baseUrl(httpUrl)中会获取网址的path部分,并将这部分每一级路径分割成为一个集合,来判断路径的的最后结尾是否是’/‘结束,所以在传递基地址时path路径的结尾必须要以’/‘结尾,否则会抛IllegalArgumentException(""baseUrl must end in /: "+baseUrl)异常,有人会说,“以前没加怎么没碰到异常呢?”,注意,该方法判断的是传入地址的路径部分,如果地址为’https:www.baidu.com’,这里只有协议类型和域名地址,没有路径部分,所以不写’/'是不会报错的
• addConverterFactory():添加一个数据转换工厂,若想使login()返回值是自己Call对象,就需要用到数据转换工厂,此工厂默认添加的是BuiltInConverters,返回原始的Call< ResponseBody>,这里添加的所有数据转换工厂最终都会被加入到List集合中,并不会进行覆盖
• build() 熟悉构建者模式的都知道,前面的操作仅仅只是将参数保存起来了,真正的对象创建是在build()中实现的,其中添加了默认的默认的网络执行器,回调方法执行器(这里的执行器默认就是Builder对象中Platform.get()下获取的MainThreadExecutor),网络请求适配器,数据转换器,结合图片来看

 public Retrofit build() {
   okhttp3.Call.Factory callFactory = this.callFactory;
      if (callFactory == null) {  //添加默认的request执行工厂
        callFactory = new OkHttpClient();
      }
   Executor callbackExecutor = this.callbackExecutor;
      if (callbackExecutor == null) {  //创建网络回调执行器
        callbackExecutor = platform.defaultCallbackExecutor();
      }
   List callAdapterFactories = new ArrayList<>(this.callAdapterFactories);
      callAdapterFactories.add(platform.defaultCallAdapterFactory(callbackExecutor));//添加网络请求适配器
      
   List converterFactories = new ArrayList<>(1 + this.converterFactories.size()); 
   //添加默认的数据转换工厂
      converterFactories.add(new BuiltInConverters());
      converterFactories.addAll(this.converterFactories);
 }

public interface OKHttpService{
    @FormUrlEncoded
    @POST("user/login")
    Call login(@Field("username") String userName, @Field("password") String password);
}

这里没什么好说的,若想使用自定义的javabean对象,将ResponseBody改成相应的javaBean对象即可

    OKHttpService httpService = retrofit.create(OKHttpService.class);

create()内部实现了Retrofit的核心功能的创建和调度

  public  T create(final Class service) {
//.....省略...
    return (T) Proxy.newProxyInstance(service.getClassLoader(), new Class[] { service },
        new InvocationHandler() {
          @Override public Object invoke(Object proxy, Method method, @Nullable Object[] args)
          //这里看来原方法不一定会被调用,主要执行代理的操作
            if (method.getDeclaringClass() == Object.class) {
              return method.invoke(this, args);
            }
           //核心的三行代码
            ServiceMethod serviceMethod =
                (ServiceMethod) loadServiceMethod(method);   //创建的代理方法对象,其内部包含了login方法的注解参数,返回值,以及各个工厂以及各请求器转换器等等的适配操作
            OkHttpCall