栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

SpringBoot实现ResponseBodyAdvice接口,导致访问swagger异常

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

SpringBoot实现ResponseBodyAdvice接口,导致访问swagger异常

文章目录

1.问题分析2.解决方案

2.1 方案一2.2 方案二2.3. 方案三2.4 其他

1.问题分析

实现ResponseBodyAdvice接口,同时使用RestController,统一后端返回给前端的数据的格式。

@RestControllerAdvice(annotations = RestResponse.class)
public class ResponseAdvice implements ResponseBodyAdvice {

    @Autowired
    private ObjectMapper objectMapper;

    
    @Override
    public boolean supports(MethodParameter returnType, Class> converterType) {
        return true;
    }

    @SneakyThrows
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType,
                                  Class> selectedConverterType,
                                  ServerHttpRequest request, ServerHttpResponse response) {
        if(body instanceof String){
            //这段代码一定要加,如果Controller直接返回String的话,SpringBoot是直接返回,故我们需要手动转换成json。
            return objectMapper.writevalueAsString(ResultData.success(body));
        }
        return ResultData.success(body);
    }
}
 

debug:


可以知道:访问swagger-ui.html 的时候,会通过ApiResourceController拿到需要的东西;这里由于对结果做了一层封装;swagger的前端页面无法正常解析;因此报错。

2.解决方案 2.1 方案一

修改supports方法,不对swagger的方法进行处理。

@RestControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice {

    @Autowired
    private ObjectMapper objectMapper;

    
    @Override
    public boolean supports(MethodParameter returnType, Class> converterType) {
        return !returnType.getDeclaringClass().getName().contains("springfox");
    }

    
    @SneakyThrows
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType,
                                  Class> selectedConverterType,
                                  ServerHttpRequest request, ServerHttpResponse response) {
        if(body instanceof String){
            //这段代码一定要加,如果Controller直接返回String的话,SpringBoot是直接返回,故我们需要手动转换成json。
            return objectMapper.writevalueAsString(ResultData.success(body));
        }
        return ResultData.success(body);
    }
}

 
2.2 方案二 
    编写一个组合注解,@RestResponse,替代RestController
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD})
@documented
@RestController
public @interface RestResponse {

}
    在ResponseBodyAdvice实现类上设置被@RestResponse标注对的controller需要进行处理
@RestControllerAdvice(annotations = RestResponse.class)
public class ResponseAdvice implements ResponseBodyAdvice {

 
2.3. 方案三 

使用basePackages来限制要扫描的包。

@RestControllerAdvice(basePackages = "com.zhx.controller")
public class ResponseAdvice implements ResponseBodyAdvice {

 
2.4 其他 

@RestControllerAdvice 中还有其他的方法能得到一样的效果

转载请注明:文章转载自 www.mshxw.com
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号