Spring注解@RestControllerAdvice原理解析

2023-08-08 17:29:04 213

这篇文章主要介绍了Spring注解@RestControllerAdvice原理解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下

前言

前段时间部门搭建新系统，需要出异常后统一接口的返回格式，于是用到了Spring的注解@RestControllerAdvice。现在把此注解的用法总结一下。

用法

首先定义返回对象ResponseDto

packagecom.staff.points.common;

importlombok.Data;

importjava.io.Serializable;

@Data
publicclassResponseDtoimplementsSerializable{
privatestaticfinallongserialVersionUID=-284719732991678911L;

privateStringcode;

privateStringmessage;

privateTdata;

publicstaticResponseDtoassemblingSuccessResponse(Tdata){
ResponseDtoresponseDto=newResponseDto<>();
responseDto.setCode(ResponseCodeEnum.SUCCESS.getCode());
responseDto.setMessage(ResponseCodeEnum.SUCCESS.getMessage());
responseDto.setData(data);
returnresponseDto;
}

publicstaticResponseDtoassemblingSuccessResponse(){
ResponseDtoresponseDto=newResponseDto<>();
responseDto.setCode(ResponseCodeEnum.SUCCESS.getCode());
responseDto.setMessage(ResponseCodeEnum.SUCCESS.getMessage());
responseDto.setData(null);
returnresponseDto;
}

publicstaticResponseDtoassemblingFailureResponse(ResponseCodeEnumdata){
ResponseDtoresponseDto=newResponseDto<>();
responseDto.setCode(data.FAILURE.getCode());
responseDto.setMessage(data.FAILURE.getMessage());
returnresponseDto;
}

publicstaticResponseDtoassemblingFailureResponse(){
ResponseDtoresponseDto=newResponseDto<>();
responseDto.setCode(ResponseCodeEnum.FAILURE.getCode());
responseDto.setMessage(ResponseCodeEnum.FAILURE.getMessage());
returnresponseDto;
}
}

然后定义返回码的枚举类，此处只定义了两种，有需要可以往下添加很多。

packagecom.staff.points.common;

importlombok.AllArgsConstructor;
importlombok.Getter;

@AllArgsConstructor
@Getter
publicenumResponseCodeEnum{
SUCCESS("00","成功"),
FAILURE("01","系统异常");


privateStringcode;
privateStringmessage;
}

下面是自定义的异常类

packagecom.staff.points.common;

importlombok.Data;

@Data
publicclassStaffPointsExceptionextendsRuntimeException{
privateStringcode;
privateStringmessage;
publicStaffPointsException(){}

publicStaffPointsException(Exceptione){
super(e);
}

publicStaffPointsException(Stringcode,Stringmessage){
super(message);
this.code=code;
this.message=message;
}

publicStaffPointsException(ResponseCodeEnumcodeEnum){
super(codeEnum.getMessage());
this.code=codeEnum.getCode();
this.message=codeEnum.getMessage();
}
}

然后是关键的@RestControllerAdvice修饰的类

packagecom.staff.points.exception;

importcom.staff.points.common.ResponseCodeEnum;
importcom.staff.points.common.ResponseDto;
importcom.staff.points.common.StaffPointsException;
importorg.slf4j.Logger;
importorg.slf4j.LoggerFactory;
importorg.springframework.stereotype.Component;
importorg.springframework.web.bind.annotation.ExceptionHandler;
importorg.springframework.web.bind.annotation.RestControllerAdvice;

@RestControllerAdvice
@Component
publicclassUnifyExceptionHandler{
privateLoggerlogger=LoggerFactory.getLogger(UnifyExceptionHandler.class);

@ExceptionHandler(Exception.class)
publicResponseDtohandlerCommonException(Exceptione){
ResponseDtoresponseDto=newResponseDto<>();
responseDto.setCode(ResponseCodeEnum.FAILURE.getCode());
responseDto.setMessage(ResponseCodeEnum.FAILURE.getMessage());
logger.info("UnifyExceptionHandler.handlerCommonExceptionexception:"+e);
returnresponseDto;
}
//报StaffPointException时，对其进行拦截并处理的方法
@ExceptionHandler(StaffPointsException.class)
publicResponseDtohandlerCustomizeException(StaffPointsExceptione){
ResponseDtoresponseDto=newResponseDto<>();
responseDto.setCode(e.getCode());
responseDto.setMessage(e.getMessage());
logger.info("UnifyExceptionHandler.handlerCustomizeExceptionStaffPointsException:"+e);
returnresponseDto;
}
}

运行代码时，如果出现了StaffPointException，那么就会被拦截进入第27行的方法（就是说可以自由的在业务代码里往外throw自定义异常了）；如果出现了其他的异常，则进入18行的方法，统一返回。

验证一下，在代码里造一个NPE异常时，返回结果：

{
"code":"01",
"message":"系统异常",
"data":null
}

造一个StaffPointsException异常时，返回结果：

{
"code":"99",
"message":"自定义业务异常",
"data":null
}

它的作用原理，大体是先在spring初始化时将类扫描进容器，出异常后，在DispatcherServlet类的doDispatch方法中调用了对异常的拦截处理。

小结

看@RestControllerAdvice源码可以知道，它就是@ControllerAdvice和@ResponseBody的合并。此注解通过对异常的拦截实现的统一异常返回处理，如果大家在项目中有类似的需求，不妨试一下，好用又方便。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持毛票票。

声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。

Spring注解@RestControllerAdvice原理解析

热门推荐

随机推荐