RestTemplate源码剖析:Encode

背景

业务方经过某些业务处理之后,带过来了一系列参数。其中,有个url参数供回调使用,但这个url经业务方处理后很特殊,带过来回调时频频出错,无法正常回调给业务方。于是,通过分析部分源码,剖析一下回调的流程。

编码 解码

说到url的回调,很容易联想到decode、encode,即编码解码操作。

通常来说,需要编码操作即意味着不适合直接传输,某些字符可能有歧义,如中文、特殊字符等等。
而通过编码之后(如 utf-8),传输给服务端,服务端自行解码,便不会出现一系列乱码问题。

说明

按照如上所说,业务方带过来了处理后的url,另附上说明,url无需解码,直接回调即可,但事情往往没那么顺利。不管是使用spring5 webclient,还是restTemplate以get请求回调业务方,均会出错。由于最终使用了restTemplate解决了问题,对此本次剖析一下restTemplate。

注:WebClient同样可以解决问题,剖析restTemplate的因由在于综合分析了项目的引用和耦合度,不适合改动webclient模块,故而拓展了restTemplate。

剖析

  1. 先写个极其简单的单测入口,进行RestTemplate的源码分析。


  1. 紧接着集中分析RestTemplate类
  • 请求头、请求体是由RequestCallback来处理的,请求结果是由ResponseExtractor来处理。


  • RestTemplate默认已经初始化添加了许多对象读写转换器。


  1. 进入execute这个重要的方法继续分析。


  1. 可以看出,先用UriTemplateHandler构建URI,再走关键逻辑。
  • UriTemplateHandler build URI


  • 通过构造函数的初始化,可以看到使用的是默认builder工厂



  • 从类继承图可以看出DefaultUriBuilderFactory实现了UriBuilderFactory,继承了UriTemplateHandler


  • expand(String var1, Object... var2)是UriTemplateHandler接口的方法


  1. 继续分析UriTemplateHandler接口expand方法源码



  • 到这里我们可以发现DefaultUriBuilderFactory默认builder工厂存在一个内部类DefaultUriBuilder


  • 接着进入分析一下UriComponentsBuilder类的源码,从类名可以猜想到这个UriComponentsBuilder构建器可能用于创建UriComponents实例


  • 顾名思义,UriComponents包含了构成URI的组件,以及一系列的getter and setter方法


  • 继续着刚才初始化UriComponentsBuilder的方法


  • 符合了内置的url pattern之后继续构建UriComponentsBuilder,通过构造器可以看出默认字符集是utf-8



  • 可以清晰看出初始化之后的构建器


  1. 接下来出来外层的包裹,分析build方法


  • 分析DefaultUriBuilderFactory build的过程
    划重点!!!
    因为uriVariableValues为空,不关心这个expand方法,此时注意build方法。

  • 可以看到,build UriComponents,有个encoded参数,默认为false
    先不透露具体细节,只需先记住构建这次请求的UriComponents,encoded参数为false!!!

  • 接着看encoded参数为false,会影响到哪些参数值
    由encodedfalse可得到UriComponentsBuilder.EncodingHint为NONE

public UriComponents build(boolean encoded) {
      return this.buildInternal(encoded ? UriComponentsBuilder.EncodingHint.FULLY_ENCODED : (this.encodeTemplate ? UriComponentsBuilder.EncodingHint.ENCODE_TEMPLATE : UriComponentsBuilder.EncodingHint.NONE));
}
  • 再接着就是构造HierarchicalUriComponents


HierarchicalUriComponents uric = new HierarchicalUriComponents(this.scheme, this.fragment, this.userInfo, this.host, this.port, this.pathBuilder.build(), this.queryParams, hint == UriComponentsBuilder.EncodingHint.FULLY_ENCODED);
  • 最后可以看到HierarchicalUriComponents.EncodeState为RAW
    这里划重点!!!
  1. 继续看外层的包裹,构建完之后的UriComponents


  • 继续分析createUri,由于匹配到是默认的URI_COMPONENT,则走encode方法


  • 本次剖析很重要的一个方法,终于要接近问题的真相了!!!

  • 从上个提示重要的剖析点得知,构建UriComponents,encoded参数默认为false,进而从源码可得知,HierarchicalUriComponents.EncodeState的值为RAW。那么就会走下面的encodeUriComponent的方法(至于怎么encode暂不在分析范围内,看源码貌似是用字节流操作来encode,有兴趣可以阅读)


  • 接着对segment,queryParams等进行编码


  • 参数编码的细节,勾出来的是Java8的Function,实现就不贴了,源码比较简单


  • 最终,通过比对参数ext_info的值,便得知参数被主动encode了


解决方案

ok~~~
分析完后,知道问题的根源在不该被encode的URL却在restTemplate的深处被动encode了,因此导致了回调的失败。既然明确问题所在,也分析过源码,解决起来就很简单了。如下:

构建UriComponentsBuilder,builder构建时传入encoded值为true,并转URI形式入参,问题解决。


枚举状态总结

为了帮助大家记忆,简单理一下状态。

  1. UriComponentsBuilder.EncodingHint

UriComponentsBuilder构建器有个枚举EncodingHint,UriComponentsBuilder构建时encoded默认为false。

  • 若encoded为false,则看有没有提供另外的encodeTemplate;
    若有则值为ENCODE_TEMPLATE,否则为NONE
  • 若encoded为true时,值为FULLY_ENCODED
  1. HierarchicalUriComponents.EncodeState

HierarchicalUriComponents组件有个枚举EncodeState,其值的影响在于以上的EncodingHint。
源码的encode过滤也在于这个组件的EncodeState值!!!

  • 若EncodingHint为FULLY_ENCODED,则EncodeState为FULLY_ENCODED
  • 若EncodingHint不为FULLY_ENCODED(ENCODE_TEMPLATE或NONE),则EncodeState为RAW

总结

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

推荐阅读更多精彩内容