推荐关注
以下文章来源Java后端栈,回复”面试“获面试宝典
哈喽,各位新来的小伙伴们,大家好!由于公众号做了改版,为了保证公众号的资源能准时推送到你手里,大家记得将后端君的公众号 加星标置顶 ,在此真诚的表示感谢~
编辑:后端妹 | 来源:https://bugpool.blog.csdn.net/article/details/105610962
上一篇:看看人家那数据报表项目,那叫一个优雅
正文
玩你个头啊完美,这么呆瓜的操作springboot
不知道吗?spring mvc
当然知道拉,所以给我们提供了一个@RestControllerAdvice
来增强所有@RestController
,然后使用@ExceptionHandler
注解,就可以拦截到对应的异常。
这里我们就拦截BindException.class
就好了。最后在返回之前,我们对异常信息进行包装一下,包装成ResultVo
,当然要跟上ResultCode.VALIDATE_ERROR
的异常状态码。这样前端妹妹看到VALIDATE_ERROR
的状态码,就会调用数据校验异常的弹窗提示用户哪里没填好
@RestControllerAdvice
public class ControllerExceptionAdvice {
@ExceptionHandler({BindException.class})
public ResultVo MethodArgumentNotValidExceptionHandler(BindException e) {
// 从异常对象中拿到ObjectError对象
ObjectError objectError = e.getBindingResult().getAllErrors().get(0);
return new ResultVo(ResultCode.VALIDATE_ERROR, objectError.getDefaultMessage());
}
}
来康康效果,完美。1002
与前端妹妹约定好的状态码
{
"code": 1002,
"msg": "参数校验失败",
"data": "商品价格不允许为负数"
}
四、统一响应
1. 统一包装响应
再回头看一下controller
层的返回
return new ResultVo(productInfoService.getOne(new QueryWrapper(productInfo)));
开发小哥肯定不乐意了,谁有空天天写new ResultVo(data)
啊,我就想返回一个实体!怎么实现我不管!好把,那就是AOP
拦截所有Controller
,再@After
的时候统一帮你封装一下咯
怕是上一次脸打的不够疼,springboot能不知道这么个操作吗?
@RestControllerAdvice(basePackages = {"com.bugpool.leilema"})
public class ControllerResponseAdvice implements ResponseBodyAdvice<Object> {
@Override
public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
// response是ResultVo类型,或者注释了NotControllerResponseAdvice都不进行包装
return !methodParameter.getParameterType().isAssignableFrom(ResultVo.class);
}
@Override
public Object beforeBodyWrite(Object data, MethodParameter returnType, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest request, ServerHttpResponse response) {
// String类型不能直接包装
if (returnType.getGenericParameterType().equals(String.class)) {
ObjectMapper objectMapper = new ObjectMapper();
try {
// 将数据包装在ResultVo里后转换为json串进行返回
return objectMapper.writeValueAsString(new ResultVo(data));
} catch (JsonProcessingException e) {
throw new APIException(ResultCode.RESPONSE_PACK_ERROR, e.getMessage());
}
}
// 否则直接包装成ResultVo返回
return new ResultVo(data);
}
}
@RestControllerAdvice(basePackages = {"com.bugpool.leilema"})
自动扫描了所有指定包下的controller
,在Response
时进行统一处理。另外,搜索公众号Java架构师技术后台回复“Spring”,获取一份惊喜礼包。- 重写
supports
方法,也就是说,当返回类型已经是ResultVo
了,那就不需要封装了,当不等与ResultVo
时才进行调用beforeBodyWrite
方法,跟过滤器的效果是一样的 - 最后重写我们的封装方法
beforeBodyWrite
,注意除了String
的返回值有点特殊,无法直接封装成json,我们需要进行特殊处理,其他的直接new ResultVo(data);
就ok了
打完收工,康康效果
@PostMapping("/findByVo")
public ProductInfo findByVo(@Validated ProductInfoVo vo) {
ProductInfo productInfo = new ProductInfo();
BeanUtils.copyProperties(vo, productInfo);
return productInfoService.getOne(new QueryWrapper(productInfo));
}
此时就算我们返回的是po
,接收到的返回就是标准格式了,开发小哥露出了欣慰的笑容
{
"code": 1000,
"msg": "请求成功",
"data": {
"productId": 1,
"productName": "泡脚",
"productPrice": 100.00,
"productDescription": "中药泡脚加按摩",
"productStatus": 0,
...
}
}
2. NOT统一响应
不开启统一响应原因
开发小哥是开心了,可是其他系统就不开心了。举个例子:我们项目中集成了一个健康检测
的功能,也就是这货
@RestController
public class HealthController {
@GetMapping("/health")
public String health() {
return "success";
}
}
公司部署了一套校验所有系统存活状态的工具,这工具就定时发送get
请求给我们系统
“兄弟,你死了吗?”
“我没死,滚”
“兄弟,你死了吗?”
“我没死,滚”
是的,web项目的本质就是复读机。一旦发送的请求没响应
,就会给负责人发信息(企业微信或者短信之类的),你的系统死啦
!赶紧回来排查bug
吧!让大家感受一下。每次看到我都射射发抖
,早上6点!我tm!!!!!
好吧,没办法,人家是老大,人家要的返回不是
{
"code": 1000,
"msg": "请求成功",
"data": "success"
}
人家要的返回只要一个success
,人家定的标准不可能因为你一个系统改。俗话说的好,如果你改变不了环境,那你就只能我****
新增不进行封装注解
因为百分之99的请求还是需要包装的,只有个别不需要,写在包装的过滤器吧?又不是很好维护,那就加个注解好了。所有不需要包装的就加上这个注解。
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface NotControllerResponseAdvice {
}
然后在我们的增强过滤方法上过滤包含这个注解的方法
@RestControllerAdvice(basePackages = {"com.bugpool.leilema"})
public class ControllerResponseAdvice implements ResponseBodyAdvice<Object> {
@Override
public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
// response是ResultVo类型,或者注释了NotControllerResponseAdvice都不进行包装
return !(methodParameter.getParameterType().isAssignableFrom(ResultVo.class)
|| methodParameter.hasMethodAnnotation(NotControllerResponseAdvice.class));
}
...
最后就在不需要包装的方法上加上注解
@RestController
public class HealthController {
@GetMapping("/health")
@NotControllerResponseAdvice
public String health() {
return "success";
}
}
这时候就不会自动封装了,而其他没加注解的则依旧自动包装
五、统一异常
每个系统都会有自己的业务异常
,比如库存不能小于0
子类的,这种异常并非程序异常,而是业务操作引发的异常,我们也需要进行规范的编排业务异常状态码
,并且写一个专门处理的异常类
,最后通过刚刚学习过的异常拦截
统一进行处理,以及打日志
异常状态码枚举,既然是状态码,那就肯定要实现我们的标准接口`StatusCode`
@Getter
public enum AppCode implements StatusCode {
APP_ERROR(2000, "业务异常"),
PRICE_ERROR(2001, "价格异常");
private int code;
private String msg;
AppCode(int code, String msg) {
this.code = code;
this.msg = msg;
}
}
异常类,这里需要强调一下,`code`代表`AppCode`的异常状态码,也就是2000;`msg`代表`业务异常`,这只是一个大类,一般前端会放到弹窗`title`上;最后`super(message);`这才是抛出的详细信息,在前端显示在`弹窗体`中,在`ResultVo`则保存在`data`中
@Getter
public class APIException extends RuntimeException {
private int code;
private String msg;
// 手动设置异常
public APIException(StatusCode statusCode, String message) {
// message用于用户设置抛出错误详情,例如:当前价格-5,小于0
super(message);
// 状态码
this.code = statusCode.getCode();
// 状态码配套的msg
this.msg = statusCode.getMsg();
}
// 默认异常使用APP_ERROR状态码
public APIException(String message) {
super(message);
this.code = AppCode.APP_ERROR.getCode();
this.msg = AppCode.APP_ERROR.getMsg();
}
}
最后进行统一异常的拦截,这样无论在`service`层还是`controller`层,开发人员只管抛出`API异常`,不需要关系怎么返回给前端,更不需要关心`日志`的打印
@RestControllerAdvice
public class ControllerExceptionAdvice {
@ExceptionHandler({BindException.class})
public ResultVo MethodArgumentNotValidExceptionHandler(BindException e) {
// 从异常对象中拿到ObjectError对象
ObjectError objectError = e.getBindingResult().getAllErrors().get(0);
return new ResultVo(ResultCode.VALIDATE_ERROR, objectError.getDefaultMessage());
}
@ExceptionHandler(APIException.class)
public ResultVo APIExceptionHandler(APIException e) {
// log.error(e.getMessage(), e); 由于还没集成日志框架,暂且放着,写上TODO
return new ResultVo(e.getCode(), e.getMsg(), e.getMessage());
}
}
if (null == orderMaster) {
throw new APIException(AppCode.ORDER_NOT_EXIST, "订单号不存在:" + orderId);
}
{
"code": 2003,
"msg": "订单不存在",
"data": "订单号不存在:1998"
}
就会自动抛出AppCode.ORDER_NOT_EXIST
状态码的响应,并且带上异常详细信息订单号不存在:xxxx
。后端小哥开发有效率,前端妹妹获取到2003
状态码,调用对应警告弹窗,title
写上订单不存在
,body
详细信息记载"订单号不存在:1998"
。同时日志
还自动打上去了!666!老哥们三连点个赞!
欢迎有需要的同学试试,如果本文对您有帮助,也请帮忙点个 赞 + 在看 啦!❤️
在 GitHub猿 还有更多优质项目系统学习资源,欢迎分享给其他同学吧!
最后给读者整理了一份BAT大厂面试真题,需要的可扫码加微信备注:“面试”获取。
◆ ◆ ◆ ◆ ◆
(放到你圈子里,朋友们会感激您)PS:如果觉得我的分享不错,欢迎大家随手点赞、在看。本文仅供交流学习 , 版权归属原作者。温馨提示:《Java后端栈》推文内容如有侵权请您告知我们会在第一时间处理或撤销;互联网是一个资源共享的生态圈,我们崇尚分享。好文推荐:
欢迎添加栈哥个人微信 ysle007 进粉丝群或围观朋友圈
扫码关注带你吊爆Java后端技术