retrofit源码解析

what is retrofit

A type-safe HTTP client for Android and Java
适用于java8 和android平台。使用okio进行网络请求。

how to use retrofit

//first define an interface discribe the url and param
public interface GitHubService {
  @GET("users/{user}/repos")
  Call<List<Repo>> listRepos(@Path("user") String user);
}

public class RetrofitSample {
    public void testRetrofit() {
         //定义要访问的url路径
         Retrofit retrofit = new Retrofit.Builder()
            .baseUrl("https://api.github.com/")
            .addConverterFactory(GsonConverterFactory.create())//使用不同的json解析器, retrofit只对body进行处理。
            .build();

         GitHubService service = retrofit.create(GitHubService.class);
         
         Call<List<Repo>> repos = service.listRepos("octocat");
         // 请求数据,并且处理response 
        repos.enqueue(new Callback<List<Repo>>() { 
            @Override 
            public void onResponse(Response<List<Repo>> author) {
                 Log.d()
            } 
            @Override 
            public void onFailure(Throwable t) {
         } });
         //the code above will request url: https://api.github.com/users/octocat/repos
        // 返回的值封装成为List<Repo>形式的数值。
    }
}

更多用法参考:你真的会用retrofit 这里面有更详细的使用介绍。

how does it work

首先,针对retrofit初始化的代码:

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://api.github.com")
    .addConverterFactory(GsonConverterFactory.create())
    .build();

new Retrofit.Build() 会调用Build(Platform.get())方法,根据是否有"android.os.Build" 来判断是否是android平台, 如果是android平台, 则创建一个主线程执行器, 这里我们可以知道,retrofit需要将任务(例如请求数据完毕,将数据返回到主线程)抛到主线程执行,直接调用MainThreadExcutor.excute(new Runnable(){})就可以了
事实上如果希望使用rxjava或者其他的类型,这里可以通过addAdapterFacotry()添加rxjava的adapter
同时还会添加一个默认的adapter, 对于android,默认的adapter就是ExecutorCallAdapterFactory,

static class MainThreadExecutor implements Executor {
      private final Handler handler = new Handler(Looper.getMainLooper());

      @Override public void execute(Runnable r) {
        handler.post(r);
      }
    }

除了这些信息,其他的信息通过Builder模式设置即可, 在调用Builder.build()的时候会判断使用哪种客户端(默认Okhttpclient), 哪种线程执行器(android 默认就是上面的MainThreadExecutor执行器), body转换器(没有设置内容转换器 则使用内建转换器), 然后生成了一个Retrofit代码。

对于GitHubService service = retrofit.create(GitHubService.class);
进入到create()内部查看,可以看到其主要实现是通过jdk的动态代理对最开始的GithubApiService做拦截处理。

return (T) Proxy.newProxyInstance(service.getClassLoader(), new Class<?>[] { service },
        new InvocationHandler() {
          private final Platform platform = Platform.get();

          @Override public Object invoke(Object proxy, Method method, @Nullable Object[] args)
              throws Throwable {
            // If the method is a method from Object then defer to normal invocation.
            if (method.getDeclaringClass() == Object.class) {
              return method.invoke(this, args);
            }
            if (platform.isDefaultMethod(method)) {
              return platform.invokeDefaultMethod(method, service, proxy, args);
            }
            ServiceMethod<Object, Object> serviceMethod =
                (ServiceMethod<Object, Object>) loadServiceMethod(method);
            OkHttpCall<Object> okHttpCall = new OkHttpCall<>(serviceMethod, args);
            return serviceMethod.callAdapter.adapt(okHttpCall);
          }
        });

在invoke方法内部, 主要是拦截GithubApiService已经注解的方法, 解析方法对应的参数,结合传递进来的参数,调用loadservicemethod生成一个serviceMethod实例,该实例保存了要发送请求的所有信息,并将serviceMethod以及参数一起传给OkHttpCall 生成一个实例,并包装成一个ExecutorCallAdaptFacoty(android)的实例。
ServiceMethod.Builder.build()方法先

通过serviceMethod.toRequest 可以将一个servicemethod转换成okhttp所需要的Request(),

最后再看调用Call<T>.enque时,发生了什么事情

repos.enqueue(new Callback<List<Repo>>() { 
            @Override 
            public void onResponse(Response<List<Repo>> author) {
                 Log.d()
            } 
            @Override 
            public void onFailure(Throwable t) {
         } });

这里的repos实际是ExecutorCallAdaptFacoty的实例,查看里面的enque方法,实际调用的是OkHttpCall()的enque方法,并监听回调。而OkHttpCall()的方法实际最后调用的是okhttp3.Call的enque和execute()方法。

public Converter<ResponseBody, ?> responseBodyConverter(Type type, Annotation[] annotations,
      Retrofit retrofit) {
    if (type == ResponseBody.class) {
      return Utils.isAnnotationPresent(annotations, Streaming.class)
          ? StreamingResponseBodyConverter.INSTANCE
          : BufferingResponseBodyConverter.INSTANCE;
    }
    if (type == Void.class) {
      return VoidResponseBodyConverter.INSTANCE;
    }
    return null;
  }

在okhttp处理完成后, 在将okhttp返回的数据进行处理时,会调用serviceMethod的toRsponse方法, 而responseconvert 的生成又是根据最开始设置retrofit的值来判断的,默认的类型有 StreamingResponseBodyConverter和BufferingResponseConverter, 实际是根据不同的返回值以及注解类型来做特别处理的。

总结

Retrofit实际是对okhttp的一层封装,通过注解的方式描述了一个http请求需要的信息,简化了okhttp的使用,对于返回数据的解析,使用了默认的Converter, 用户也可以使用其他的converter,例如gson convert等,也可以定义自己的converter。
Retrofit的代码主要是设计模式很牛逼,这里贴一张简书用户stay的模式图:

Retrofit 里面涉及到的设计模式

refs:
Retrofit2

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

推荐阅读更多精彩内容

  • 如果你还没了解Retrofit如何使用,可以先查看这篇文章:Retrofit使用指南 一般分析源码都习惯从使用开始...
    一只小鸡仔阅读 720评论 1 4
  • 目录 Retrofit 简介 Retrofit 的具体使用 重点分析 Retrofit 简介 Retrofit 是...
    大豆油阅读 321评论 0 0
  • 一、什么是Retrofit A type-safe HTTP client for Android and Jav...
    andcoder阅读 742评论 2 3
  • 博文出处:Retrofit源码解析,欢迎大家关注我的博客,谢谢! Header 之前对 OkHttp 进行过源码分...
    俞其荣阅读 605评论 0 6
  • 能教的就是知识和方法,不能教的就是那种可能性,那种未来感、直觉力,还有刚才讲的思想。思想也是不能教的,你不可能代替...
    木卯丁阅读 134评论 0 1