retrofit源码中用到的设计模式(二)模版模式

什么是模版设计模式

主要是解决一类问题,什么问题呢?
比如某个功能类的一个功能模块,这个功能模块(我们暂且叫做Func1)抽象来看大体流程是一样的,分1,2,3步,只是其中有细小的差异

那么我们可以这么搞,把这个类定义成抽象类,Func1定义成具体方法,而1,2,3这几步,我们把它定义成抽象方法,这样当前类的子类在实现它的Func1方法时,既遵循了1,2,3的步骤,又在实现1,2,3抽象方法时个性化了它自己要处理的内容

举例子吧,简单地找个网上的例子来,汽车开启(start)到结束(stop)一整个流程(excet)分start->stop两步,但是每个车型的开启和发动的细节是不一样的

先来个抽象的汽车类

public abstract class CarModel {
     /**
      * 汽车启动
      */
     protected abstract void start();
    
     /**
      * 停车
      */
     protected abstract void stop();
     
     /**
      * 用户并不需要关注你的车怎么启动或者停下来的,可以开可以停就可以啦
      */
     final public void excet(){
         this.start();
         this.stop();
     }
}

2.造个大众车,再造个奥迪

public class Wcar extends CarModel{

    @Override
    protected void start() {
        System.out.println("大众车启动 。。。。。。。。突突突");
    }

    @Override
    protected void stop() {
        System.out.println("大众车停车。。。。。。。。。");
    }
}
public class Ocar extends CarModel{

    @Override
    protected void start() {
        System.out.println("奥迪  无匙启动               突突突");
    }

    @Override
    protected void stop() {
        System.out.println("奥迪  停车              ");
    }

}

好了,这下可以试试这两辆车了

public class Client {
    public static void main(String[] args) {
        CarModel wcar=new Wcar();//家里的第一辆车,作为用户的我们并不需要关注车怎么启动的.子类变量变为父类。多态
        wcar.excet();
        
        //突然家里需要第二辆车了   奥迪     我们也不需要关注他怎么生产启动的    
        CarModel ocar=new Ocar();
        ocar.excet();
    }
}

如上代码,大众和奥迪实现了汽车类,这样保证了他们一整个操作流程excet是一样的,然后各自实现了start()和stop()方法

Retrofit中哪里用到了模版模式

在retrofit源码中用到的设计模式(一)代理模式的最后,我们提到了

 // 解析参数注解
  ServiceMethod serviceMethod = loadServiceMethod(method);

这句话开始,要解析注解了
我们想,Retrofit在定义Api类的时候,方法的入参里有很多诸如@Query的注解,解析这些注解肯定大同小异,我们的沃顿大神这时候想到了模版设计模式,我们简化下源码看看
回顾上文代码,我们说Retrofit使用了动态代理,代理了我们定义的网络接口类ApiService,通过Retrofit.create,代码如下

public class Retrofit {
    final String baseUrl;
    final okhttp3.Call.Factory callFactory;
    private Map<Method,ServiceMethod> serviceMethodMapCache = new ConcurrentHashMap<>();

    public Retrofit(Builder builder) {
        this.baseUrl = builder.baseUrl;
        this.callFactory = builder.callFactory;
    }

    public <T> T create(Class<T> service) {
        // 检验,是不是一个接口 ,不能让他继承子接口

        // 重点
        return (T) Proxy.newProxyInstance(service.getClassLoader(), new Class[]{service}, new InvocationHandler() {
            @Override
            public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                // 每执行一个方法都会来这里
                // 判断是不是 Object 的方法 ?
                if(method.getDeclaringClass() == Object.class){
                    return method.invoke(this,args);
                }

                // 解析参数注解
                ServiceMethod serviceMethod = loadServiceMethod(method);
                // 2. 封装 OkHttpCall
                OkHttpCall okHttpCall = new OkHttpCall(serviceMethod,args);

                // 返回代理对象的执行结果,此处是OkHttpCall
                return okHttpCall;
            }
        });
    }

我们看看 loadServiceMethod发生了什么?Retrofit对解析出来的参数做了个缓存,缓存找不到,那么把Method传入去解析注解

 private ServiceMethod loadServiceMethod(Method method) {
    
 ServiceMethod serviceMethod = serviceMethodMapCache.get(method);
        if(serviceMethod == null){
            serviceMethod = new ServiceMethod.Builder(this,method).build();
            serviceMethodMapCache.put(method,serviceMethod);
        }
        return serviceMethod;
    }

接着看看
ServiceMethod.Builder(this,method).build();

 public static class Builder {
        final Retrofit retrofit;
        final Method method;
        final Annotation[] methodAnnotations;
        String httpMethod;
        String relativeUrl;
        Annotation[][] parameterAnnotations;
        final ParameterHandler<?>[] parameterHandlers;

        public Builder(Retrofit retrofit, Method method) {
            this.retrofit = retrofit;
            this.method = method;

            // 方法上面的注解
            methodAnnotations = method.getAnnotations();

            // 二维数组
            // 参数注解
            parameterAnnotations = method.getParameterAnnotations();
            parameterHandlers = new ParameterHandler[parameterAnnotations.length];
        }

         // 解析注解
        public ServiceMethod build() {
            // 解析,OkHttp 请求的时候 ,url = baseUrl + relativeUrl,method
            for (Annotation methodAnnotation : methodAnnotations) {
                // 解析 POST  GET
                parseAnnotationMethod(methodAnnotation);
            }

            // 解析参数注解
            int count = parameterHandlers.length;
            for (int i = 0; i < count; i++) {
                Annotation parameter = parameterAnnotations[i][0];
                // Query 等等
              
                if (parameter instanceof Query) {
                    // 一个一个封装成 ParameterHandler ,不同的参数注解选择不同的策略
                    parameterHandlers[i] = new ParameterHandler.Query<>(((Query) parameter).value());
                }
            }
            return new ServiceMethod(this);
        }

        private void parseAnnotationMethod(Annotation methodAnnotation) {
            // value ,请求方法
            if (methodAnnotation instanceof GET) {
                parseMethodAndPath("GET", ((GET) methodAnnotation).value());
            } else if (methodAnnotation instanceof POST) {
                parseMethodAndPath("POST", ((POST) methodAnnotation).value());
            }
            // 还有一大堆解析 if else
        }

        private void parseMethodAndPath(String method, String value) {
            this.httpMethod = method;
            this.relativeUrl = value;
        }

请关注中间的一段代码:

  // 解析注解
        public ServiceMethod build() {
           ......
            // 解析参数注解
            int count = parameterHandlers.length;
            for (int i = 0; i < count; i++) {
                Annotation parameter = parameterAnnotations[i][0];
                // Query 等等
              
                if (parameter instanceof Query) {
                    // 一个一个封装成 ParameterHandler ,不同的参数注解选择不同的策略
                    parameterHandlers[i] = new ParameterHandler.Query<>(((Query) parameter).value());
                }
            }
......
            return new ServiceMethod(this);
        }

在解析不同注解时,Retrofit定义了不同的注解解释类,但是,注解解释类都有一个共同的接口,ParameterHandler

public interface ParameterHandler<T> {
    public void apply(RequestBuilder requestBuilder,T value);

    // 很多策略,Query ,Part , QueryMap ,Field 等等
    class Query<T> implements ParameterHandler<T>{
        private String key; // 保存 就是参数的 key = userName ,password
        public Query(String key){
            this.key = key;
        }

        @Override
        public void apply(RequestBuilder requestBuilder,T value) {
            // 添加到request中 // value -> String 要经过一个工厂
            requestBuilder.addQueryName(key,value.toString());
        }
    }
    // 还有一些其他

}

即使不看后面的执行时的代码,我们也知道,在发起请求前,Retrofit肯定通过遍历parameterHandlers执行 public void apply(RequestBuilder requestBuilder,T value);方法,拼接了传入的各自注解参数

这个位置就是Retrofit巧妙使用模版解释注解的地方

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念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