前言
本篇次要要介绍的就是controller层的解决，一个残缺的后端申请由4局部组成：
接口地址(也就是URL地址)申请形式(个别就是get、set，当然还有put、delete)申请数据(request，有head跟body)响应数据(response)
本篇将解决以下3个问题：
- 当接管到申请时，如何优雅的校验参数
- 返回响应数据该如何对立的进行解决
- 接管到申请，解决业务逻辑时抛出了异样又该如何解决
一、Controller层参数接管（太根底了，能够跳过）
常见的申请就分为get跟post2种
@RestController@RequestMapping("/product/product-info")public class ProductInfoController { @Autowired ProductInfoService productInfoService; @GetMapping("/findById") public ProductInfoQueryVo findById(Integer id) { ... } @PostMapping("/page") public IPage findPage(Page page, ProductInfoQueryVo vo) { ... }}1、@RestController：之前解释过，@RestController = @Controller + ResponseBody。加上这个注解，springboot就会吧这个类当成controller进行解决，而后把所有返回的参数放到ResponseBody中
举荐一个 Spring Boot 根底实战教程：\
https://github.com/javastacks...
2、@RequestMapping：申请的前缀，也就是所有该Controller下的申请都须要加上/product/product-info的前缀
3、@GetMapping("/findById")：标记这是一个get申请，并且须要通过/findById地址才能够拜访到
4、@PostMapping("/page")：同理，示意是个post申请
5、参数：至于参数局部，只须要写上ProductInfoQueryVo，前端过去的json申请便会通过映射赋值到对应的对象中，例如申请这么写，productId就会主动被映射到vo对应的属性当中
size : 1current : 1productId : 1productName : 泡脚二、对立状态码
1. 返回格局
为了跟前端妹妹打好关系，咱们通常须要对后端返回的数据进行包装一下，减少一下状态码，状态信息，这样前端妹妹接管到数据就能够依据不同的状态码，判断响应数据状态，是否胜利是否异样进行不同的显示。
当然这让你领有了更多跟前端妹妹的交换机会，假如咱们约定了1000就是胜利的意思
如果你不封装，那么返回的数据是这样子的
{ "productId": 1, "productName": "泡脚", "productPrice": 100.00, "productDescription": "中药泡脚加按摩", "productStatus": 0,}通过封装当前时这样子的
{ "code": 1000, "msg": "申请胜利", "data": { "productId": 1, "productName": "泡脚", "productPrice": 100.00, "productDescription": "中药泡脚加按摩", "productStatus": 0, }}2. 封装ResultVo
这些状态码必定都是要事后编好的，怎么编呢？写个常量1000？还是间接写死1000？要这么写就真的书白读的了，写状态码当然是用枚举拉
1、首先先定义一个状态码的接口，所有状态码都须要实现它，有了规范才好做事
public interface StatusCode { public int getCode(); public String getMsg();}2、而后去找前端妹妹，跟他约定好状态码（这可能是你们惟一的约定了）枚举类嘛，当然不能有setter办法了，因而咱们不能在用@Data注解了，咱们要用@Getter
@Getterpublic enum ResultCode implements StatusCode{ SUCCESS(1000, "申请胜利"), FAILED(1001, "申请失败"), VALIDATE_ERROR(1002, "参数校验失败"), RESPONSE_PACK_ERROR(1003, "response返回包装失败"); private int code; private String msg; ResultCode(int code, String msg) { this.code = code; this.msg = msg; }}3、写好枚举类，就开始写ResultVo包装类了，咱们预设了几种默认的办法，比方胜利的话就默认传入object就能够了，咱们主动包装成success
@Datapublic class ResultVo { // 状态码 private int code; // 状态信息 private String msg; // 返回对象 private Object data; // 手动设置返回vo public ResultVo(int code, String msg, Object data) { this.code = code; this.msg = msg; this.data = data; } // 默认返回胜利状态码，数据对象 public ResultVo(Object data) { this.code = ResultCode.SUCCESS.getCode(); this.msg = ResultCode.SUCCESS.getMsg(); this.data = data; } // 返回指定状态码，数据对象 public ResultVo(StatusCode statusCode, Object data) { this.code = statusCode.getCode(); this.msg = statusCode.getMsg(); this.data = data; } // 只返回状态码 public ResultVo(StatusCode statusCode) { this.code = statusCode.getCode(); this.msg = statusCode.getMsg(); this.data = null; }}4、应用，当初的返回必定就不是return data;这么简略了，而是须要new ResultVo(data);
@PostMapping("/findByVo")public ResultVo findByVo(@Validated ProductInfoVo vo) { ProductInfo productInfo = new ProductInfo(); BeanUtils.copyProperties(vo, productInfo); return new ResultVo(productInfoService.getOne(new QueryWrapper(productInfo)));}最初返回就会是下面带了状态码的数据了
三、对立校验
1. 原始做法
假如有一个增加ProductInfo的接口，在没有对立校验时，咱们须要这么做
@Datapublic class ProductInfoVo { // 商品名称 private String productName; // 商品价格 private BigDecimal productPrice; // 上架状态 private Integer productStatus;}@PostMapping("/findByVo")public ProductInfo findByVo(ProductInfoVo vo) { if (StringUtils.isNotBlank(vo.getProductName())) { throw new APIException("商品名称不能为空"); } if (null != vo.getProductPrice() && vo.getProductPrice().compareTo(new BigDecimal(0)) < 0) { throw new APIException("商品价格不能为正数"); } ... ProductInfo productInfo = new ProductInfo(); BeanUtils.copyProperties(vo, productInfo); return new ResultVo(productInfoService.getOne(new QueryWrapper(productInfo)));}这if写的人都傻了，能忍吗？必定不能忍啊
2. @Validated参数校验
好在有@Validated，又是一个校验参数必备良药了。有了@Validated咱们只须要再vo下面加一点小小的注解，便能够实现校验性能
@Datapublic class ProductInfoVo { @NotNull(message = "商品名称不容许为空") private String productName; @Min(value = 0, message = "商品价格不容许为正数") private BigDecimal productPrice; private Integer productStatus;}@PostMapping("/findByVo")public ProductInfo findByVo(@Validated ProductInfoVo vo) { ProductInfo productInfo = new ProductInfo(); BeanUtils.copyProperties(vo, productInfo); return new ResultVo(productInfoService.getOne(new QueryWrapper(productInfo)));}运行看看，如果参数不对会产生什么？
咱们成心传一个价格为-1的参数过来
productName : 泡脚productPrice : -1productStatus : 1{ "timestamp": "2020-04-19T03:06:37.268+0000", "status": 400, "error": "Bad Request", "errors": [ { "codes": [ "Min.productInfoVo.productPrice", "Min.productPrice", "Min.java.math.BigDecimal", "Min" ], "arguments": [ { "codes": [ "productInfoVo.productPrice", "productPrice" ], "defaultMessage": "productPrice", "code": "productPrice" }, 0 ], "defaultMessage": "商品价格不容许为正数", "objectName": "productInfoVo", "field": "productPrice", "rejectedValue": -1, "bindingFailure": false, "code": "Min" } ], "message": "Validation failed for object\u003d\u0027productInfoVo\u0027. Error count: 1", "trace": "org.springframework.validation.BindException: org.springframework.validation.BeanPropertyBindingResult: 1 errors\nField error in object \u0027productInfoVo\u0027 on field \u0027productPrice\u0027: rejected value [-1]; codes [Min.productInfoVo.productPrice,Min.productPrice,Min.java.math.BigDecimal,Min]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [productInfoVo.productPrice,productPrice]; arguments []; default message [productPrice],0]; default message [商品价格不容许为正数]\n\tat org.springframework.web.method.annotation.ModelAttributeMethodProcessor.resolveArgument(ModelAttributeMethodProcessor.java:164)\n\tat org.springframework.web.method.support.HandlerMethodArgumentResolverComposite.resolveArgument(HandlerMethodArgumentResolverComposite.java:121)\n\tat org.springframework.web.method.support.InvocableHandlerMethod.getMethodArgumentValues(InvocableHandlerMethod.java:167)\n\tat org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:134)\n\tat org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:105)\n\tat org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:879)\n\tat org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:793)\n\tat org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87)\n\tat org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1040)\n\tat org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:943)\n\tat org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1006)\n\tat org.springframework.web.servlet.FrameworkServlet.doPost(FrameworkServlet.java:909)\n\tat javax.servlet.http.HttpServlet.service(HttpServlet.java:660)\n\tat org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:883)\n\tat javax.servlet.http.HttpServlet.service(HttpServlet.java:741)\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:231)\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)\n\tat org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:53)\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)\n\tat com.alibaba.druid.support.http.WebStatFilter.doFilter(WebStatFilter.java:124)\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)\n\tat org.springframework.web.filter.RequestContextFilter.doFilterInternal(RequestContextFilter.java:100)\n\tat org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:119)\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)\n\tat org.springframework.web.filter.FormContentFilter.doFilterInternal(FormContentFilter.java:93)\n\tat org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:119)\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)\n\tat org.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:201)\n\tat org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:119)\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)\n\tat org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:202)\n\tat org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:96)\n\tat org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:541)\n\tat org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:139)\n\tat org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:92)\n\tat org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:74)\n\tat org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:343)\n\tat org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:373)\n\tat org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:65)\n\tat org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:868)\n\tat org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1594)\n\tat org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:49)\n\tat java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1128)\n\tat java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:628)\n\tat org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)\n\tat java.base/java.lang.Thread.run(Thread.java:830)\n", "path": "/leilema/product/product-info/findByVo"}功败垂成了吗？尽管胜利校验了参数，也返回了异样，并且带上"商品价格不容许为正数"的信息。然而你要是这样返回给前端，前端妹妹就提刀过去了，当年约定好的状态码，你个负心人说忘就忘？用户体验小于等于0啊！所以咱们要进行优化一下，每次出现异常的时候，主动把状态码写好，不负妹妹之约！
3. 优化异样解决
首先咱们先看看校验参数抛出了什么异样
Resolved [org.springframework.validation.BindException: org.springframework.validation.BeanPropertyBindingResult: 1 errors咱们看到代码抛出了org.springframework.validation.BindException的绑定异样，因而咱们的思路就是AOP拦挡所有controller，而后异样的时候对立拦挡起来，进行封装！完满！
玩你个头啊完满，这么呆瓜的操作springboot不晓得吗？spring mvc当然晓得拉，所以给咱们提供了一个@RestControllerAdvice来加强所有@RestController，而后应用@ExceptionHandler注解，就能够拦挡到对应的异样。
这里咱们就拦挡BindException.class就好了。最初在返回之前，咱们对异样信息进行包装一下，包装成ResultVo，当然要跟上ResultCode.VALIDATE_ERROR的异样状态码。这样前端妹妹看到VALIDATE_ERROR的状态码，就会调用数据校验异样的弹窗提醒用户哪里没填好
@RestControllerAdvicepublic 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时进行对立解决- 重写
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对立响应
不开启对立响应起因
开发小哥是开心了，可是其余零碎就不开心了。举个例子：咱们我的项目中集成了一个衰弱检测的性能，也就是这货
@RestControllerpublic 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)); } ...最初就在不须要包装的办法上加上注解
@RestControllerpublic class HealthController { @GetMapping("/health") @NotControllerResponseAdvice public String health() { return "success"; }}这时候就不会主动封装了，而其余没加注解的则仍旧主动包装
五、对立异样
每个零碎都会有本人的业务异样，比方库存不能小于0子类的，这种异样并非程序异样，而是业务操作引发的异样，咱们也须要进行标准的编排业务异样状态码，并且写一个专门解决的异样类，最初通过刚刚学习过的异样拦挡对立进行解决，以及打日志
1、异样状态码枚举，既然是状态码，那就必定要实现咱们的标准接口StatusCode
@Getterpublic 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; }}2、异样类，这里须要强调一下，code代表AppCode的异样状态码，也就是2000；msg代表业务异样，这只是一个大类，个别前端会放到弹窗title上；最初super(message);这才是抛出的详细信息，在前端显示在弹窗体中，在ResultVo则保留在data中。
@Getterpublic 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(); }}3、最初进行对立异样的拦挡，这样无论在service层还是controller层，开发人员只管抛出API异样，不须要关系怎么返回给前端，更不须要关怀日志的打印
@RestControllerAdvicepublic 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()); }}4、最初应用，咱们的代码只须要这么写
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！老哥们三连点个赞！
版权申明：本文为CSDN博主「bugpool」的原创文章，遵循CC 4.0 BY-SA版权协定，转载请附上原文出处链接及本申明。原文链接：https://blog.csdn.net/chaitou...
近期热文举荐：
1.1,000+ 道 Java面试题及答案整顿(2022最新版)
2.劲爆！Java 协程要来了。。。
3.Spring Boot 2.x 教程，太全了！
4.别再写满屏的爆爆爆炸类了，试试装璜器模式，这才是优雅的形式！！
5.《Java开发手册（嵩山版）》最新公布，速速下载！
感觉不错，别忘了顺手点赞+转发哦！