Retrofit源码模拟

本篇文章旨在模拟Retrofit的源码

让我们开始吧
如果要进行网络请求，你可能会这样写一个简单的OKHttp请求

public class CallExector {
    public static final MediaType JSON
            = MediaType.parse("application/json; charset=utf-8");

    private static OkHttpClient client = new OkHttpClient();

    public static String post(String url, String json) throws IOException {
        RequestBody body = RequestBody.create(JSON, json);
        Request request = new Request.Builder()
                .url(url)
                .post(body)
                .build();
        Response response = client.newCall(request).execute();
        return response.body().string();
    }
}

这个代码是最简单的一个网络请求，我们来分析下

  1. client使用默认的okhttpclient对象，我们在调用方法的时候如果想要定制client对象，这里不能写死在里面，看来不能用静态，或许可以使用外界引用
  2. Post方法太抽象，每次调用该方法不能区分究竟是干什么请求，如果能够指定方法名就好了
  3. 传入参数太单一，如果我想任意传入类型，都能有一个转换类来最终转化为string参数，这就省了我好多事
  4. 返回类型也是单一，我是否可以考虑和3一样

鉴于以上种种问题，我们可以考虑在callexector内部附加一些额外参数来满足我们的要求
callexector第一需要一个okhttpclient对象实现定制与网络请求，第二需要一个对象来处理自定义的方法，解析并实现细节，第三需要一个对象来将传入类型转化为请求的数据，第四需要将请求的数据转化为想要的类型
看来至少需要4个变量来实现，这4个变量也不一定必须要，这时我们想到了builder，可以这样写：
New Callexector.builder().setXXX.build();

定制okhttpclient

public class CallExector {
    public static final MediaType JSON
            = MediaType.parse("application/json; charset=utf-8");
    private OkHttpClient client = new OkHttpClient();
    public CallExector(OkHttpClient client) {
        this.client = client;
    }
public static final class Builder {
    private OkHttpClient client;
    public Builder setClient(OkHttpClient client) {
        this.client = client;
        return this;
    }

    public CallExector build(){
        if(this.client == null)
            client = new OkHttpClient();
        return new CallExector(client);
    }
}

    public static String post(String url, String json) throws IOException {
        RequestBody body = RequestBody.create(JSON, json);
        Request request = new Request.Builder()
                .url(url)
                .post(body)
                .build();
        Response response = client.newCall(request).execute();
        return response.body().string();
    }
}

这样就可以定制你的okhttpclient：

CallExector exector = new CallExector.Builder()
        .setClient(new OkHttpClient())
        .build();

外部定制接口方法，Callexector来代理实现自定义接口具体方法

编写你的接口：

public interface MethodDeclear {
    String login(String url, String json);
    String register(String url, String json);
    String logout(String url, String json);
}

使Callexector代理实现该接口的具体请求：

public <T> T create(Class<T> service){
    if(!service.isInterface()) {
        throw new RuntimeException("service must be a interface");
    }
    return (T) Proxy.newProxyInstance(service.getClassLoader(),
            new Class<?>[] { service },methodHandler);
}

Proxy.newProxyInstance前面2个固定值，后面第三个参数是真正需要实现该接口方法的内容，我们可以看如下值：

private InvocationHandler methodHandler = new InvocationHandler() {
    /**
     * 接口方法调用的具体实现
     * @param proxy 代理类
     * @param method 代理方法
     * @param args 方法参数
     * @return 方法的返回类型 string
     * @throws Throwable
     */
    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        if (method.getDeclaringClass() == Object.class) {
            return method.invoke(this, args);
        }
        return execteMethod(method,args);
    }
};

在进行一系列的判断之后，最终进入execteMethod(method,args);方法接口的具体实现，这个方法很有意思，可以得到很多数据

private String execteMethod(Method method, Object[] args)throws IOException {
    //默认参数一为uri
    String uri = (String) args[0];
    //默认参数二为请求参数
    String params = (String) args[1];
    return post(uri,params);
}
String post(String url, String json) throws IOException {
    RequestBody body = RequestBody.create(JSON, json);
    Request request = new Request.Builder()
            .url(url)
            .post(body)
            .build();
    Response response = client.newCall(request).execute();
    return response.body().string();
}

execteMethod只是简单实现，没有做任何判断，我们假设实现一个request请求，用的client是builder定制的client，这样我们已经实现问题1和2的功能了

鉴于以上方法，现在我们发现，定义接口虽然可以自定义接口命名，但是真正在代理实现接口的时候并不关心接口名，只关心其接口的入参和出参，而且固定了参数类型为String类型。下面我们还需要将参数类型转化，自定自定义类型转化，比如修改传入参数，将object对象转化为json字符串，修改传出参数，将responsebody转化为我们想要的类型

类型转化类convert

定义一个转化接口：

public abstract class ParamConverter<I,O> {
    abstract RequestBody convertRequest(I request);
    abstract O convertResponse(ResponseBody response);
}

泛型I代表输入
泛型O代表输出

我们知道，在使用okhttp的时候，request会被构造成RequestBody,response返回会由ResponseBody返回，也就是在使用原先接口post传入参数最终转化为RequestBody,ResponseBody,所以我们使用自定义convert转化，将不管方法传入什么类型的参数，那么我们自由实现入参出参的转化。

由于MethodDeclear 默认使用的方法post(String url, String json)在execteMethod(Method method, Object[] args)方法里面最终是转化为RequestBody,ResponseBody。所以我们可以实现该接口并添加自由类型转化的功能，我们稍微改造一下方法实现，如下：

private Object execteMethod(Method method, Object[] args)throws IOException {
        //默认参数一为uri
        String uri = (String) args[0];
        //默认参数二为请求参数
//        String params = (String) args[1];
//        RequestBody body = RequestBody.create(JSON, params);
        RequestBody body = paramConverter.convertRequest(args[1]);
        return post(uri,body);
    }
    Object post(String uri,RequestBody body) throws IOException {
        Request request = new Request.Builder()
                .url(uri)
                .post(body)
                .build();
        ResponseBody response = client.newCall(request).execute().body();
        return paramConverter.convertResponse(response);
    }

那么针对以上方法的适配，要将传入类型转化该怎么实现呢？如下：

public class DefaultConvert extends ParamConverter<String,String>{
    public static final MediaType JSON
            = MediaType.parse("application/json; charset=utf-8");
    @Override
    RequestBody convertRequest(String request) {
        RequestBody body = RequestBody.create(JSON, request);
        return body;
    }
    @Override
    String convertResponse(ResponseBody response) {
        return response.string();
}

这样是不是就能将任何传入参数使用ParamConverter转化为requestBody，将responseBody转化为任何想要的结果类型！Square真是喜欢泛型转化，不管RXJAVA还是Retrofit都有泛型转化

到这里你以为结束了吗？NO，NO，NO，下面才是重点
我们看以上代码，这样自己定义接口动态代理实现的方式也真是挺高端了，但是与retrofit功能相比还有一个地方不同，我们在定义接口的时候直接返回结果了，这样我们假如想要得到call对象然后必要时候想取消网络怎么办，一想到这里我就害怕，万一Boss提出这样的要求我没法实现是不是要被杀了祭天？
嘿嘿 ~ 不存在的。我们还需要对此进行改造哦~
上代码，我们现在修改的接口

public interface MethodDeclear {
    CallImpler<String> post(String url, String json);
}

CallImpler返回类是一个Call的包装类，里面泛型参数是请求返回类型，这里需要之前的转换类convert进行转化
CallImpler类只是重复了call接口的方法，修改enqueue方法回掉，添加回掉参数的转化，这样做一个包装，保证接口灵活性

public class CallImpler<T>{
    private Call call;
    private ParamConverter<Object,T> paramConverter;
    public CallImpler(Call call, ParamConverter<Object, T> paramConverter) {
        this.call = call;
        this.paramConverter = paramConverter;
    }
    Request request(){
        return call.request();
    }
    Response execute() throws IOException{
        return call.execute();
    }
    void cancel(){
        call.cancel();
    }
    boolean isExecuted(){
        return call.isExecuted();
    }
    boolean isCanceled(){
        return call.isCanceled();
    }

    public void enqueue(final CallBack<T> responseCallback){
        call.enqueue(new okhttp3.Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                responseCallback.onFailure(CallImpler.this,e);
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                responseCallback.onResponse(CallImpler.this,paramConverter.convertResponse(response.body()));
            }
        });
    }
}

paramConverter用来转化responseBody，前面讲过可以定制的哦~

既然我们定义的接口返回参数修改了，那么具体方法的实现体也需要修改了。看之前的方法execteMethod：

  1. 转化入参
  2. 同步网络请求
  3. 转化出参

这个方法把call对象都写隐藏了，我们需要提取call对象，并且跳过2，让2主动调用，13预先设定好
那么这样修改：

private Object execteMethod(Method method, Object[] args)throws IOException {
        //默认参数一为uri
        String uri = (String) args[0];
        //默认参数二为请求参数
//        String params = (String) args[1];
//        RequestBody body = RequestBody.create(JSON, params);
        RequestBody body = paramConverter.convertRequest(args[1]);
        return post(uri,body);
    }
    Object post(String uri,RequestBody body) throws IOException {
        Request request = new Request.Builder()
                .url(uri)
                .post(body)
                .build();
        return new CallImpler(client.newCall(request),paramConverter);//paramConverter.convertResponse(response);
    }

execteMethod方法post返回call的包装类CallImpler
这样修改，我们就可以得到call对象了，实现call的请求，查询，取消等等操作~

到这里应该差不多了吧，但是比起Retrofit还是差一些，哪里呢，Retrofit的返回类型包装类（我们这里是CallImpler）也是可以转化的哦，那么又是泛型转化！其实我都转晕了，光看不行，直接秀操作：

  1. 我需要把CallImpler转化为自定义类，那么写一个类，他的传入类型为CallImpler类型，出去类型要是泛型，为止类型，自由转化，自由实现：
public abstract class CallAdapter<T,R> {
    abstract T adapt(CallImpler<R> call);
}

这样应该可以吧？我们把他加入CallExector类，这样实现返回类型call的包装与定制化~
上builder代码

public static final class Builder {
    private OkHttpClient client;
    private ParamConverter paramConverter;
    private CallAdapter callAdapter;
    public Builder setClient(OkHttpClient client) {
        this.client = client;
        return this;
    }

    public Builder setParamConverter(ParamConverter paramConverter) {
        this.paramConverter = paramConverter;
        return this;
    }

    public Builder setCallAdapter(CallAdapter callAdapter) {
        this.callAdapter = callAdapter;
        return this;
    }

    public CallExector build(){
        if(this.client == null)
            client = new OkHttpClient();
        if(this.paramConverter == null)
            paramConverter = new DefaultConvert();
        if(this.callAdapter == null)
            this.callAdapter = new DefaultCallAdapter();
        return new CallExector(client,paramConverter,callAdapter);
    }
}

默认的calladapter传入CallImpler<T>我们默认直接返回，不做操作啦，要转化的请在adapt方法中将CallImpler<T>转化为自定义类吧，任你怎么玩，就是别玩坏了~

下面我们来总结一下用法啦：

CallExector exector = new CallExector.Builder()
        .setClient(new OkHttpClient())
        .setParamConverter(new DefaultConvert())
        .setCallAdapter(new DefaultCallAdapter())
        .build();
MethodDeclear interf = exector.create(MethodDeclear.class);
CallImpler<String> caller = interf.post("url","args");
caller.enqueue(new CallBack<String>() {
    @Override
    public void onResponse(CallImpler<String> call, String response) {
    }

    @Override
    public void onFailure(CallImpler<String> call, Throwable t) {
    }
});

怎样，是不是和Retrofit一模一样~
学习上面的内容，你必须要学到2点内容

1.代理反射，即自定义一个接口，由Proxy代理实现方法[Proxy.newProxyInstance(ClassLoader loader,Class<?>[] interfaces,InvocationHandler h)]
2.泛型自由转化，由一个类型转化为另一个类型

如果掌握这2点，以上基本完全理解了吧~
这也对得起你看了这么久嘛。别说你的手指正落在滚轮上！
Ps: 想看kotlin文件转化请使用AS 3.0，对文件使用ctrl+alt+shift+K~

主要类：

  • CallExector builder模式 -> 同Retrofit类
  • okhttpClient -> okhttp3.Call.Factory callFactory;
  • ParamConvert -> List<Converter.Factory> converterFactories;
  • CallAdapter<T,R> -> Retrofit.List<CallAdapter.Factory> adapterFactories
  • CallImpler<T> -> Retrofit.Call<T>
  • CallBack<T> -> Retrofit.CallBack<T>

MethodDeclear:自定义接口通用

Source源代码

这就是Retrofit的具体简单实现，当然了，有人估计会问那么多注解annotation去哪里了，这个嘛，其实annotation人家也是定义好了，然后再代理方法里面区分判断的，就像我们也是不依赖接口方法名一样，但是咱们可是定死了参数个数，他用注解就可以避免这些问题，除了annotation，以上便是实现原理和模拟，下面附上Retrofit的annotation解析的位置

retrofit2.ServiceMethod<R, T>.parseMethodAnnotation:
private void parseMethodAnnotation(Annotation annotation) {
      if (annotation instanceof DELETE) {
        parseHttpMethodAndPath("DELETE", ((DELETE) annotation).value(), false);
      } else if (annotation instanceof GET) {
        parseHttpMethodAndPath("GET", ((GET) annotation).value(), false);
      } else if (annotation instanceof HEAD) {
        parseHttpMethodAndPath("HEAD", ((HEAD) annotation).value(), false);
        if (!Void.class.equals(responseType)) {
          throw methodError("HEAD method must use Void as response type.");
        }
      } else if (annotation instanceof PATCH) {
        parseHttpMethodAndPath("PATCH", ((PATCH) annotation).value(), true);
      } else if (annotation instanceof POST) {
        parseHttpMethodAndPath("POST", ((POST) annotation).value(), true);
      } else if (annotation instanceof PUT) {
        parseHttpMethodAndPath("PUT", ((PUT) annotation).value(), true);
      } else if (annotation instanceof OPTIONS) {
        parseHttpMethodAndPath("OPTIONS", ((OPTIONS) annotation).value(), false);
      } else if (annotation instanceof HTTP) {
        HTTP http = (HTTP) annotation;
        parseHttpMethodAndPath(http.method(), http.path(), http.hasBody());
      } else if (annotation instanceof retrofit2.http.Headers) {
        String[] headersToParse = ((retrofit2.http.Headers) annotation).value();
        if (headersToParse.length == 0) {
          throw methodError("@Headers annotation is empty.");
        }
        headers = parseHeaders(headersToParse);
      } else if (annotation instanceof Multipart) {
        if (isFormEncoded) {
          throw methodError("Only one encoding annotation is allowed.");
        }
        isMultipart = true;
      } else if (annotation instanceof FormUrlEncoded) {
        if (isMultipart) {
          throw methodError("Only one encoding annotation is allowed.");
        }
        isFormEncoded = true;
      }
}

其实这部分我们也可以实现，请自行移步其他大神java注解篇~
嘿嘿！
Thankyou~

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

推荐阅读更多精彩内容

  • Android - 收藏集
    Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,295评论 25赞 707
  • Retrofit解析6之面向接口编程
    整体Retrofit内容如下： 1、Retrofit解析1之前哨站——理解RESTful 2、Retrofit解析...
    隔壁老李头阅读 3,114评论 5赞 14
  • 深入retrofit 2.0 源码分析
    安卓开发领域中，很多重要的问题都有很好的开源解决方案，例如Square公司提供网络请求 OkHttp , Retr...
    aaron688阅读 1,897评论 1赞 20
  • 风雨中
    高三时模拟考试不力所写的一首歌以自勉。唱过给蛋包听，他觉得不好听。我倒跟他想法不一样。单看这歌词，用粤语所写： 风...
    罗少先阅读 272评论 0赞 0
  • 五月，你好
    怎么说呢，5月的第一天，我依旧在电脑前绞尽脑汁。一直以来想做一件轰轰烈烈的事，可世界太大，我很渺小，知足于现在的平...
    刘强在路上阅读 322评论 0赞 2