Retrofit 进阶:Converter 的原理及使用【附 Retrofit 流程】

    现在大多数的网络请求框架都是使用 Retrofit,本篇文章根据 Retrofit 中,Flowable 创建 和 OkhttpCall 执行,来说明 Convert 的使用。本篇文章根据 Body 如何进行 convert 的介绍,如果有需要对Path,Header 等 进行 convert 操作,可以根据 ParameterHandler 和 RequestBuilder 等源码,进行更改。

目录:

一、什么是 Converter?

二、什么时候进行 convert?(包含:Flowable 创建;ParameterHandler 介绍;OkHttpCall 执行)

三、为什么使用 Converter ?

四、与拦截器有什么区别?

五、怎么使用 Converter?

六、那些年踩过的坑

一、什么是 Converter?

Converter 是将对象与它们在 HTTP 中的表示进行转换,实例是在 Factory 中被创建的。

Converter.Factory 是一个抽象类,其中有三个方法,用于创建 Converter

public Converter<ResponseBody, ?> responseBodyConverter(Type type, Annotation[] annotations, Retrofit retrofit) {

    return null;

}

public Converter<?, RequestBody> requestBodyConverter(Type type, Annotation[] parameterAnnotations, Annotation[] methodAnnotations, Retrofit retrofit) {

    return null;

}

public Converter<?, String> stringConverter(Type type, Annotation[] annotations, Retrofit retrofit) {

    return null;

}

二、什么时候进行 convert?

Retrofit 的请求流程

    1)Flowable 创建时序图

图1 Flowable 创建时序图

说明:

1、每次进行网络请求操作,调用自定义 HTTP API 的方法时,实际上调用的是 HttpServiceMethod 的 invoke 方法。

2、ServiceMethod 中 parseAnnotations 是对方法进行解析。

3、RequestFactory 的 parseMethodAnnotation 是方法的注解进行解析。

4、RequestFactory 的 parseParameter 是对每一个参数进行解析,并且返回一个ParameterHandler

    2)ParameterHandler 是什么?

        RequestFactory parseParameter 方法中遍历每一个参数,并调用 parseParameterAnnotation 方法,对该参数的所有注解进行遍历,根据 Retrofit 规定的参数注解:例如 @Path@Body@Field 等,返回一个 ParameterHandler



问题1. stringConverter 和 requestBodyConverter 有什么区别?

        parseParameterAnnotation 方法里,根据不同的参数注解,调用 Retrofit 的 requestBodyConverter 和 stringConverter 方法。其中只有@Body和 @Part@PartMap 使用的 requestBodyConverter


问题2. 添加了多个 Converter.Factory 将如何执行?

        以 Retrofit 的 stringConverter 方法为例。遍历 converterFactories 根据参数类型,参数注解数组,返回第一个不为空的 Converter

public <T> Converter<T, String> stringConverter(Type type, Annotation[] annotations) {

    checkNotNull(type, "type == null");

    checkNotNull(annotations, "annotations == null");

    for (int i = 0, count = converterFactories.size(); i < count; i++) {

        Converter<?, String> converter = converterFactories.get(i).stringConverter(type, annotations, this);

        if (converter != null) { //noinspection unchecked

            return (Converter<T, String>) converter;

        }

    }

}

    因此,使用哪个 Converter 是根据添加 Converter.Factory 的顺序查找,第一个匹配对应处理的 Converter


        抽象类 ParameterHandler 有一个抽象方法 apply。在子类实现中调用了 converter.convert(value)。 

abstract class ParameterHandler<T> {

    abstract void apply(RequestBuilder builder, @Nullable T value) throws IOException;

}

实现 ParameterHandler 的子类:

图2 ParameterHandler子类

    3)OkHttpCall 执行时序图

图3 OkHttpCall 时序图

说明:

1、RequestFactory 的 create方法,通过 RequestBuilder 返回了一个 Request

2、RealCall 的 getResponseWithInterceptorChain 是 HTTP 请求,拦截器链条,因此这里也是拦截器的处理。

3、OkHttpCall 的 parseResponse 方法中,执行了 responseConverter.convert(catchingBody);

    4)Request 的创建

RequestFactory 的 create 方法:

okhttp3.Request create(Object[] args) throws IOException {

    @SuppressWarnings("unchecked") // It is an error to invoke a method with the wrong arg types.

    ParameterHandler<Object>[] handlers = (ParameterHandler<Object>[]) parameterHandlers;

    int argumentCount = args.length;

    if (argumentCount != handlers.length) {

        throw new IllegalArgumentException("Argument count (" + argumentCount+ ") doesn't match expected count (" + handlers.length + ")");

    }

    RequestBuilder requestBuilder = new RequestBuilder(httpMethod, baseUrl, relativeUrl, headers, contentType, hasBody, isFormEncoded, isMultipart);

    List<Object> argumentList = new ArrayList<>(argumentCount);

    for (int p = 0; p < argumentCount; p++) {

        argumentList.add(args[p]);

        handlers[p].apply(requestBuilder, args[p]);

    }

    return requestBuilder.get().tag(Invocation.class, new Invocation(method, argumentList)).build();

}

1、创建 RequestBuilder 对象。

2、遍历参数,对每个参数调用对应的 ParameterHandler 的 apply 方法,会调用对应的 Converter 的 convert 方法。

3、调用 RequestBuilder 的 get 方法,对参数进行组装。

4、创建 Request 对象。

RequestBuilder 的 get 方法:

Request.Builder get() {

//...

    RequestBody body = this.body;

    if (body == null) {

        // Try to pull from one of the builders.

        if (formBuilder != null) {

            body = formBuilder.build();

        } else if (multipartBuilder != null) {

            body = multipartBuilder.build();

        } else if (hasBody) {

            // Body is absent, make an empty body.

            body = RequestBody.create(null, new byte[0]);

        }

    }

    //...

}


图4 body赋值 对应注解

三、为什么使用 Converter ?

        Converter 是将对象与它们在 HTTP 中的表示进行转换,并且是在线程中处理的。对于调用对象来讲,只需要关注传递的参数,以及返回的对象。参数如何组装,转换成 HTTP 请求的参数,加密解密,并不需要关注。

四、与拦截器有什么区别?

图5 客户端到服务器的请求流程

拦截器是对 OkHttpClient 与服务器之间的 HTTP 请求进行拦截,处理。

Converter 是 Retrofit 对于请求的对象和返回的 Body 等进行转换。

五、怎么使用 Converter?

1)三个方法说明:

override fun stringConverter(type: Type, annotations: Array<Annotation>, retrofit: Retrofit): Converter<*, String>?

说明:stringConverter 方法

参数: 

    type:参数的类型,通过 getRawType(type) 方法得到声明类型的 Class

    annotations:参数的注解数组

返回:

    Converter<*, String>:返回 null 则 Retrofit 继续读取下一个 Factory

override fun requestBodyConverter(type: Type, parameterAnnotations: Array<Annotation>, methodAnnotations: Array<Annotation>, retrofit: Retrofit): Converter<*, RequestBody>?

说明:requestBodyConverter 方法

参数: 

    type:参数的类型,通过 getRawType(type) 方法得到声明类型的 Class

    parameterAnnotations:参数的注解数组

    methodAnnotations:方法的注解数组

返回:

    Converter<*, RequestBody>:返回 null 则 Retrofit 继续读取下一个 Factory

override fun responseBodyConverter(type: Type, annotations: Array<Annotation>, retrofit: Retrofit): Converter<ResponseBody, *>?

说明:responseBodyConverter 方法

参数: 

    type:返回值类型,通过 getRawType(type) 方法得到声明类型的 Class

    annotations:方法的注解数组

返回:

    Converter<ResponseBody, *>:返回 null 则 Retrofit 继续读取下一个 Factory

2)自定义步骤:

1、创建 Converter.Factory ,重写三个获取 Converter 的方法。

2、新建需要处理的注解。

3、对于参数的类型,参数的注解数组,返回一个 Converter 处理。

4、添加到 Retrofit.Builder 中,addConverterFactory ,注意添加顺序会影响获取的 Converter

六、那些年踩过的坑

1、ParameterHandler 的 apply 方法对于 value 值的判断,例如:Field,当 value 为空时直接 return,不会处理 stringConverter

2、Part 中的 Header 是写死的,如果需要传递文件名,需要额外处理。

Headers headers = Headers.of("Content-Disposition", "form-data; name=\"" + partName + "\"", "Content-Transfer-Encoding", part.encoding());

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

推荐阅读更多精彩内容