SpringBoot统一返回处理

最新推荐文章于 2025-03-11 09:42:19 发布

原创最新推荐文章于 2025-03-11 09:42:19 发布 · 575 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #java #spring

该代码示例展示了如何使用@RestControllerAdvice注解来实现SpringMVC应用中的统一响应封装。它会遍历指定包下的所有控制器方法，除了标注了IgnoreResponseAdviceReturn或IgnoreResponseAdvice的，对其他返回值进行统一处理，将结果包装成ResultData对象并返回。

使用@RestControllerAdvice()注解进行统一返回封装

@Slf4j
@RestControllerAdvice(basePackages = {"cyh.travel.controller", "cyh.user.controller","cyh.shop.controller","cyh.order.controller","cyh.alipay.controller"})
@SuppressWarnings("all")
public class CommonResponseAdvice implements ResponseBodyAdvice<Object> {

    /**
     * 判断是否需要进行统一返回处理
     *
     * @param returnType
     * @param converterType
     * @return
     */
    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        if (returnType.hasMethodAnnotation(IgnoreResponseAdviceReturn.class) || returnType.hasParameterAnnotation(IgnoreResponseAdvice.class)) {
            return false;
        }
        return true;
    }

    /**
     * 进行统一返回处理
     *
  
     */
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        if (body instanceof String) {
            return body;
        }
        return ResultData.success("ok", body);
    }

}

忽略全局封装返回

/**
 * 忽略统一返回
 *
 */
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface IgnoreResponseAdvicerReturn {
}