美文网首页
retrofit源码分析(1)

retrofit源码分析(1)

作者: 故江 | 来源:发表于2020-03-14 11:37 被阅读0次
    Retrofit builder = new Retrofit.Builder()    //Retrofit实例是使用建造者模式通过Builder类进行创建的
                    .baseUrl("http://www.baidu.com")
                    .addConverterFactory(GsonConverterFactory.create())
                    .build();
    

    <-- retrofit类-->

    private final Map<Method, ServiceMethod<?, ?>> serviceMethodCache = new ConcurrentHashMap<>();
      // 网络请求配置对象(对网络请求接口中方法注解进行解析后得到的对象)
      // 作用:存储网络请求相关的配置,如网络请求的方法、数据转换器、网络请求适配器、网络请求工厂、基地址等
      final okhttp3.Call.Factory callFactory;
      // 网络请求器的工厂
      // 作用:生产网络请求器(Call)
      // Retrofit是默认使用okhttp
      final HttpUrl baseUrl;     // 网络请求的url地址
      final List<Converter.Factory> converterFactories;
      // 数据转换器工厂的集合
      // 作用:放置数据转换器工厂
      // 数据转换器工厂作用:生产数据转换器(converter)
      final List<CallAdapter.Factory> adapterFactories;
      // 网络请求适配器工厂的集合
      // 作用:放置网络请求适配器工厂
      // 网络请求适配器工厂作用:生产网络请求适配器(CallAdapter)
      final Executor callbackExecutor;    // 回调方法执行器
      final boolean validateEagerly;    // 标志位
      // 作用:是否提前对业务接口中的注解进行验证转换的标志位
    
    Retrofit(okhttp3.Call.Factory callFactory, HttpUrl baseUrl,
          List<Converter.Factory> converterFactories, List<CallAdapter.Factory> adapterFactories,
          Executor callbackExecutor, boolean validateEagerly) {    //构造函数
        this.callFactory = callFactory;
        this.baseUrl = baseUrl;
        this.converterFactories = unmodifiableList(converterFactories); // Defensive copy at call site.
        this.adapterFactories = unmodifiableList(adapterFactories); // Defensive copy at call site.
        this.callbackExecutor = callbackExecutor;
        this.validateEagerly = validateEagerly;
      }
    //成功建立一个Retrofit对象的标准:配置好Retrofit类里的成员变量
    

    final List<CallAdapter.Factory> adapterFactories; //网络请求执行器(Call)的适配器
    1、Call在Retrofit里默认是OkHttpCall
    2、在Retrofit中提供了四种CallAdapterFactory: ExecutorCallAdapterFactory(默认)、GuavaCallAdapterFactory、Java8CallAdapterFactory、RxJavaCallAdapterFactory
    作用:将默认的网络请求执行器(OkHttpCall)转换成适合被不同平台来调用的网络请求执行器形式

    // 把response封装成rxjava的Observeble,然后进行流式操作
    Retrofit.Builder.addCallAdapterFactory(newRxJavaCallAdapterFactory().create()); 
    // 关于RxJava的使用这里不作更多的展开
    

    <-- Builder类-->

    Builder(Retrofit retrofit) {
          platform = Platform.get();
          callFactory = retrofit.callFactory;
          baseUrl = retrofit.baseUrl;
          converterFactories.addAll(retrofit.converterFactories);
          adapterFactories.addAll(retrofit.adapterFactories);
          // Remove the default, platform-aware call adapter added by build().
          adapterFactories.remove(adapterFactories.size() - 1);
          callbackExecutor = retrofit.callbackExecutor;
          validateEagerly = retrofit.validateEagerly;
        }
    
    //无参构造
    public Builder() {
          this(Platform.get());
        }
    

    retrofit2.0

    private static Platform findPlatform() {
        try {
          Class.forName("android.os.Build");
          if (Build.VERSION.SDK_INT != 0) {
            return new Android();
          }
        } catch (ClassNotFoundException ignored) {
        }
        try {
          Class.forName("java.util.Optional");
          return new Java8();
        } catch (ClassNotFoundException ignored) {
        }
        try {
          Class.forName("org.robovm.apple.foundation.NSObject");
          return new IOS();
        } catch (ClassNotFoundException ignored) {
        }
        return new Platform();
      }
    

    retrofit3.0

    private static Platform findPlatform() {
        try {
          Class.forName("android.os.Build");    //要求JVM查找并加载指定的类(即JVM会执行该类的静态代码段)
          if (Build.VERSION.SDK_INT != 0) {
            return new Android();    // 此处表示:如果是Android平台,就创建并返回一个Android对象
          }
        } catch (ClassNotFoundException ignored) {
        }
        try {
          // 支持Java平台
          Class.forName("java.util.Optional");
          return new Java8();
        } catch (ClassNotFoundException ignored) {
        }
        return new Platform();
      }
    

    // 从上面看出:Retrofit2.0支持3个平台:Android平台、Java平台、IOS平台
    Retrofit3.0支持3个平台:Android平台、Java平台

    static class Android extends Platform {
        @Override public Executor defaultCallbackExecutor() {
          // 返回一个默认的回调方法执行器
          // 该执行器作用:切换线程(子->>主线程),并在主线程(UI线程)中执行回调方法
          return new MainThreadExecutor();
        }
    
        @Override CallAdapter.Factory defaultCallAdapterFactory(Executor callbackExecutor) {
          return new ExecutorCallAdapterFactory(callbackExecutor);
        // 创建默认的网络请求适配器工厂
        // 该默认工厂生产的 adapter 会使得Call在异步调用时在指定的 Executor 上执行回调
        // 在Retrofit中提供了四种CallAdapterFactory: ExecutorCallAdapterFactory(默认)、GuavaCallAdapterFactory、Java8CallAdapterFactory、RxJavaCallAdapterFactory
        // 采用了策略模式
        }
    
        static class MainThreadExecutor implements Executor {
         // 获取与Android 主线程绑定的Handler
          private final Handler handler = new Handler(Looper.getMainLooper());
    
          @Override public void execute(Runnable r) {
            // 该Handler是上面获取的与Android 主线程绑定的Handler 
            // 在UI线程进行对网络请求返回数据处理等操作。
            handler.post(r);
          }
        }
      }
    

    <-- baseUrl参数-->

    //baseUrl()用于配置Retrofit类的网络请求url地址
    public Builder baseUrl(String baseUrl) {
          checkNotNull(baseUrl, "baseUrl == null");
          // 把String类型的url参数转化为适合OKhttp的HttpUrl类型
          HttpUrl httpUrl = HttpUrl.parse(baseUrl);
          // 检测最后一个碎片来检查URL参数是不是以"/"结尾
          // 不是就抛出异常   
          if (httpUrl == null) {
            throw new IllegalArgumentException("Illegal URL: " + baseUrl);
          }
          return baseUrl(httpUrl);
        }
    

    <-- GsonConverterFactory.creat()参数-->
    GsonConverterFactory.creat()是创建了一个含有Gson对象实例的GsonConverterFactory,并返回给addConverterFactory()

    public static GsonConverterFactory create() {
        return create(new Gson());
      }
    
      public static GsonConverterFactory create(Gson gson) {
        // 创建了一个含有Gson对象实例的GsonConverterFactory
        return new GsonConverterFactory(gson);
      }
    
      private final Gson gson;
    
      private GsonConverterFactory(Gson gson) {
        if (gson == null) throw new NullPointerException("gson == null");
        this.gson = gson;
      }
    
    // 将上面创建的GsonConverterFactory放入到 converterFactories数组
    // 在第二步放入一个内置的数据转换器工厂BuiltInConverters()后又放入了一个GsonConverterFactory
    public Builder addConverterFactory(Converter.Factory factory) {
          converterFactories.add(checkNotNull(factory, "factory == null"));
          return this;
        }
    

    <-- build参数-->

    public Retrofit build() {
         if (baseUrl == null) {
           throw new IllegalStateException("Base URL required.");
         }
    
         <--  配置网络请求执行器(callFactory)-->
         okhttp3.Call.Factory callFactory = this.callFactory;
         if (callFactory == null) {
           callFactory = new OkHttpClient();
         }
    
         <--  配置回调方法执行器(callbackExecutor)-->
         Executor callbackExecutor = this.callbackExecutor;
         if (callbackExecutor == null) {
           callbackExecutor = platform.defaultCallbackExecutor();
         }
    
         <--  配置网络请求适配器工厂(CallAdapterFactory)-->
         // Make a defensive copy of the adapters and add the default Call adapter.
         // 向该集合中添加了步骤2中创建的CallAdapter.Factory请求适配器(添加在集合器末尾
         List<CallAdapter.Factory> adapterFactories = new ArrayList<>(this.adapterFactories);
         adapterFactories.add(platform.defaultCallAdapterFactory(callbackExecutor));
    .    
         <--  配置数据转换器工厂:converterFactory -->
         // Make a defensive copy of the converters.
         List<Converter.Factory> converterFactories = new ArrayList<>(this.converterFactories);
    
         // 最终返回一个Retrofit的对象,并传入上述已经配置好的成员变量
         return new Retrofit(callFactory, baseUrl, converterFactories, adapterFactories,
             callbackExecutor, validateEagerly);
       }
    

    Android RxJava 2.0:手把手带你 源码分析RxJava
    https://www.jianshu.com/p/e1c48a00951a

    相关文章

      网友评论

          本文标题:retrofit源码分析(1)

          本文链接:https://www.haomeiwen.com/subject/urimshtx.html