如何优雅的写 Controller 层代码？ |
您所在的位置：网站首页 › arduino音标怎么写 › 如何优雅的写 Controller 层代码？ |
如何优雅的写 Controller 层代码？
|
前言 本篇主要要介绍的就是 controller 层的处理，一个完整的后端请求由 4 部分组成： 接口地址（也就是 URL 地址） 请求方式（一般就是 get、set，当然还有 put、delete） 请求数据（request，有 head 跟 body） 响应数据（response）本篇将解决以下 3 个问题： 当接收到请求时，如何优雅的校验参数 返回响应数据该如何统一的进行处理 接收到请求，处理业务逻辑时抛出了异常又该如何处理Controller 层参数接收（太基础了，可以跳过） 常见的请求就分为 get 跟 post 两种： @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) { ... } } 复制代码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 : 泡脚 复制代码统一状态码 | 返回格式为了跟前端妹妹打好关系，我们通常需要对后端返回的数据进行包装一下，增加一下状态码，状态信息，这样前端妹妹接收到数据就可以根据不同的状态码，判断响应数据状态，是否成功是否异常进行不同的显示。 当然这让你拥有了更多跟前端妹妹的交流机会，假设我们约定了 1000 就是成功的意思。 如果你不封装，那么返回的数据是这样子的： { "productId": 1, "productName": "泡脚", "productPrice": 100.00, "productDescription": "中药泡脚加按摩", "productStatus": 0, } 复制代码经过封装以后时这样子的： { "code": 1000, "msg": "请求成功", "data": { "productId": 1, "productName": "泡脚", "productPrice": 100.00, "productDescription": "中药泡脚加按摩", "productStatus": 0, } } 复制代码 | 封装 ResultVo这些状态码肯定都是要预先编好的，怎么编呢？写个常量 1000？还是直接写死 1000？ 要这么写就真的书白读的了，写状态码当然是用枚举拉： ①首先先定义一个状态码的接口，所有状态码都需要实现它，有了标准才好做事： public interface StatusCode { public int getCode(); public String getMsg(); } 复制代码②然后去找前端妹妹，跟他约定好状态码（这可能是你们唯一的约定了）枚举类嘛，当然不能有 setter 方法了，因此我们不能在用 @Data 注解了，我们要用 @Getter。 @Getter public 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; } } 复制代码③写好枚举类，就开始写 ResultVo 包装类了，我们预设了几种默认的方法，比如成功的话就默认传入 object 就可以了，我们自动包装成 success。 @Data public 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; } } 复制代码使用，现在的返回肯定就不是 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))); } 复制代码最后返回就会是上面带了状态码的数据了。 统一校验 | 原始做法假设有一个添加 ProductInfo 的接口，在没有统一校验时，我们需要这么做。 @Data public 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)) > 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, ... } } 复制代码 | NOT 统一响应 不开启统一响应原因： 开发小哥是开心了，可是其他系统就不开心了。举个例子：我们项目中集成了一个健康检测的功能，也就是这货。 @RestController public class HealthController { @GetMapping("/health") public String health() { return "success"; } } 复制代码公司部署了一套校验所有系统存活状态的工具，这工具就定时发送 get 请求给我们系统： “兄弟，你死了吗？” “我没死，滚” “兄弟，你死了吗？” “我没死，滚” 是的，web 项目的本质就是复读机。一旦发送的请求没响应，就会给负责人发信息（企业微信或者短信之类的），你的系统死啦！赶紧回来排查 bug 吧！ 让大家感受一下。每次看到我都射射发抖，早上 6 点！我 tm！！！！！ 人家要的返回只要一个 success，人家定的标准不可能因为你一个系统改。俗话说的好，如果你改变不了环境，那你就只能我**** 新增不进行封装注解： 因为百分之 99 的请求还是需要包装的，只有个别不需要，写在包装的过滤器吧？又不是很好维护，那就加个注解好了。所有不需要包装的就加上这个注解。 @Target({ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) public @interface NotControllerResponseAdvice { } 复制代码然后在我们的增强过滤方法上过滤包含这个注解的方法： @RestControllerAdvice(basePackages = {"com.bugpool.leilema"}) public class ControllerResponseAdvice implements ResponseBodyAdvice { @Override public boolean supports(MethodParameter methodParameter, Class> 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。 |
【本文地址】