Retrofit 网络请求之@Body标签遇到的坑

前面两篇文章介绍了Retrofit+RxJava + OkHttp 在实际项目中运用,分为基础篇和封装篇,在实际项目网络请求改造中,也遇到了一些坑,在这里跟大家分享一下。以下正文:

在使用Retrofit 的时候,大家可能会对一个标签特别感兴趣,那就是@Body标签,这个标签非常的方便,当请求参数过多的时候,我们不用写一堆的@Field 标签来传参数,也不用把参数都丢到map中来使用@FieldMap 标签传参。我们只需要定义一个实体,用@Body标签,参数就是我们定义的实体。是不是非常方便?答案是肯定的,但是其中有一些坑需要注意:

错误一:@Body parameters cannot be used with form or multi-part encoding.

如下图:

1.png

错误原因:其实错误信息很明确,就是@Body标签不能同时和@FormUrlEncoded、@Multipart标签同时使用。

可能最开始接触Retrofit的同学有一个理解错误,那就是@Body标签的内部,可能是把每一个属性取出来,以表单的形式传给服务器的(最开始我也是这样认为的,但是一看源码就知道,其实不是这样的),就像使用@Field标签和@FieldMap标签一样,所以在使用@Body标签的时候,会这样写:

@FormUrlEncoded
@POST("/api/getUser")
Observable<String> getUserInfo(@Body User user);

我看到过好几篇介绍Retrofit的文章都是上面这样写的,他们可能根本就没有测试过,像上面示例代码写就会抛上面提到的异常,因此,去掉@FormUrlEncoded 就可以了。

源码跟踪: 我们可以看一下源码里面报这个错误的地方,看一下源码里是怎么判断的,解析标签的源码在ServiceMethod 类里面。抛异常的代码如下:

if (isFormEncoded || isMultipart) {  
            throw parameterError(p,  "@Body parameters cannot be used with form or multi-part encoding.");
}

从源码可以看到,抛异常的地方有两个条件,isFormEncoded为true或者isMultipart为ture,满足其中任何一个条件都会抛出该异常,通过变量名字就可以看出是使用了@ FormUrlEncoded 或者@Multipart 标签,我们还是看一下这两个变量是在哪儿被设置为true的:

...以上代码省略
else if (annotation instanceof FormUrlEncoded) {  
if (isMultipart) {   
 throw methodError("Only one encoding annotation is allowed."); 
 }  
isFormEncoded = true;
}

else if (annotation instanceof Multipart) { 
 if (isFormEncoded) {
    throw methodError("Only one encoding annotation is allowed.");  }  
isMultipart = true;
}

从源码可以看出,在解析道@ FormUrlEncoded 的时候会把isFormEncoded设置为true,在解析到@ Multipart 标签时,把isMultipart设置为 true,所以现在我们就知道了为什么@Body 标签不能同时和@FormUrlEncoded、Multipart标签使用了。

错误二:Unable to create @Body converter for XXXEntry

如下图:


3.png

错误原因:不能创建对应实体的转换器,看到converter这个词是不是有点熟悉?当然熟悉了,前面一片讲Retrofit+RxJava的封装的时候就在Manager里面配置过统一的Coverter,没看过的请移步到 Retrofit + RxJava + OkHttp 让网络请求变的简单-封装篇 , 这个Converter跟我们这儿的错误有什么关系,这就要回到我上面说的那个问题了,@Body 标签是以什么形式上传的参数?答案是上传的@Body 参数实体的Json字符串,所以内部需要一个GsonCoverter来将实体转换成json字符串,也就是封装的时候在Manager里统一配置的addConverterFactory(GsonConverterFactory.create()),那这里为什么会报错?原因是:由于项目的需要,我们对请求参数和请求结果做了一些加密和解密过程,因此 Retrofit默认提供的GsonConverterFactory不能满足我们的需求,于是自己重新写了一个GsonConverterFactory,而看GsonConverterFactory的源码就知道,需要复写两个方法,一个是responseBodyConverter,返回请求结果的转换器,另一个是requestBodyConverter 返回一个请求参数的转换器,项目中我只写了第一个方法,因此其他API的接口都是正确的,用到@Body标签的接口就会报错。连个接口源码如下:

@Override
public Converter<ResponseBody, ?> responseBodyConverter(Type type, Annotation[] annotations,    Retrofit retrofit) {  
TypeAdapter<?> adapter = gson.getAdapter(TypeToken.get(type));  
return new GsonResponseBodyConverter<>(gson, adapter);
}

@Override
public Converter<?, RequestBody> requestBodyConverter(Type type,    Annotation[] parameterAnnotations, Annotation[] methodAnnotations, Retrofit retrofit) { 
 TypeAdapter<?> adapter = gson.getAdapter(TypeToken.get(type));
  return new GsonRequestBodyConverter<>(gson, adapter);
}

我也是被这个错误坑了好久(苦笑脸😂😂),看了源码才发现错误(所以看源码很重要啊!!!),那我们就一起看一下源码,首先抛异常的地方:


try {  
converter = retrofit.requestBodyConverter(type, annotations, methodAnnotations);
} catch (RuntimeException e) { 
 // Wide exception range because factories are user code. 
 throw parameterError(e, p, "Unable to create @Body converter for %s", type);
}

然后会调用到Retrofit的nextRequestBodyConverter中:


int start = converterFactories.indexOf(skipPast) + 1;
for (int i = start, count = converterFactories.size(); i < count; i++) {  
Converter.Factory factory = converterFactories.get(i);  
Converter<?, RequestBody> converter =      factory.requestBodyConverter(type, parameterAnnotations, methodAnnotations, this); 
 if (converter != null) {
    //noinspection unchecked   
 return (Converter<T, RequestBody>) converter; 
 }
}

看到没?上面这段代码就调用factory.requestBodyConverter(type, parameterAnnotations, methodAnnotations, this),而这个factory正是我们通过addConverterFactory(GsonConverterFactory.create())配置到Retrofit 中的Factory。好了,现在我们也通过源码知道了为什么会出现这个错误。最后,我们就看一下使用@Body 标签传递给服务端最中是什么样子的,通过Charles 抓包如下:


2.png

也就是将实体转换成一个JSON 字符串传给服务端

结尾

以上就是我在使用Retrofit过程中遇到的一些问题和解决的一些思路,当我们碰到问题的时候,有时候看源码是最直接最有效的方式。就算是通过百度,Google 找到了答案,也要去看一下源码,看看为什么会报错,知其然,也要知其所以然。

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

推荐阅读更多精彩内容