从注解动态代理理解Retrofit对OkHttp的封装,手写实现

仅实现Retrofit中的注解和动态代理

大概流程:
1.通过动态代理实例化接口
2.每调用一个方法都会调用到动态代理里面的 InvocationHandler,所以通过这个方法可以解析方法上面的注解及值,参数注解及值。
3.创建一个HashMap键是Method 值是ServiceMehtod(保存注解信息的类) 来保存在内存中,再次访问就可以省去解析时间

直接上实现代码

    Api api;
    CustomRetrofit retrofit;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_test);
        //自定义的用法
        retrofit = new CustomRetrofit.Builder().baseUrl(url).build();
        api = retrofit.create(Api.class);
        //Retrofit 的用法
        Retrofit retrofit1 = new Retrofit.Builder().baseUrl(url).build();
        Api api1 = retrofit1.create(Api.class);
    }

    public void post(View view) {
        Call call = api.postWeather(city,key);
        call.enqueue(new Callback() {
            @Override
            public void onFailure(@NotNull Call call, @NotNull IOException e) {
                Log.e(TAG, "post onFailure: "+e.getMessage() );
            }

            @Override
            public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException {
                if (response.isSuccessful()){
                    Log.e(TAG, "post onResponse: "+response.body().string() );
                }
            }
        });
    }



    public void get(View view) {
        Call call = api.getWeather(city,key);
        call.enqueue(new Callback() {
            @Override
            public void onFailure(@NotNull Call call, @NotNull IOException e) {
                Log.e(TAG, "get onFailure: "+e.getMessage() );
            }

            @Override
            public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException {
                if (response.isSuccessful()){
                    Log.e(TAG, "get onResponse: "+response.body().string() );
                }
            }
        });
    }

现在看下自定义类CustomRetrofit中的实现

package com.test.retrofit;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.util.HashMap;
import okhttp3.Call;
import okhttp3.HttpUrl;
import okhttp3.OkHttpClient;
public class CustomRetrofit {
    protected HttpUrl baseUrl;
    protected Call.Factory callFactory;
    private HashMap<Method,ServiceMethod> serviceMethodCache = new HashMap<>();
    private CustomRetrofit(HttpUrl baseUrl,Call.Factory callFactory){
        this.baseUrl = baseUrl;
        this.callFactory = callFactory;
    }
    //使用动态代理,把接口生成一个class,然后实例化赋值给泛型接口T(简单来讲就是给接口实例化了) 
    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 {
                // args是方法的参数
                //解析这个method 上所有的注解信息
                ServiceMethod serviceMethod = loadServiceMethod(method);
                return serviceMethod.invoke(args);
            }
        });
    }
  
    private ServiceMethod loadServiceMethod(Method method) {
        //如果内存中有直接取内存中了,不用重复分析注解信息 
        ServiceMethod serviceMethod = serviceMethodCache.get(method);
        if(serviceMethod != null)
            return serviceMethod;
        //加锁,防止同步重复创建值 类似单例双重锁机制
        synchronized (serviceMethodCache){
            serviceMethod = serviceMethodCache.get(method);
            if(serviceMethod == null){
                serviceMethod = new ServiceMethod.Builder(this,method).build();
                //添加进内存中
                serviceMethodCache.put(method,serviceMethod);
            }
        }
        return serviceMethod;
    }
    public static class Builder{
        private HttpUrl baseUrl;
        private Call.Factory callFactory;// = new OkHttpClient();

        public Builder(){
        }

        public Builder baseUrl(String url){
            baseUrl = HttpUrl.get(url);
            return this;
        }

        public Builder client(Call.Factory factory ){
            this.callFactory = factory;
            return this;
        }

        public CustomRetrofit build(){
            if (baseUrl == null)
                throw new RuntimeException("URL不能为空");
            if(callFactory == null)
                callFactory = new OkHttpClient();
            return new CustomRetrofit(baseUrl,callFactory);
        }
    }
}

再看下ServiceMethod.java类

package com.test.retrofit;
import com.example.retrofit.annotation.Field;
import com.example.retrofit.annotation.GET;
import com.example.retrofit.annotation.POST;
import com.example.retrofit.annotation.Query;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import okhttp3.Call;
import okhttp3.FormBody;
import okhttp3.HttpUrl;
import okhttp3.Request;

/**
 * 记录请求方法的成员 请求方式 值等信息
 */
public class ServiceMethod {
    //POST请求,要添加的请求体
    private FormBody.Builder formBuilder;
    //GET请求直接拼接在url里面
    private HttpUrl.Builder urlBuilder;
    //请求服务端得请求类型 POST GET
    private String serviceMethodRequestType;
    //Retrofit传过来的http信息
    private HttpUrl baseUrl;
    //注解上面的接口字符串
    private String relativeUrl;
    //是否有请求体/POST才有
    private boolean hasBody;
    //参数变量的值
    private ParameterHandler[] parameterHandlers;

    private Call.Factory callFactory;

    private ServiceMethod(Builder builder){
        this.baseUrl = builder.retrofit.baseUrl;
        this.callFactory = builder.retrofit.callFactory;
        this.relativeUrl = builder.relativeUrl;
        this.parameterHandlers = builder.parameterHandlers;
        this.serviceMethodRequestType = builder.serviceMethodRequestType;
        this.hasBody = builder.hasBody;
        if (hasBody){
            formBuilder = new FormBody.Builder();
        }
    }

    public Object invoke(Object[] args) {
        //往body里面赋值
        for (int i = 0; i < parameterHandlers.length; i++) {
            parameterHandlers[i].apply(this,args[i].toString());
        }

        HttpUrl url;
        if (urlBuilder == null){
            urlBuilder = baseUrl.newBuilder(relativeUrl);
        }
        url = urlBuilder.build();

        //如果有请求体的话,添加请求体
        FormBody formBody = null;
        if(formBuilder != null){
            formBody = formBuilder.build();
        }
        //创建请求
        Request request = new Request.Builder()
                .url(url)
                .method(serviceMethodRequestType,formBody)
                .build();
        //返回Call
        return callFactory.newCall(request);
    }

    //GET请求 拼接URL
    protected void addQueryData(String key,String value){
        if (urlBuilder == null){
            urlBuilder = baseUrl.newBuilder(relativeUrl);
        }
        urlBuilder.addQueryParameter(key,value);
    }
    //POST请求 添加请求体
    protected void addFieldData(String key,String value){
        formBuilder.add(key,value);
    }

    public static class Builder{
        //CustomRetrofit对象
        private CustomRetrofit retrofit;
        //请求服务端得请求类型 POST GET
        private String serviceMethodRequestType;
        //获取方法上的注解
        private Annotation[] methodAnnotations = new Annotation[]{};
        //获取方法成员的注解
        private Annotation[][] parameterAnnotations = new Annotation[][]{};
        //是否有请求体
        private boolean hasBody;
        //注解上面的url
        private String relativeUrl;
        //成员变量的值
        private ParameterHandler[] parameterHandlers;

        public Builder(CustomRetrofit retrofit, Method method){
            this.retrofit = retrofit;
            //获取方法上面的注解
            this.methodAnnotations =  method.getDeclaredAnnotations();
            //获取方法参数上的注解 可能一个参数可能有多个注解,所以是二元数组
            this.parameterAnnotations = method.getParameterAnnotations();
        }

        public ServiceMethod build(){
            //获取请求类型
            for (Annotation methodAnnotation : methodAnnotations) {
                //判断方法上的注解是上面类型这里只举例两种
                if(methodAnnotation instanceof POST){
                    this.hasBody = true;
                    //获取注解的值 也就是POST("api/getData")中的 api/getData
                    this.relativeUrl = ((POST) methodAnnotation).value();
                    this.serviceMethodRequestType = "POST";
                }

                if(methodAnnotation instanceof GET){
                    this.hasBody = false;
                    //获取注解的值 也就是GET("api/getData")中的 api/getData
                    this.relativeUrl = ((GET) methodAnnotation).value();
                    this.serviceMethodRequestType = "GET";
                }
            }

            int length = parameterAnnotations.length;
            //保存参数的类
            parameterHandlers = new ParameterHandler[length];
            for (int i = 0; i < length; i++) {
                Annotation[] annotations = parameterAnnotations[i];
                for (Annotation annotation : annotations) {
                    //POST请求
                    if (annotation instanceof Field){
                        String key = ((Field) annotation).value();
                        parameterHandlers[i] = new ParameterHandler.FieldParameterHandler(key);
                    }

                    //GET请求
                    if(annotation instanceof Query){
                        String key = ((Query) annotation).value();
                        parameterHandlers[i] = new ParameterHandler.QueryParameterHandler(key);
                    }
                }
            }
            return new ServiceMethod(this);
        }
    }
}

剩下的就是保存参数的ParameterHandler

package com.test.retrofit;

public abstract class ParameterHandler {

    public abstract void apply(ServiceMethod serviceMethod,String value);

    public static class QueryParameterHandler extends ParameterHandler{

        private String key;
        public QueryParameterHandler(String key){
            this.key = key;
        }

        @Override
        public void apply(ServiceMethod serviceMethod, String value) {
            serviceMethod.addQueryData(key,value);
        }
    }

    public static class FieldParameterHandler extends ParameterHandler{
        private String key;

        public FieldParameterHandler(String key) {
            this.key = key;
        }

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