美文网首页
Retrofit浅析-2017-04-03

Retrofit浅析-2017-04-03

作者: 自然like | 来源:发表于2017-07-23 19:00 被阅读42次

    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.

    相关文章

      网友评论

          本文标题:Retrofit浅析-2017-04-03

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