retrofit2 源码分析(未完 待更新)

process

1 use(0.01)

  1. 新建接口APIService,定义方法、新增注解;
  2. 建造者模式新建retrofit实例;
  3. Retrofit.create(APIService.class)返回APIService对象实例;
  4. APIService.getData() 返回Call
  5. call.execute或者call.enqueue(callback)使用

2 Retrofit.class(40)

  • 2.1 Retrofit.create(APIService.class)方法


public <T> T create(final Class<T> service) {
    Utils.validateServiceInterface(service);
    if (validateEagerly) {
      eagerlyValidateMethods(service);
    }
    // @{注解1  dynamic proxy }
    return (T) Proxy.newProxyInstance(service.getClassLoader(), new Class<?>[] { service },
        new InvocationHandler() {
          private final Platform platform = Platform.get();
          private final Object[] emptyArgs = new Object[0];

          @Override public Object invoke(Object proxy, Method method, @Nullable Object[] args)
              throws Throwable {
            if (method.getDeclaringClass() == Object.class) {
              return method.invoke(this, args);
            }
            if (platform.isDefaultMethod(method)) {
              return platform.invokeDefaultMethod(method, service, proxy, args);
            }
            {@ 注解2  **实际调用httpServiceMethod.invoke 方法** }
            return loadServiceMethod(method).invoke(args != null ? args : emptyArgs);
          }
        });
  }

  • 2.2 Proxy调用 开闭原则

  • 2.3 封装OKHttp请求过程 迪米特法则

2.3.1 ServiceMethod 接口隔离
ServiceMethod<?> loadServiceMethod(Method method) {
    // {@1} ConCurrentHAshMap 缓存ServiceMethod (原因请查看{@HttpServiceMethod.parseAnnotation 注解})
    ServiceMethod<?> result = serviceMethodCache.get(method);
    if (result != null) return result;

    synchronized (serviceMethodCache) {
      result = serviceMethodCache.get(method);
      if (result == null) {
      
        //{@2   解析注解 生成httpServiceMethod实例 以及requestFactory实例 }
        
        result = ServiceMethod.parseAnnotations(this, method);
        serviceMethodCache.put(method, result);
      }
    }
    return result;
  }

生成httpServiceMethod以及requestFactory过程


abstract class ServiceMethod<T> {
  static <T> ServiceMethod<T> parseAnnotations(Retrofit retrofit, Method method) {
    {@1  通过解析注解生成request}
    RequestFactory requestFactory = RequestFactory.parseAnnotations(retrofit, method);

    Type returnType = method.getGenericReturnType();
    if (Utils.hasUnresolvableType(returnType)) {
      throw methodError(method,
          "Method return type must not include a type variable or wildcard: %s", returnType);
    }
    if (returnType == void.class) {
      throw methodError(method, "Service methods cannot return void.");
    }
    {@2  @link HttpServiceMethod {作用:将接口方法的调用调整为HTTP调用} 请求过程  }
    return HttpServiceMethod.parseAnnotations(retrofit, method, requestFactory);
  }
  
  @{Retrofit#create方法 中实际调用的方法(HttpServiceMethod#invoke方法)}
  @Override ReturnT invoke(Object[] args) {
   
    解释1:callAdapter 是在Retrofit.builder().build()中 注入的 ExecutorCallAdapterFactory 的get方法中拿到的

    
    {2.3.1 注解3 }HttpServiceMethod#invoke 方法返回OKHttpCall对象
    
    return callAdapter.adapt(
        new OkHttpCall<>(requestFactory, args, callFactory, responseConverter));
  }

2.3.2 httpServiceMethod#invoke 中的callAdapter来自哪呢?

结论:实际是在

Retrofit#loadServiceMethod --> 

ServiceMethod#parseAnnotations--> 

HttpServiceMethod#parseAnnotations-->

createCallAdapter()-->

retrofit#callAdapter-->

retrofit#nextCallAdapter(这个方法遍历了retrofi实例的callAdapterFactories,返回第一个不为空的callAdapter)

==最终其实回到了Retrofit的建造者的build方法中==


public Retrofit build() {
     ------
      List<CallAdapter.Factory> callAdapterFactories = new ArrayList<>(this.callAdapterFactories);
      
      callAdapterFactories.addAll(
      @{  2.3.2 注解1  默认的callAdapterFactory}
      platform.defaultCallAdapterFactories(callbackExecutor));
      
     -------
    }

{ @link 对 2.3.2 注解1的解释 }

List<? extends CallAdapter.Factory> defaultCallAdapterFactories(
      @Nullable Executor callbackExecutor) {
    if (callbackExecutor != null) {
    @{  2.3.2 注解2  回调不 为空 }
      return singletonList(new ExecutorCallAdapterFactory(callbackExecutor));
    }
    @{  2.3.2 注解3  回调为空}
    return singletonList(DefaultCallAdapterFactory.INSTANCE);
  }

@{link ==2.3.2 注解2的解释==  ExecutorCallAdapterFactory#get }

@Override public @Nullable CallAdapter<?, ?> get(Type returnType,Annotation[] annotations, Retrofit retrofit) {
   // {@ 2.3.2 注解4  这个是 httpMethodService#invoke方法中的实际callAdapter  }
    return new CallAdapter<Object, Call<?>>() {
      @Override public Type responseType() {
        return responseType;
      }

      @Override public Call<Object> adapt(Call<Object> call) {
      
        1、这个call是 httpMethodService#invoke(2.3.1 注解3)中传入的OkHttpCall 
        2、callbackExecutor实例是 在retrofit.builder()#build中注入的
        Android 平台默认使用MainThreadExecutor 切换到主线程
        
        return new ExecutorCallbackCall<>(callbackExecutor, call);
      }
    };
  }

// 最终调用过程

  ExecutorCallbackCall(Executor callbackExecutor, Call<T> delegate) {
      this.callbackExecutor = callbackExecutor;
      this.delegate = delegate;
    }

    @Override public void enqueue(final Callback<T> callback) {
      checkNotNull(callback, "callback == null");
         
         1、这个delegate是 
         httpMethodService#invoke(2.3.1 注解3)中传入的OkHttpCall对象 
         
         2、okhttpcall.enqueue 方法下面有解析
         
      delegate.enqueue(new Callback<T>() {
        @Override public void onResponse(Call<T> call, final Response<T> response) {
        
        // Android平台默认使用MainThreadExecutor 切换到主线程
        
          callbackExecutor.execute(new Runnable() {
            @Override public void run() {
              if (delegate.isCanceled()) {
                
                1、执行retrofit回调
                
                callback.onFailure(ExecutorCallbackCall.this, new IOException("Canceled"));
              } else {
                callback.onResponse(ExecutorCallbackCall.this, response);
              }
            }
          });
        }

        @Override public void onFailure(Call<T> call, final Throwable t) {
        
        // Android 平台默认使用MainThreadExecutor 切换到主线程
        
          callbackExecutor.execute(new Runnable() {
            @Override public void run() {
              callback.onFailure(ExecutorCallbackCall.this, t);
            }
          });
        }
      });
    }

2.3.3 通过注解生成RequestBodyFactory继而生成request的过程
    1. 一个serviceMethod对应咱们定义的网络请求接口中的一个方法,比如栗子中的serviceApi()这个方法
    1. 二维数组:parameterAnnotationsArray[p][index]存所有annotation以及value 一个method N个参数parameter,一参数p对应多个annotation。
{@2.3.3 注解1  RequestFactory.Builder#build();}

RequestFactory build() {

      
      for (Annotation annotation : methodAnnotations) {
        //  解析方法名 相对路径 headers 以及path参数名
        parseMethodAnnotation(annotation);
      }

      // 方法中参数的数量
      
      int parameterCount = parameterAnnotationsArray.
      
      // ParameterHandler 用于处理方法中的参数
      
      parameterHandlers = new ParameterHandler<?>[parameterCount];
      for (int p = 0; p < parameterCount; p++) {
        
        {@ 2.3.3 注解2 解析参数   }
        
        parameterHandlers[p] = parseParameter(p, parameterTypes[p], parameterAnnotationsArray[p]);
      }   
}
      
{ 对 2.3.3 注解2的 解释   }
private ParameterHandler<?> parseParameter(
        int p, Type parameterType,@第一处 Annotation[] annotations) {
      ParameterHandler<?> result = null;
      if (annotations != null) {
        for (Annotation annotation : annotations) {
          @第二处 从单个注解中解析多个参数注解
          ParameterHandler<?> annotationAction =
              parseParameterAnnotation(p, parameterType, annotations, annotation);
              
          if (annotationAction == null) {
            continue;
          }
          result = annotationAction;
        }
      }
      return result;
    }

处理Method 中parameter 的annotation的逻辑,放入handler中

parseParameterAnnotation方法.png
2.3.4 HttpServiceMethod exatnd ServiceMethod(生成 HttpServiceMethod 的过程)
HttpServiceMethod.parseAnnotation(retrofit, method, requestFactory) 方法解析

static <ResponseT, ReturnT> HttpServiceMethod<ResponseT, ReturnT> parseAnnotations(
  Retrofit retrofit, Method method, RequestFactory requestFactory) {
CallAdapter<ResponseT, ReturnT> callAdapter = createCallAdapter(retrofit, method);
Type responseType = callAdapter.responseType();
Converter<ResponseBody, ResponseT> responseConverter =
    createResponseConverter(retrofit, method, responseType);

callFactory  这个注意一下 !!

okhttp3.Call.Factory callFactory = retrofit.callFactory;
return new HttpServiceMethod<>(requestFactory, callFactory, callAdapter, responseConverter); }

可以看到最终调用HttpServiceMethod的构造方法,callFactory 在OkHttp中会提到,至此retrofit的流程就结束了,紧接着就是okhttp的调用过程。

3. okHttp 调用过程(40 doing)

4. Retrofit 拓展(20)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,734评论 6 505
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,931评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,133评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,532评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,585评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,462评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,262评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,153评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,587评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,792评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,919评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,635评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,237评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,855评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,983评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,048评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,864评论 2 354

推荐阅读更多精彩内容

  • 本文将顺着构建请求对象->构建请求接口->发起同步/异步请求的流程,分析Retrofit是如何实现的。 开始之前,...
    zhuhf阅读 1,619评论 0 10
  • 目录介绍 1.首先回顾Retrofit简单使用方法 2.Retrofit的创建流程源码分析2.1 Retrofit...
    杨充211阅读 1,058评论 0 16
  • 将一个Java接口翻译成一个Http请求,然后用OkHttp去发送这个请求 一 入口类 Retrofit 成员变...
    菜鸟汤先生阅读 498评论 0 0
  • 昨天晚上9点我们看了中央1台的《加油丨向未来》。我们娘仨一边看一边评论着,知识的重要性,外孙女还时不时抢答一下...
    苏筱瑜姥姥阅读 148评论 0 0