【禁止血压飙升】阿里大佬写的 Controller 太优雅了！

作者：小塵
链接：https://juejin.cn/post/7357172505961578511
媒介

见过几千行代码的 controller吗？我见过。
见过满是 try catch 的 controller 吗，我见过。
见过满是字段校验的 controller 吗，我见过。
见过满是业务代码的 controller 吗？不好意思，我们公司很多业务写在 controller 的。
看见这些我真的血压高。
正文

不优雅的 controller

1. @RestController
2. @RequestMapping("/user/test")
3. public class UserController {
5.     private static Logger logger = LoggerFactory.getLogger(UserController.class);
7.     @Autowired
8.     private UserService userService;
10.     @Autowired
11.     private AuthService authService;
13.     @PostMapping
14.     public CommonResult userRegistration(@RequestBody UserVo userVo) {
15.         if (StringUtils.isBlank(userVo.getUsername())){
16.             return CommonResult.error("用户名不能为空");
17.         }
18.         if (StringUtils.isBlank(userVo.getPassword())){
19.             return CommonResult.error("密码不能为空");
20.         }
21.         logger.info("注册用户：{}" , userVo.getUsername());
22.         try {
23.             userService.registerUser(userVo.getUsername());
24.             return CommonResult.ok();
25.         }catch (Exception e){
26.             logger.error("注册用户失败：{}", userVo.getUsername(), e);
27.             return CommonResult.error("注册失败");
28.         }
29.     }
31.     @PostMapping("/login")
32.     @PermitAll
33.     @ApiOperation("使用账号密码登录")
34.     public CommonResult<AuthLoginRespVO> login(@RequestBody AuthLoginReqVO reqVO) {
35.         if (StringUtils.isBlank(reqVO.getUsername())){
36.             return CommonResult.error("用户名不能为空");
37.         }
38.         if (StringUtils.isBlank(reqVO.getPassword())){
39.             return CommonResult.error("密码不能为空");
40.         }
41.         try {
42.             return success(authService.login(reqVO));
43.         }catch (Exception e){
44.             logger.error("注册用户失败：{}", reqVO.getUsername(), e);
45.             return CommonResult.error("注册失败");
46.         }
47.     }
49. }

复制代码

Spring Boot 基础就不先容了，推荐看这个实战项目：

https://github.com/javastacks/spring-boot-best-practice

优雅的controller

1. @RestController
2. @RequestMapping("/user/test")
3. public class UserController1 {
5.     private static Logger logger = LoggerFactory.getLogger(UserController1.class);
7.     @Autowired
8.     private UserService userService;
10.     @Autowired
11.     private AuthService authService;
13.     @PostMapping("/userRegistration")
14.     public CommonResult userRegistration(@RequestBody @Valid UserVo userVo) {
15.         userService.registerUser(userVo.getUsername());
16.         return CommonResult.ok();
17.     }
19.     @PostMapping("/login")
20.     @PermitAll
21.     @ApiOperation("使用账号密码登录")
22.     public CommonResult<AuthLoginRespVO> login(@RequestBody @Valid AuthLoginReqVO reqVO) {
23.         return success(authService.login(reqVO));
24.     }
26. }

复制代码

代码量直接减一半呀，这还不算上有些直接把业务逻辑写在 controller 的，看到这些我真的直接吐血

改造流程

校验方式

这个 if 校验看得我哪哪都不爽。好歹给我写一个断言吧。Assert.notNull(userVo.getUsername(), "用户名不能为空");
这不香吗？确实不香。
使用 spring 提供的@Valid

在入参时使用@Valid注解，并且在 vo 中使用校验注解，如AuthLoginReqVO

1. @ApiModel(value = "管理后台 - 账号密码登录 Request VO")
2. @Data
3. @NoArgsConstructor
4. @AllArgsConstructor
5. @Builder
6. public class AuthLoginReqVO {
8.     @ApiModelProperty(value = "账号", required = true, example = "user")
9.     @NotEmpty(message = "登录账号不能为空")
10.     @Length(min = 4, max = 16, message = "账号长度为 4-16 位")
11.     @Pattern(regexp = "^[A-Za-z0-9]+$", message = "账号格式为数字以及字母")
12.     private String username;
14.     @ApiModelProperty(value = "密码", required = true, example = "password")
15.     @NotEmpty(message = "密码不能为空")
16.     @Length(min = 4, max = 16, message = "密码长度为 4-16 位")
17.     private String password;
19. }

复制代码

@Valid

在SpringBoot中，@Valid是一个非常有用的注解，重要用于数据校验。以下是关于@Valid的一些详细信息：

• 为什么使用 @Valid 来验证参数：在编写接口时，我们经常须要验证请求参数。通常，我们大概会写大量的 if 和 if else 代码来举行判断。但如许的代码不仅不优雅，而且假如存在大量的验证逻辑，这会使代码看起来杂乱，大大低落代码可读性。为了简化这个过程，我们可以使用 @Valid 注解来资助我们简化验证逻辑。
  
• @Valid 注解的作用：@Valid 的重要作用是用于数据效验，可以在定义的实体中的属性上，添加不同的注解来完成不同的校验规则，而在接口类中的接收数据参数中添加 @valid 注解，这时你的实体将会开启一个校验的功能。
  
• @Valid 的相关注解：在实体类中不同的属性上添加不同的注解，就能实现不同数据的效验功能。
  
• 使用 @Valid 举行参数效验步骤：整个过程如下，用户访问接口，然后举行参数效验，因为 @Valid 不支持平面的参数效验（直接写在参数中字段的效验）所以基于 GET 请求的参数照旧按照原先方式举行效验，而 POST 则可以以实体对象为参数，可以使用 @Valid 方式举行效验。假如效验通过，则进入业务逻辑，否则抛出异常，交由全局异常处理器举行处理。
  
• @Validated与@Valid的区别：@Validated 是 @Valid 的���体。通过声明实体中属性的 groups ，再搭配使用 @Validated ，就能决定哪些属性须要校验，哪些不须要校验。
  

全局异常处理

这个全局异常处理，可以根据自己的异常，自定义异常处理，并设置一个兜底的异常处理

1. @ResponseBody
2. @RestControllerAdvice
3. public class ExceptionHandlerAdvice {
4.     protected Logger logger = LoggerFactory.getLogger(getClass());
6.     @ExceptionHandler(MethodArgumentNotValidException.class)
7.     public CommonResult<Object> handleValidationExceptions(MethodArgumentNotValidException ex) {
8.         logger.error("[handleValidationExceptions]", ex);
9.         StringBuilder sb = new StringBuilder();
10.         ex.getBindingResult().getAllErrors().forEach(error -> {
11.             String fieldName = ((org.springframework.validation.FieldError) error).getField();
12.             String errorMessage = error.getDefaultMessage();
13.             sb.append(fieldName).append(":").append(errorMessage).append(";");
14.         });
15.         return CommonResult.error(sb.toString());
16.     }
18.     /**
19.      * 处理系统异常，兜底处理所有的一切
20.      */
21.     @ExceptionHandler(value = Exception.class)
22.     public CommonResult<?> defaultExceptionHandler(Throwable ex) {
23.         logger.error("[defaultExceptionHandler]", ex);
24.         // 返回 ERROR CommonResult
25.         return CommonResult.error(INTERNAL_SERVER_ERROR.getCode(), INTERNAL_SERVER_ERROR.getMsg());
26.     }
28. }

复制代码

就这么多，搞定，如许就拥有了漂泊优雅的 controller 了

在日常开辟中，另有那些血压飙升刹时

我拿出下图阁下如何面对

这个阁下又如何面对，我不说，你能知道这个什么吗【狗头】

总结

• 不是很明白为什么有些喜好在 controller 写业务逻辑的，曾经有个同事问我（就是喜好在 controller 写业务的），你这个接口写在那里，我须要调一下你这个接口。我满脸问号？？不是隔壁的模块吗，为什么要调我的接口？直接引用的我的 service 去调方法就好了。
  
• 这个就是痛点，各写各的，冗余代码一堆。
  
• 曾经看到一个同事写一个生存的方法，虽然逻辑挺多，我滑动了好久都还没有方法还没有竣事。一个方法整整几百行……
  
• 看过 spring 源码都知道，spring 源码难啃，就是因为 spring 无限往下套娃，根本每个方法干每个方法的事变。比如我生存用户时，就只是生存用户，至于什么校验丢给校验的方法处理，什么发送消息丢给发送消息处理，这些就不能耦合在一起。
  
• 对于看到一些 if 下面一丢逻辑，然后 if 再一丢逻辑，看代码时很多情况不须要知道这个逻辑怎么实现的，知道入参出参就大概这里做什么了。纵然想知道详细情况点进去就知道了。突出这个当火线法要做的事变就好了。
  
• 阿里的开辟手册就推荐一个方法不能超过 80 行，超过可以根据业务详细调整一下。在公众号Java核心技能回复手册可以获取最新完备高清版。
  

更多文章推荐：
1.Spring Boot 3.x 教程，太全了！
2.2,000+ 道 Java口试题及答案整理(2024最新版)
3.免费获取 IDEA 激活码的 7 种方式（2024最新版）
以为不错，别忘了随手点赞+转发哦！

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。