Retrofit 的扩展 (Kotlin)

Retrofit 是 square 公司出品的开源的 http 请求框架。

其面向接口和注解的编程方式,使我们的http请求变的更加简单,我们只需要创建一个Api接口类,写上服务器的接口方法即可,而无需关心其实现方式,例如:

public interface ApiService {
    @POST("login")
    @FormUrlEncoded
    Call<BaseResponseResult<User>> login(@Field("Phone") String phone, @Field("Password") String password);
}

然后直接在业务类中调用:

@Test
public void testRetrofit() {
    Retrofit retrofit = new Retrofit.Builder()
        .addConverterFactory(GsonConverterFactory.create())
        .baseUrl("http://api.xxx.com/api/")  // api 的域名前缀
        .build();
    ApiService apiService = retrofit.create(ApiService.class);
    try {
        String result = apiService.login("13000000000", "123456").execute().body().toString();
        System.out.println(result);
    } catch (IOException pE) {
            pE.printStackTrace();
    }
 }

Note:为了避免项目中的多次创建Retrofit,可以配合dagger2实现单例注入。

其虽然提供了简便的编程方式,但接口的标准比较固定:

baseUrl + apiUrl 的方式

而我们服务器端提供的接口可能并不一定按照这种方式定义,比如:

需求1:服务器端要配合app的需求调整其返回的数据的格式及业务逻辑,为保证兼容以前的 app 的业务需要,我们可能要告诉服务器某个接口的版本,所以我们可能需要传入接口的版本信息。

方案1:最简单实现是直接在接口上加上版本信息:

@POST("200800\login")
@FormUrlEncoded
Call<BaseResponseResult<User>> login(@Field("Phone") String phone, @Field("Password") String password);

但这样的话,如果要更改好多接口的版本可能要改的信息比较多,也不符合设计的原则。

由于Retrofit本身的实现基于注解,所以我们可以扩展注解的方式实现,也符合其设计标准。

方案2:

// kotlin 代码
// 可以注解接口类,修改所有的接口的版本;亦可以修改接口的方法修改某个接口的版本。
@Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION)
@Retention(AnnotationRetention.RUNTIME)
annotation class ApiVersion(val value: Int = 0 /* 0-Ignore */)

// 注解到接口方法
@ApiVersion(2008000)
@POST("login")
@FormUrlEncoded
Call<BaseResponseResult<User>> login(@Field("Phone") String phone, @Field("Password") String password);

需求2:
服务器提供的接口都使用了几个共同的参数,可能每个接口可能都需要传接口的 SC/SV 等参数做接口验证,或者传入手机系统的信息、硬件信息、app的Flavor信息。
给每个接口注解几个固定的参数,基于注解的实现:

// form 表单的 POST 方式
@Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION)
@Retention(AnnotationRetention.RUNTIME)
annotation class FixedField(val keys: Array<String>, val values: Array<String>)

// get 方式
@Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION)
@Retention(AnnotationRetention.RUNTIME)
annotation class FixedQuery(val keys: Array<String>, val values: Array<String>)

// 注解到接口方法
@POST("phone_login")
@FixedField(keys = {"SC", "SV"}, values = {"xxx", "yyy"})
@FormUrlEncoded
Call<BaseResponseResult<User>> login(@Field("Phone") String phone, @Field("Password") String password); 

有时我们可能希望把一个类转换到成 FieldMap 或者 QueryMap 的键值对的方式提交到服务器,可以使用:

@Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION)
@Retention(AnnotationRetention.RUNTIME)
annotation class DynamicClassQuery(val value: Array<KClass<out IDynamicQueryClass>>)

// 比如要所有接口上都注入手机的版本,系统信息,由于参数太多,我就准备了一个类,实现自动转换。
@DynamicClassQuery(Header.class)
public interface ApiService {
   ...
}
// 创建一个统一的接口
interface IDynamicQueryClass {
    fun toQuery(): Map<String, String?>
}
// 实现类,用于存放手机的版本,系统信息
class Header : IDynamicQueryClass  {
    ...
    override fun toQuery(): Map<String, String?> {
        val map: HashMap<String, String?> = HashMap()
        val fields = Header::class.java.declaredFields;
        fields.map {
            map.put(it.name, it.get(this)?.toString());
        }
        return map;
    }
}

加了这么多自定义注解,需要修改 Retrofit 的注解处理代码,已处理我们的自定义注解。 现附上扩展 Retrofit 的代码:

// Retrofit
ServiceMethod<Object, Object> serviceMethod = (ServiceMethod<Object, Object>) loadServiceMethod(method);
// 加入扩展的参数
args = serviceMethod.rebuildArgs(args);
// ServiceMethod
final class ServiceMethod<R, T> {
    // 扩展的注解
    Map<String, String> fixedFields;
    Map<String, String> fixedQueries;
    ...
    ServiceMethod(Builder<R, T> builder) {
        ...
        // 扩展的注解
        this.fixedFields = builder.fixedFields;
        this.fixedQueries = builder.fixedQueries;
    }
    ...
    // 扩展我们需要的参数
    public Object[] rebuildArgs(Object[] args) {
        List<Object> argList = new ArrayList<>(Arrays.asList(args));
        if (!this.fixedFields.isEmpty()) {
            for (Map.Entry<String, String> entry : fixedFields.entrySet()) {
                argList.add(entry.getValue());
            }
        }
        if (!this.fixedQueries.isEmpty()) {
            for (Map.Entry<String, String> entry : fixedQueries.entrySet()) {
                argList.add(entry.getValue());
            }
        }
        return argList.toArray();
    }
    ...
    static final class Builder<T, R> {
        ...
        // 扩展的注解
        Map<String, String> fixedFields;
        Map<String, String> fixedQueries;
        ...
        Builder(Retrofit retrofit, Method method) {
            ...
            // 初始化扩展的注解
            this.fixedFields = new HashMap<>();
            this.fixedQueries = new HashMap<>();
        }
        ...
        // 解析接口的注解,这里包含父类的注解,使用时请注意
        Annotation[] classAnnotations = method.getDeclaringClass().getAnnotations();
        for (Annotation annotation : classAnnotations) {
            // 这个是解析我们扩展的注解的方法
            parseExtendAnnotation(annotation);
        }

        for (Annotation annotation : methodAnnotations) {
            parseMethodAnnotation(annotation);
        }
        ...
        // 加上自定义扩展注解的数量
        parameterHandlers = new ParameterHandler<?>[parameterCount + fixedFields.size() + fixedQueries.size()];
        ...
       // 处理自定义注解参数
       int p = parameterCount;
       Converter<?, String> converter = BuiltInConverters.ToStringConverter.INSTANCE;
       for (Map.Entry<String, String> entry : fixedFields.entrySet()) {
           parameterHandlers[p++] = new ParameterHandler.Field(entry.getKey(), converter, false);
       }
       for (Map.Entry<String, String> entry : fixedQueries.entrySet()) {
           parameterHandlers[p++] = new ParameterHandler.Query<>(entry.getKey(), converter, false);
       }
    }
    // 转换自定义的注解
    private void parseExtendAnnotation(Annotation annotation) {
        if (annotation instanceof FixedField) {
        FixedField fixedField = (FixedField) annotation;
             String[] keys = fixedField.keys();
             String[] values = fixedField.values();
            if (keys.length != values.length) {
                throw methodError("FixedField keys count (" + keys.length + ") doesn't match values count (" + values.length + ")");
            }
            for (int i = 0; i < keys.length; i++) {
               if (keys[i] == null || keys[i].length() == 0) continue;
                 fixedFields.put(keys[i], values[i]);
               }
                isFormEncoded = true;
            } else if (annotation instanceof FixedQuery) {
                FixedQuery fixedQuery = (FixedQuery) annotation;
                String[] keys = fixedQuery.keys();
                String[] values = fixedQuery.values();
                if (keys.length != values.length) {
                    throw methodError("FixedQuery keys count (" + keys.length + ") doesn't match values count (" + values.length + ")");
                }
                for (int i = 0; i < keys.length; i++) {
                    if (keys[i] == null || keys[i].length() == 0) continue;
                    fixedQueries.put(keys[i], values[i]);
                }
                gotQuery = true;
            } else if (annotation instanceof ApiVersion) {
                ApiVersion version = (ApiVersion) annotation;
                this.apiVersion = version.value();
                if (relativeUrl != null) {
                    relativeUrl = apiVersion + "/" + relativeUrl;
                }
            } else if (annotation instanceof SC) {
                fixedFields.put("SC", ((SC) annotation).value());
            } else if (annotation instanceof SV) {
                fixedFields.put("SV", ((SV) annotation).value());
            } else if (annotation instanceof DynamicClassQuery) {
                Class<? extends IDynamicQueryClass>[] clsArray = ((DynamicClassQuery) annotation).value();
                for (Class<? extends IDynamicQueryClass> cls : clsArray) {
                    try {
                        fixedQueries.putAll(cls.newInstance().toQuery());
                    } catch (Exception e) {
                        e.printStackTrace();
                    }
              }
        }
    }    
}

思路参考:http://www.println.net/post/Android-Hack-Retrofit

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

推荐阅读更多精彩内容