场景
有时我们开发了一个api接口,自己调得好好的,接口文档也写好了,但别人调用时就是有问题,而当我们调试时,发现请求根本没进来或进来了却取不到调用参数,该怎么告知对方调用姿势哪不对呢?
解决方法
对于编码新手,一般会和对方撕扯一会,然后甚至去review对方的代码,这样也许能解决问题,但自己毕竟不熟悉别人系统的实现,耗费时间较长。
另外api调用端可能因为封装方式不同或者加过一些拦截器,导致你看调用端的代码根本看不到什么问题,或者因为调用参数有一些不易分辨或不可见的特殊字符,让你无法察觉到这里有问题。
其实这种问题,我们从网络层出发,对比自己正确调用时的数据包与对方错误调用时的数据包内容,以此来诊断问题所在更加高效,毕竟任何封装或拦截器的处理,最终都会反馈在底层的交互数据上。
这里,我使用springmvc开发一个简单的接口,如下:
@RestController
public class TestController {
@RequestMapping(value = "/test",produces = MimeTypeUtils.TEXT_PLAIN_VALUE)
@ResponseBody
public String test(@RequestParam(name = "name") String name){
return name;
}
}
复制代码
这个接口就是直接将name参数的值返回了,然后我使用curl模拟正确与错误的调用方式,如下:
正确调用方式
$ curl http://localhost:8081/test --data-urlencode 'name=a+b'
a+b
错误调用方式
$ curl http://localhost:8081/test --data 'name=a+b'
a b
复制代码
假设调用方的代码实现的逻辑类似上面错误的调用方式,传递name参数为a+b,得到的却是a b,接下来我们来定位看看,错误的调用方法问题在哪?
使用socat命令
在抓包工具无法使用的情况下,可以尝试socat命令,使用socat命令来中转请求,调用端将请求先发给socat,socat再把请求转给服务端,如下:
使用socat中转请求
$ socat -v TCP4-LISTEN:8080,bind=0.0.0.0,reuseaddr,fork TCP4:localhost:8081
调用端访问socat监听的8080端口
正确调用方式
$ curl http://localhost:8080/test --data-urlencode 'name=a+b'
a+b
错误调用方式
$ curl http://localhost:8080/test --data 'name=a+b'
a b
复制代码
再去看socat,会发现如下结果
其中socat添加-v参数后,会自动将中转的数据流以明文显示出来,其中类似> 2020/10/11 13:05:03.536294 length=162 from=0 to=161之后的部分,就是请求数据,而类似< 2020/10/11 13:05:03.740585 length=116 from=0 to=115之后的部分,就是响应数据,同样的,你可以将两次请求数据复制到文本对比工具中去发现差异。
有时这种调用差异是特殊字符导致的,比如空白字符、零宽字符,上面的方式可能看不出差异,这时你可以将-v参数替换为-x参数,来对比数据的十六进制,同样的wireshark也可以查看数据包的十六进制,相信你摸索一下也可以找到。