如何把Controller层代码写的更优雅？

Part1前言

本篇主要要介绍的就是 controller 层的处理，一个完整的后端请求由4部分组成：

接口地址(也就是URL地址)

请求方式(一般就是get、set，当然还有put、delete)

请求数据(request，有head跟body)

响应数据(response)

本篇将解决以下3个问题：

当接收到请求时，如何优雅的校验参数

返回响应数据该如何统一的进行处理

接收到请求，处理业务逻辑时抛出了异常又该如何处理

Part2Controller层参数接收（太基础了，可以跳过）

常见的请求就分为 get 跟 post 2种

@RestController
@RequestMapping("/product/product-info")
publicclassProductInfoController{
@Autowired
ProductInfoServiceproductInfoService;

@GetMapping("/findById")
publicProductInfoQueryVofindById(Integerid){
...
}

@PostMapping("/page")
publicIPagefindPage(Pagepage,ProductInfoQueryVovo){
...
}
}

@RestController：@RestController = @Controller + @ResponseBody。加上这个注解，springboot就会吧这个类当成 controller 进行处理，然后把所有返回的参数放到 ResponseBody 中

@RequestMapping：请求的前缀，也就是所有该 Controller 下的请求都需要加上 /product/product-info 的前缀

@GetMapping("/findById")：标志这是一个 get 请求，并且需要通过 /findById 地址才可以访问到

@PostMapping("/page")：同理，表示是个 post 请求

参数：至于参数部分，只需要写上 ProductInfoQueryVo，前端过来的 json 请求便会通过映射赋值到对应的对象中，例如请求这么写，productId 就会自动被映射到 vo 对应的属性当中

size:1
current:1

productId:1
productName:泡脚

Part3统一状态码

1. 返回格式

为了跟 前端妹妹 打好关系，我们通常需要对后端返回的数据进行包装一下，增加一下 状态码，状态信息，这样前端妹妹接收到数据就可以根据不同的 状态码，判断 响应数据状态，是否成功是否异常进行不同的显示。当然这让你拥有了更多跟前端妹妹的交流机会，假设我们约定了 1000 就是成功的意思如果你不封装，那么返回的数据是这样子的

欢迎关注公众号"Java学习之道"，查看更多干货！

{
"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？要这么写就真的书白读的了，写 状态码 当然是用枚举拉

首先先定义一个 状态码 的接口，所有 状态码 都需要实现它，有了标准才好做事

publicinterfaceStatusCode{
publicintgetCode();
publicStringgetMsg();
}

然后去找前端妹妹，跟他约定好状态码（这可能是你们唯一的约定了）枚举类嘛，当然不能有 setter 方法了，因此我们不能在用 @Data 注解了，我们要用 @Getter

@Getter
publicenumResultCodeimplementsStatusCode{
SUCCESS(1000,"请求成功"),
FAILED(1001,"请求失败"),
VALIDATE_ERROR(1002,"参数校验失败"),
RESPONSE_PACK_ERROR(1003,"response返回包装失败");

privateintcode;
privateStringmsg;

ResultCode(intcode,Stringmsg){
this.code=code;
this.msg=msg;
}
}

写好枚举类，就开始写 ResultVo 包装类了，我们预设了几种默认的方法，比如成功的话就默认传入 object 就可以了，我们自动包装成 success

@Data
publicclassResultVo{
//状态码
privateintcode;

//状态信息
privateStringmsg;

//返回对象
privateObjectdata;

//手动设置返回vo
publicResultVo(intcode,Stringmsg,Objectdata){
this.code=code;
this.msg=msg;
this.data=data;
}

//默认返回成功状态码，数据对象
publicResultVo(Objectdata){
this.code=ResultCode.SUCCESS.getCode();
this.msg=ResultCode.SUCCESS.getMsg();
this.data=data;
}

//返回指定状态码，数据对象
publicResultVo(StatusCodestatusCode,Objectdata){
this.code=statusCode.getCode();
this.msg=statusCode.getMsg();
this.data=data;
}

//只返回状态码
publicResultVo(StatusCodestatusCode){
this.code=statusCode.getCode();
this.msg=statusCode.getMsg();
this.data=null;
}
}

使用，现在的返回肯定就不是 return data; 这么简单了，而是需要 new ResultVo(data);

@PostMapping("/findByVo")
publicResultVofindByVo(@ValidatedProductInfoVovo){
ProductInfoproductInfo=newProductInfo();
BeanUtils.copyProperties(vo,productInfo);
returnnewResultVo(productInfoService.getOne(newQueryWrapper(productInfo)));
}

最后返回就会是上面带了状态码的数据了

Part4统一校验

1. 原始做法

假设有一个添加 ProductInfo 的接口，在没有统一校验时，我们需要这么做

@Data
publicclassProductInfoVo{
//商品名称
privateStringproductName;
//商品价格
privateBigDecimalproductPrice;
//上架状态
privateIntegerproductStatus;
}

@PostMapping("/findByVo")
publicProductInfofindByVo(ProductInfoVovo){
if(StringUtils.isNotBlank(vo.getProductName())){
thrownewAPIException("商品名称不能为空");
}
if(null!=vo.getProductPrice()&&vo.getProductPrice().compareTo(newBigDecimal(0))< 0) {
        throw new APIException("商品价格不能为负数");
    }
    ...

    ProductInfo productInfo = new ProductInfo();
    BeanUtils.copyProperties(vo, productInfo);
    return new ResultVo(productInfoService.getOne(new QueryWrapper(productInfo)));
}

这if写的人都傻了，能忍吗？肯定不能忍啊

欢迎关注公众号"Java学习之道"，查看更多干货！

2. @Validated参数校验

好在有 @Validated，又是一个校验参数必备良药了。有了 @Validated 我们只需要再 vo 上面加一点小小的注解，便可以完成校验功能

@Data
publicclassProductInfoVo{
@NotNull(message="商品名称不允许为空")
privateStringproductName;

@Min(value=0,message="商品价格不允许为负数")
privateBigDecimalproductPrice;

privateIntegerproductStatus;
}

@PostMapping("/findByVo")
publicProductInfofindByVo(@ValidatedProductInfoVovo){
ProductInfoproductInfo=newProductInfo();
BeanUtils.copyProperties(vo,productInfo);
returnnewResultVo(productInfoService.getOne(newQueryWrapper(productInfo)));
}

运行看看，如果参数不对会发生什么？我们故意传一个价格为 -1 的参数过去

productName:泡脚
productPrice:-1
productStatus:1

{
"timestamp":"2020-04-19T0337.268+0000",
"status":400,
"error":"BadRequest",
"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":"Validationfailedforobjectu003du0027productInfoVou0027.Errorcount:1",
"trace":"org.springframework.validation.BindException:org.springframework.validation.BeanPropertyBindingResult:1errors
Fielderrorinobjectu0027productInfoVou0027onfieldu0027productPriceu0027:rejectedvalue[-1];codes[Min.productInfoVo.productPrice,Min.productPrice,Min.java.math.BigDecimal,Min];arguments[org.springframework.context.support.DefaultMessageSourceResolvable:codes[productInfoVo.productPrice,productPrice];arguments[];defaultmessage[productPrice],0];defaultmessage[商品价格不允许为负数]
	atorg.springframework.web.method.annotation.ModelAttributeMethodProcessor.resolveArgument(ModelAttributeMethodProcessor.java:164)
	atorg.springframework.web.method.support.HandlerMethodArgumentResolverComposite.resolveArgument(HandlerMethodArgumentResolverComposite.java:121)
	atorg.springframework.web.method.support.InvocableHandlerMethod.getMethodArgumentValues(InvocableHandlerMethod.java:167)
	atorg.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:134)
	atorg.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:105)
	atorg.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:879)
	atorg.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:793)
	atorg.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87)
	atorg.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1040)
	atorg.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:943)
	atorg.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1006)
	atorg.springframework.web.servlet.FrameworkServlet.doPost(FrameworkServlet.java:909)
	atjavax.servlet.http.HttpServlet.service(HttpServlet.java:660)
	atorg.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:883)
	atjavax.servlet.http.HttpServlet.service(HttpServlet.java:741)
	atorg.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:231)
	atorg.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
	atorg.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:53)
	atorg.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
	atorg.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
	atcom.alibaba.druid.support.http.WebStatFilter.doFilter(WebStatFilter.java:124)
	atorg.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
	atorg.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
	atorg.springframework.web.filter.RequestContextFilter.doFilterInternal(RequestContextFilter.java:100)
	atorg.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:119)
	atorg.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
	atorg.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
	atorg.springframework.web.filter.FormContentFilter.doFilterInternal(FormContentFilter.java:93)
	atorg.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:119)
	atorg.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
	atorg.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
	atorg.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:201)
	atorg.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:119)
	atorg.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
	atorg.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
	atorg.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:202)
	atorg.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:96)
	atorg.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:541)
	atorg.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:139)
	atorg.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:92)
	atorg.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:74)
	atorg.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:343)
	atorg.apache.coyote.http11.Http11Processor.service(Http11Processor.java:373)
	atorg.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:65)
	atorg.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:868)
	atorg.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1594)
	atorg.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:49)
	atjava.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1128)
	atjava.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:628)
	atorg.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)
	atjava.base/java.lang.Thread.run(Thread.java:830)
",
"path":"/leilema/product/product-info/findByVo"
}

大功告成了吗？虽然成功校验了参数，也返回了异常，并且带上 "商品价格不允许为负数" 的信息。但是你要是这样返回给前端，前端妹妹就提刀过来了，当年约定好的 状态码，你个 负心人 说忘就忘？用户 体验小于等于0 啊！所以我们要进行优化一下，每次出现异常的时候，自动把 状态码 写好，不负妹妹之约！

欢迎关注公众号"Java学习之道"，查看更多干货！

3. 优化异常处理

首先我们先看看校验参数抛出了什么异常

Resolved[org.springframework.validation.BindException:org.springframework.validation.BeanPropertyBindingResult:1errors

我们看到代码抛出了 org.springframework.validation.BindException 的绑定异常，因此我们的思路就是 AOP 拦截所有 controller，然后异常的时候统一拦截起来，进行封装！完美！玩你个头啊完美，这么呆瓜的操作 springboot 不知道吗？ spring mvc 当然知道拉，所以给我们提供了一个 @RestControllerAdvice 来增强所有 @RestController，然后使用 @ExceptionHandler 注解，就可以拦截到对应的异常。

这里我们就拦截 BindException.class 就好了。最后在返回之前，我们对异常信息进行包装一下，包装成 ResultVo，当然要跟上 ResultCode.VALIDATE_ERROR 的异常状态码。这样前端妹妹看到 VALIDATE_ERROR 的状态码，就会调用数据校验异常的弹窗提示用户哪里没填好

@RestControllerAdvice
publicclassControllerExceptionAdvice{
@ExceptionHandler({BindException.class})
publicResultVoMethodArgumentNotValidExceptionHandler(BindExceptione){
//从异常对象中拿到ObjectError对象
ObjectErrorobjectError=e.getBindingResult().getAllErrors().get(0);
returnnewResultVo(ResultCode.VALIDATE_ERROR,objectError.getDefaultMessage());
}
}

来康康效果，完美。1002 与前端妹妹约定好的状态码

{
"code":1002,
"msg":"参数校验失败",
"data":"商品价格不允许为负数"
}

Part5统一响应

1. 统一包装响应

再回头看一下 controller 层的返回

returnnewResultVo(productInfoService.getOne(newQueryWrapper(productInfo)));

开发小哥肯定不乐意了，谁有空天天写 new ResultVo(data) 啊，我就想返回一个实体！怎么实现我不管！好把，那就是 AOP 拦截所有 Controller，再 @After 的时候统一帮你封装一下咯怕是上一次脸打的不够疼，springboot能不知道这么个操作吗？

@RestControllerAdvice(basePackages={"com.bugpool.leilema"})
publicclassControllerResponseAdviceimplementsResponseBodyAdvice