rest-assured发送multipart post时的中文乱码剖析

问题现象

rest-assured是一个基于java语言的REST API测试框架,使用简单易上手,目前在github上已经有6.5K stars。日前在使用rest-assured发送multipart/form-data类型的请求时,服务端报参数错误。

问题影响

经过对发送端参数的检查,都是正确的。除了multipart/form-data, POST的其他请求也都正常,按理说不应该出现这样的情况。所以按照如下过程进行排查,也进一步了解了Multipart/form-data和rest-assured的特性。

问题分析过程

问题直接原因定位

分析服务端代码,查看日志。发现已经收到了请求,并且参数@QueryParam已经正确收到,报错发生在对参数content的解析上。

再看了一遍日志打印的收到的请求参数,发现里面出现了?号,类似{"test??":1}。很有可能是中文乱码这个老朋友。为了验证这个猜想,将请求中的中文全部替换为英文,再次发送请求,服务端响应成功。

由于不可能一直不发送中文,问题需要彻底解决。首先了解一下Multipart/form-data内容的格式

Multipart/form-data的简单了解

HTTP协议簇中的媒体类型multipart/form-data,数据体支持多个部分组成,并且每个部分之间用boundary进行分隔,boundary分隔符在请求头中指定

# 请求头 - 指定Content-Type和边界值
Content-Type: multipart/form-data; boundary=${Boundary}

# 请求体
--${Boundary}
Content-Disposition: form-data; name="property name"
Content-Type: application/json

json内容
--${Boundary}
Content-Disposition: form-data; name="name of pdf"; filename="pdf-file.pdf"
Content-Type: application/octet-stream

文件内容,bytes
--${Boundary}

问题发生之处

为了找到中文乱码在什么地方出现,采取一下步骤

  • 是否在组装时已经乱码。通过打印请求头来验证,发现IDE中打印出来的字符是正常的

    given().log().all()
    

    是否发送的是乱码。使用抓包神器Fiddler来分析报文。由于Fiddler本质是一个代理,从IDE发送的报文不会直接被抓到,还好rest-assured提供了代理模式,按照以下代码设置

    given().proxy("127.0.0.1", 8888)
    

    果然,抓到的报文里,中文显示成了乱码

如何设置charset

在rest-assured的官网(官网文档MultiPartConfig - rest-assured 4.0.0 javadoc)上介绍,multipart/form-data默认的编码格式是US-ASCII。首先直接设置.contentType("multipart/form-data;charset=UTF-8"),结果:不生效

后来刨到陈年老坑,有人提问multi-part不支持针对每个Content-Disposition的设置,项目的开发人员记录并回复增加了MultiPartConfig来支持对multi-parts配置需求,于是增加了一下代码。由于multipart的模式默认是HttpMultipartMode.STRICT,因此代码里需要将httpMultipartMode指定为一个其他的值。结果:content-dispositon中的header生效,但是中文内容仍然是乱码。

.httpClient(HttpClientConfig.httpClientConfig().httpMultipartMode(BROWSER_COMPATIBLE))
                    .multiPartConfig(multiPartConfig().defaultCharset("UTF-8")))

再次阅读文档,里面提到:Specify a default charset to use for multi-parts (default is US-ASCII). This affects the encoding of the multipart body (such as the control name) but not the actual content (such as the a JSON or String document).

说明这个配置只能设置control name的编码格式,不能设置真正发送的内容。从这个方向上继续排查,stack overflow上有人提供了一个解决方法,也就是用MultiPartSpecBuilder来构造发送的内容。结果:成功

.multiPart(new MultiPartSpecBuilder("{\"key\":\"测试test\"}").controlName("params").charset(StandardCharsets.UTF_8).build())

如何解决问题

最终发送请求的代码,调整如下

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

推荐阅读更多精彩内容