Retrofit设计简析与探讨

前言

前段时间风风火火的流行起来这个基于OkHttp的RESTFUL Api请求工具,大家都说这个设计好nb的说,恩,实现上的思路确实很精巧。然后呢,如何精巧?怎么使用动态代理?怎么简洁?怎么拥有良好的拓展性?,另外,阅读本文前,建议先将参考的两篇文章先看下。

动态代理

ok,分析文章需要先来说明原理,show you the code:

  public<T> T getProxy(Class<T> clazz){
        return (T) Proxy.newProxyInstance(clazz.getClassLoader(), clazz.getInterfaces(), new InvocationHandler() {
            @Override
            public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                //porxy 被代理的对象
                //method 被代理的对象的方法
                //args 传进来的参数变量
                //这里可以获取到方法 ,获取其上的运行时注解,根据注解以及参数来拼接生成请求的对象
                return null;
            }
        });
    }

上面便是一个很简单的java代理的实现,看到了没clazz.getInterfaces(),哈哈,java的动态代理基于接口,所以这也是retrofit 里面只是定义了接口的原因!当然,说到了java的动态代理,当然要全面的看问题,需要了解好处以及不足,根据不同的需求采取不同的方案:

使用Java动态代理机制的好处:
  1、减少编程的工作量:假如需要实现多种代理处理逻辑,只要写多个代理处理器就可以了,无需每种方式都写一个代理类。
  2、系统扩展性和维护性增强,程序修改起来也方便多了(一般只要改代理处理器类就行了)。
使用Java动态代理机制的限制:
  目前根据GOF的代理模式,代理类和委托类需要都实现同一个接口。也就是说只有实现了某个接口的类可以使用Java动态代理机制。但是,事实上使用中并不是遇到的所有类都会给你实现一个接口。因此,对于没有实现接口的类,目前无法使用该机制。

动态代理,本质是代理了某个对象内方法的实现
我们会发现,这种方式的代理,必须要有一个接口,并且实现上是通过反射机制,局限性和效率都是问题,这样就引出了动态代理的另一种实现:CGLib
CGlib 没有接口的限制,并且底层是采用ASM字节码生成框架,使用字节码技术生成代理类,比反射效率高。

所以,我们能不能使用这套机制来实现动态代理呢?这里留给你们思考。

解构

  1. CallAdapter
    顾名思义,应该是一个请求适配器,何谓请求适配器呢?
    我们先来看下它是怎么被用到的吧:
 ```java
      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 serviceMethod = loadServiceMethod(method);
        //可以发现这里是和okhttp耦合的,其实改下这里的实现,也可以使用其他的网络请求库
        OkHttpCall okHttpCall = new OkHttpCall<>(serviceMethod, args);
        //这里,这里,将okHttpCall 通过adapt 转换为了另外一个类型的对象。这个对象就是你的方法的返回值
        return serviceMethod.callAdapter.adapt(okHttpCall); 
      }
 ```
  所以,其实请求适配器的作用就是将一个网络请求的封装对象(callAdapter),转化为另外一个类型,满足定制化的需求。整个流程理一下:

在创建网络请求时,我们一般会传入一个适配器,以 rxjava模式举例如下:

 public static WordSegmentService getWordSegmentService(){
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(BASE_URL)
                .client(mOkHttpClient)
                .addCallAdapterFactory(RxJavaCallAdapterFactory.create())//添加了一个请求适配器
                .addConverterFactory(GsonConverterFactory.create())
                .build();
        return retrofit.create(WordSegmentService.class);
    }

然后这个适配器对象会在动态代理时,最后一步被使用:

            //这里,这里,将okHttpCall 通过adapt 转换为了另外一个类型的对象。这个对象就是你的方法的返回值。
            //里面其实逻辑没有多么复杂,重点关注 Retrofit 和 ServiceMethod 这两个类
            return serviceMethod.callAdapter.adapt(okHttpCall); 

至此,我们来理一理整个动态代理的流程,接口--->具体方法--->获取方法参数和变量进行包装--->生成新的对象--->调用新的方法--->调用并返回 被代理的方法 的 返回值
哈哈,最后一个步骤有点绕,但是想必大家知道最后一步应该是重点吧。如何确保返回值是类型兼容的呢?这里便有了addCallAdapterFactory,so我们便可以将轻松的将okhttpcall对象转化为Observable对象啦。
我们可以看到,这里其实除了rxjava模式,只要实现对应的接口,其他自定义的模式也是可以实现的,只有想不到,没有做不到。

  1. Converter
    顾名思义,转换器,什么的转换器呢?来,看源码:
没错,这里是一张图片,我太懒了

可以看到,转换器的作用是允许我们自己定义入参和返回的类型,我们需要重点关注下ResponseBody和RequestBody,而这些都是okhttp中的抽象类,确实是耦合的。
具体哪里使用到了呢?,可以参考MethodService,里面无处不在,毕竟这里是和网络请求参数相关的,肯定要放在生成网络请求参数 的类中,有兴趣的小伙伴可以看下。


        Class<?> rawParameterType = Utils.getRawType(type);
        if (Iterable.class.isAssignableFrom(rawParameterType)) {
          if (!(type instanceof ParameterizedType)) {
            throw parameterError(p, rawParameterType.getSimpleName()
                + " must include generic type (e.g., "
                + rawParameterType.getSimpleName()
                + "<String>)");
          }
          ParameterizedType parameterizedType = (ParameterizedType) type;
          Type iterableType = Utils.getParameterUpperBound(0, parameterizedType);
          Converter<?, String> converter =
              retrofit.stringConverter(iterableType, annotations);
          return new ParameterHandler.Field<>(name, converter, encoded).iterable();
        } else if (rawParameterType.isArray()) {
          Class<?> arrayComponentType = boxIfPrimitive(rawParameterType.getComponentType());
          Converter<?, String> converter =
              retrofit.stringConverter(arrayComponentType, annotations);
          return new ParameterHandler.Field<>(name, converter, encoded).array();
        } else {
          Converter<?, String> converter =
              retrofit.stringConverter(type, annotations);
          return new ParameterHandler.Field<>(name, converter, encoded);
        }

然后呢,我们再来理一下逻辑,Retrofit-->addConverterFactory-->MethodService-->getConverter-->处理请求或者返回参数。这里,对外只提供Retrofit,你是不会了解到MethodService的存在的。好的设计便是这样,对外提供尽可能少的接口,保证接口的稳定性,而内部如何实现均可。

  1. 注解
    ok,先上图为敬:
retrofit中使用到的注解

点进去可以看出他们都是运行时注解,说到运行时注解,肯定不能忘记反射,没错,确实是用到了反射,而我们知道,android开发中是不提倡用反射的,原因则是因为效率问题。
辣么有没有什么更优解呢?
能想到的有 编译时注解,即在编译的时候通过apt生成相应的代码,这样就解决了反射的问题,但是呢?很麻烦,需要手动写生成类,另外扩展性也是问题,如果没有比较良好的设计的话,相信最后的代码会惨不忍睹。但是,如果能够完善,想必也会相当的优雅,这里就留给小伙伴们自行发挥了。

总结

其实,对于普通的网络请求,我们也可以普通的实现,但是作为一个有追求的人,都会希望自己写的简洁,易扩展,解耦合,能够经得起时间的考验,编码犹如艺术,希望能够写出这样的代码,前提便是更多的去阅读这类优秀的代码,毕竟只有站在巨人的肩膀上才能看的更远。

参考

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

推荐阅读更多精彩内容