阅读:Retrofit 源码

Retofit入门使用

第一步:定义网络请求接口类

public interface MyApi {
    @FormUrlEncoded
    @POST
    Call<ResponseBody> getData(@Field("userId") String userId);
}
复制代码

第二步:初始化retrofit实例

Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("这里放基础url")
                .build();
复制代码

第三步:生成接口实现类

MyApi api = retrofit.create(MyApi.class);
复制代码

第四步:调用接口方法,发起请求

Call<ResponseBody> call = api.getData("1234");
//post请求
call.enqueue(new Callback<ResponseBody>() {
    @Override
    public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) {

    }

    @Override
    public void onFailure(Call<ResponseBody> call, Throwable t) {

    }
});
//get请求
call.request();
复制代码

至此,一个简单的使用retrofit网络请求完成。java

推荐阅读 这是一份很详细的 Retrofit 2.0 使用教程(含实例讲解)android

Retrofit 源码理解

知其然知其因此然,一块儿看看原理是怎么实现的。api

Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("这里放基础url")
                .build();
复制代码

初始化分析-Builder()

建立了一个Builder对象,Buidler是Retrofit的静态内部类bash

Builder(Platform platform) {
  this.platform = platform;
}

public Builder() {
  this(Platform.get());
}
复制代码

这步很简单,初始化Builder对象,调用的无参构造,方法内部将 Platform.get() 做为参数又调用了本身的有参构造。markdown

咱们点开 Platform.get() 看看内部都作了什么 `网络

//静态常量
private static final Platform PLATFORM = findPlatform();

//静态方法
static Platform get() {
return PLATFORM;
}

//最终调用这个方法
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) {
}
return new Platform();
}
复制代码

这步就是根据不一样的系统建立一个Platform对象,很显然咱们是Android平台。并发

总结:这一步就是 经过Platform获得了一个Builder对象。ide

初始化分析-baseUrl()

/**
 * Set the API base URL.
 *
 * @see #baseUrl(HttpUrl)
 */
public Builder baseUrl(String baseUrl) {
  //判空
  checkNotNull(baseUrl, "baseUrl == null");
  //将字符串形式的地址 解析为 HttpUrl
  HttpUrl httpUrl = HttpUrl.parse(baseUrl);
  //判空呀
  if (httpUrl == null) {
    throw new IllegalArgumentException("Illegal URL: " + baseUrl);
  }
  return baseUrl(httpUrl);
}

//最终调用
public Builder baseUrl(HttpUrl baseUrl) {
  //判空
  checkNotNull(baseUrl, "baseUrl == null");
  //把地址 以“/”分割,放进集合,为了校验地址
  List<String> pathSegments = baseUrl.pathSegments();
  //校验地址不能以 “/”结尾
  if (!"".equals(pathSegments.get(pathSegments.size() - 1))) {
    throw new IllegalArgumentException("baseUrl must end in /: " + baseUrl);
  }
  this.baseUrl = baseUrl;
  return this;
}
复制代码

这一步就是对设置的baseUrl进行校验,最终输出一个HttpUrl类型的正确地址。oop

初始化分析-build()

public Retrofit build() {
    //判空呀
      if (baseUrl == null) {
        throw new IllegalStateException("Base URL required.");
      }
    //okhttp的工厂实例 用于网络请求
      okhttp3.Call.Factory callFactory = this.callFactory;
      if (callFactory == null) {
        callFactory = new OkHttpClient();
      }

      Executor callbackExecutor = this.callbackExecutor;
      if (callbackExecutor == null) {
        callbackExecutor = platform.defaultCallbackExecutor();
      }

      // Make a defensive copy of the adapters and add the default Call adapter.
      List<CallAdapter.Factory> callAdapterFactories = new ArrayList<>(this.callAdapterFactories);
      callAdapterFactories.add(platform.defaultCallAdapterFactory(callbackExecutor));

      // Make a defensive copy of the converters.
      List<Converter.Factory> converterFactories =
          new ArrayList<>(1 + this.converterFactories.size());

      // Add the built-in converter factory first. This prevents overriding its behavior but also
      // ensures correct behavior when using converters that consume all types.
      converterFactories.add(new BuiltInConverters());
      converterFactories.addAll(this.converterFactories);

      return new Retrofit(callFactory, baseUrl, unmodifiableList(converterFactories),
          unmodifiableList(callAdapterFactories), callbackExecutor, validateEagerly);
    }
复制代码

这个方法,主要就是校对参数,baseUrl不可为空,callFactory就是okhttp的工厂实例,用于网络请求的,其余参数为空则建立,最终携带这些参数建立了一个Retrofit实例。源码分析

总结:以上就是 初始化阶段 的源码分析 ,比较简单,经过链式设置一系列参数,最终返回一个retrofit实例。

关键入口 create() 方法

接下来的部分,整个过程比较长,并且是关键部分,通过几番尝试,发现 流程图+文字分析 这种形式更加清晰。

总结

Retrofit在create方法中采用动态代理模式实现接口方法,这个过程构建了一个ServiceMethod对象,根据方法注解获取请求方式,参数类型和参数注解拼接请求的连接,当一切都准备好以后会把数据添加到Retrofit的RequestBuilder中。而后当咱们主动发起网络请求的时候会调用okhttp发起网络请求,okhttp的配置包括请求方式,URL等在Retrofit的RequestBuilder的build()方法中实现,并发起真正的网络请求。

心得

  • 没必要深究源码细节,不影响大流程的看不懂的直接跳过
  • 多看几遍,每多看一遍会发现其实还没弄懂
  • 参照别人的文章看完,要本身写写或者画画流程图

感谢

这是一份很详细的 Retrofit 2.0 使用教程(含实例讲解)

Retrofit原理解析最简洁的思路

一文学会 Java 动态代理机制

相关文章
相关标签/搜索