Retrofit浅析-2017-04-03

Retrofit的理解

实现了将网络请求转换成了调用一个java方法一样那么简单,在方法的回调里面解析响应。过程利用的java的动态代理,在调用方法之前,分析了注解,组合成了一个请求,使用okhttp调用这个请求,返回数据之后,在通过回调进行业务处理。

问题:

  1. Retrofit初始化都做了些什么?
  2. 是如何将接口拼接成为url的?
  3. 调用okhttp请求是如何进行的?
  4. 如何体现在哪个线程执行请求的?
  5. 数据转换器工厂是如何进行的?
  6. 适配器CallAdapter工厂是干嘛用的?

带着上面几个问题,开始对源码进行阅读。为了了解Retrofit的使用方法,写了一个新闻获取的客户端,地址:https://github.com/lextime2013/News,接口由聚合数据提供,可以看到,实现网络请求只需要3个步骤。

/**
 * 获取新闻消息
 */
@Override
public void getNews() {
    // 1、初始化Retrofit,得到INews动态代理对象
    INews service = NetworkService.getInstance().getRetrofit().create(INews.class);
    // 2、动态代理,生成OkHttpCall
    Call<WebResponse> newsCall = service.getNews(Url.TYPE_TOP, Url.APPKEY);

    Log.i(TAG, "start to send network message");

    // 3、利用OkHttp执行网络请求
    newsCall.enqueue(new Callback<WebResponse>() {
        @Override
        public void onResponse(Call<WebResponse> call, Response<WebResponse> response) {
            if (response == null || response.body() == null || response.body().result == null) return;

                mView.showNews(response.body().result.data);
                Log.i(TAG, "return: " + response.body().toString());
            }

            @Override
            public void onFailure(Call<WebResponse> call, Throwable t) {
                if (t == null) return;

                Log.e(TAG, "failed: " + t.toString());
            }
    });
}

一、初始化Retrofit

全局只需要初始化一个单例,得到INews动态代理对象。首先看一下Retrofit的初始化都做了些什么?

流程图如下

image

Retrofit源码里面大量使用到了Builder模式,大部分实体类都拥有各自的Builder。Retrofit的构造,首先要确定的是所运行的平台Platform,可见Retrofit可用于Java8和Android平台。
几个重要的成员变量:
callFactory,用到了OkHttp的OkHttpClient(),可见Retrofit是使用OkHttp来实现网络请求的。
callbackExecutor,这个会根据不同的平台来初始化不同的Executor,这里只分析Android平台,会生成一个MainThreadExecutor

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

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

看MainThreadExecutor的代码可以发现,这里有一个Handler成员变量,Handler利用的是主线程的Looper,只有一个excute(Runnable r)方法,可以看出,这里的任务是用主线程执行。
converterFactories,这个是网络请求返回的结果的转换类,内部默认的BuiltInConverters,用于转换String类型的ScalarsConverterFactory,用于转换Json数据的GsonConverterFactory。
adapterFactories,RxJava会使用到。

二、动态代理,生成OkHttpCall

Call<WebResponse> newsCall = service.getNews(Url.TYPE_TOP, Url.APPKEY);

在第一步初始化完Retrofit,执行create()的时候,就会生成请求接口的动态代理对象,这个就是Retrofit的精辟之处,如何将java方法转化成为一个网络请求,使用动态代理的方式显得非常巧妙,下面看源码

public <T> T create(final Class<T> service) {
  Utils.validateServiceInterface(service);
  if (validateEagerly) {
    eagerlyValidateMethods(service);
  }
  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, 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);
        }
    });
}

在调用getNews()的时候,会执行该动态代理方法,这里主要是将getNews这个Method封装成了一个ServiceMethod类,这个类在url解析方面做了非常多的工作,这里也会将ServiceMethod缓存起来,下次执行效率更高,最后会传给OkHttpCall返回

流程图如下

image

最后的ServiceMethod会有url、header、body、call、converter等变量,为执行网络请求做好了所有相关的数据准备。

三、利用OkHttp执行网络请求

newsCall.enqueue(new Callback<WebResponse>() {
    @Override
    public void onResponse(Call<WebResponse> call, Response<WebResponse> response) {
        if (response == null || response.body() == null || response.body().result == null) return;

        mView.showNews(response.body().result.data);
        Log.i(TAG, "return: " + response.body().toString());
    }

    @Override
    public void onFailure(Call<WebResponse> call, Throwable t) {
        if (t == null) return;

        Log.e(TAG, "failed: " + t.toString());
    }
});

enqueue()是在异步线程执行,excute()是在当前线程执行,这个相同于okhttp网络请求框架里面的线程执行方式,所以是有一个委托过程

流程图如下

image

OkHttpCall调用enqueue(Callback)/execute()之后,会在里面执行createRawCall()方法,这个方法会调用ServiceMethod里面的toRequest(args),并利用自身的变量组装成RequestBuilder,返回一个okhttp请求的Request。再由okhttp3.Call调用enqueue(Callback)/execute()。执行完毕之后,返回Response,经过ServiceMethod的paseResponse(),使用相应的转换器,转换成为原先泛型定义的实体对象,再做相应的业务处理。

结语

大体粗浅的分析完毕,这里还有很多细节没有做分析,也存在一些误解欢迎指正。开头提出的问题也在文中粗略的讲解,但还未深入理解。Retrofit是一个非常巧妙的设计,插件式的方式自由度非常高,面向接口的开发具有非常高的解耦与扩展,在这里得到充分的体现。不多说,继续read the fucking source code.

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

推荐阅读更多精彩内容