SpringBoot统一返回处理

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

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

使用@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 {
}

Spring Boot 中,我们可以使用统一返回处理来规范 API 接口的返回格式,避免重复的代码和降低维护成本。 一般来说,我们可以定义一个 Result 类来封装接口返回的数据,包括状态码、提示信息和返回数据等。同时,我们还可以定义一个异常处理类来捕获全局的异常,并将异常信息封装到 Result 类中返回给前端。 以下是一个示例代码: ```java @Data @NoArgsConstructor @AllArgsConstructor public class Result<T> { private Integer code; private String msg; private T data; public static <T> Result<T> success(T data) { return new Result<>(200, "success", data); } public static Result<?> error(Integer code, String msg) { return new Result<>(code, msg, null); } } @ControllerAdvice @ResponseBody public class GlobalExceptionHandler { @ExceptionHandler(value = Exception.class) public Result<?> handleException(Exception e) { log.error("未知异常:{}", e.getMessage()); return Result.error(500, "服务器内部错误"); } @ExceptionHandler(value = BusinessException.class) public Result<?> handleBusinessException(BusinessException e) { log.error("业务异常:{}", e.getMessage()); return Result.error(e.getCode(), e.getMessage()); } } ``` 在上面的代码中,我们定义了一个 Result 类来封装接口返回的数据。其中,success 方法表示成功时返回的结果,error 方法表示失败时返回的结果。 同时,我们还定义了一个全局异常处理器 GlobalExceptionHandler,用来捕获全局的异常。在 handleException 和 handleBusinessException 方法中,我们分别处理了未知异常和业务异常,并将异常信息封装到 Result 类中返回给前端。 通过使用统一返回处理,我们可以大大简化接口返回的代码,提高代码的可维护性和可读性。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值