前言
对于现在大部分前后端项目来说,后端的服务接口在设计时,大多数都会设计一套自定义状态码来对应不同模块的业务错误。基于这个前提,我们在使用springfox时,也需要给接口加入自己的自定义状态码,代码实现上也就是给接口加上@ApiResponses注解让springfox自己实现。但实际操作过程中发现最后的结果却永远多了一个200的状态码,且内容还是“OK”,这就很尴尬,虽然说不影响使用,但看着实在是令人不爽,所以就想着得把它干掉。一开始以为是一个简单的配置一下就行,所以就搜了一下,什么配置不使用默认响应,加注解等方法,操作一把后,结果都没什么鸟用,其他默认状态码可以去掉,这个200还是去不掉。没点可靠的,干脆还是自己撸一撸源码吧。
一、springfox到底是什么时候加入的200?
想要去掉200,那首先我们得知道它是什么时候被加入的。springfox的启动流程我们就以后抽个时间慢慢再做分析,不了解springfox的兄弟可以持续关注。大概就是Spring Plugin实现,通过注册Plugin实现动态插拔,更新springfox的OperationContext对象,我们的200状态码也就在OperationContext对象中,具体如下图所示:
通过以上debug出的属性结果可以知道,200状态码也就是任一OperationBuilderPlugin实现类中apply()方法里的operationContext参数,那么也就意味着是众多实现类中一个或多个加入了200状态码,这里就跳过源码阅读环节,直接跳到结果吧。
有颜色标记的实现类为加入了200状态码,此时我们找到了罪魁祸首。
二、如何去除200
对于如何去除200,最好的方式当然是自己写一个OperationBuilderPlugin实现类,修改responses属性即可。可情况并不是那么顺利,最后结论是springfox源码里定义的属性并不提供直接的外部访问和外部修改。直接上代码说一下解决过程。
首先不可避免的就是自定义实现类,修改responses属性
@Component
public class RemoveOkStatusCodeResponseMessageReaderimplements OperationBuilderPlugin {
@Override
public void apply(OperationContext operationContext) {
// 获取responses,返回结果是个set
operationContext.operationBuilder().build().getResponses