五個步驟，助你優雅的寫好 Controller 層代碼！

Java精選面試題（微信小程序）：5000+道面試題和選擇題，真實面經，簡歷模版，包含Java基礎、并發、JVM、線程、MQ系列、Redis、Spring系列、Elasticsearch、Docker、K8s、Flink、Spark、架構設計、大廠真題等，在線隨時刷題！

Controller 層邏輯

MVC架構下，我們的web工程結構會分為三層，自下而上是dao層，service層和controller層。controller層為控制層，主要處理外部請求，調用service層。

一般情況下，controller層不應該包含業務邏輯，controller的功能應該有以下五點：

⑴、接收請求并解析參數

⑵、業務邏輯執行成功做出響應

⑶、異常處理

⑷、轉換業務對象

⑸、調用 Service 接口

普通寫法

@RestController publicclass TestController {     @Autowired     private UserService userService;     @PostMapping("/test") public Result service(@Validated  @RequesBody  UserRequestBo requestBo) throws Exception {         Result result = new Result();         // 參數校驗         if (StringUtils.isNotEmpty(requestBo.getId())                 || StringUtils.isNotEmpty(requestBo.getType())                 || StringUtils.isNotEmpty(requestBo.getName())                 || StringUtils.isNotEmpty(requestBo.getAge())) {             thrownew Exception("必輸項校驗失敗");         } else {             // 調用service更新user，更新可能拋出異常，要捕獲             try {                 int count = 0;                 User user = userService.queryUser(requestBo.getId());                 if (ObjectUtils.isEmpty(user)) {                     result.setCode("11111111111");                     result.setMessage("請求失敗");                     return result;                 }                 // 轉換業務對象                 UserDTO userDTO = new UserDTO();                 BeanUtils.copyProperties(requestBo, userDTO);                 if ("02".equals(user.getType())) {// 退回修改的更新                     count = userService.updateUser(userDTO)                 }elseif ("03".equals(user.getType())) {// 已生效狀態，新增一條待復核                     count = userService.addUser(userDTO);                 }                 // 組裝返回對象                 result.setData(count);                 result.setCode("00000000");                 result.setMessage("請求成功");             } catch (Exception ex) {                 // 異常處理                 result.setCode("111111111111");                 result.setMessage("請求失敗");             }         }         return result;     } }

一般情況下，controller作為控制層調用service層接口，不應該包含任何業務邏輯，所有的業務操作，都放在service層實現，把controller層相關代碼去掉

controller層就變成了：

@RestController publicclass TestController { @Autowired private UserService userService; @PostMapping("/test") public Result service(@Validated  @RequesBody  UserRequestBo requestBo) throws Exception {     Result result = new Result();     // 參數校驗     if (StringUtils.isNotEmpty(requestBo.getId())             || StringUtils.isNotEmpty(requestBo.getType())             || StringUtils.isNotEmpty(requestBo.getName())             || StringUtils.isNotEmpty(requestBo.getAge())) {         thrownew Exception("必輸項校驗失敗");     } else {         // 調用service更新user，更新可能拋出異常，要捕獲         try {          // 轉換業務對象             UserDTO userDTO = new UserDTO();             BeanUtils.copyProperties(requestBo, userDTO);             int count = userService.updateUser(userDTO);             // 組裝返回對象             result.setData(count);             result.setCode("00000000");             result.setMessage("請求成功");         } catch (Exception ex) {             // 異常處理             result.setCode("EEEEEEEE");             result.setMessage("請求失敗");         }     }     return result; }

其實大多數的參數校驗就是判空或者空字符串，那么我們可以用@NotBlank等注解。在UserRequestBo類中name屬性上加上@NotBlank注解。另外，推薦公眾號Java精選，回復java面試，獲取在線面試資料，支持在線隨時隨地刷題。

優化后如下：

@Data public class UserRequestBo {     @NotBlank     private String id;     @NotBlank     private String type;     @NotBlank     private String name;     @NotBlank     private String age; }

controller層就變成了：

@RestController publicclass TestController {     @Autowired     private UserService userService;     @PostMapping("/test")     public Result service( @Validated  @RequesBody  UserRequestBo requestBo) throws Exception {         Result result = new Result();         // 調用service更新user，更新可能拋出異常，要捕獲         try {          // 轉換業務對象             UserDTO userDTO = new UserDTO();             BeanUtils.copyProperties(requestBo, userDTO);             int count = userService.updateUser(userDTO);             // 組裝返回對象             result.setData(count);             result.setCode("00000000");             result.setMessage("請求成功");         } catch (Exception ex) {             // 異常處理             result.setCode("EEEEEEEE");             result.setMessage("請求失敗");         }         return result;     } }

備注：@NotNull、@NotBlank、@NotEmpty的區別，也適用于代碼中的校驗方法

• @NotNull：平常用于基本數據的包裝類(Integer，Long，Double等等)，如果@NotNull 注解被使用在 String 類型的數據上，則表示該數據不能為 Null，但是可以為空字符串(“”)，空格字符串（“ ”）等。

• @NotEmpty：平常用于 String、Collection集合、Map、數組等等，@NotEmpty注解的參數不能為 Null 或者 長度為 0，如果用在String類型上，則字符串也不能為空字符串(“”), 但是空格字符串（“ ”）不會被校驗住。

• @NotBlank：平常用于 String 類型的數據上，加了@NotBlank注解的參數不能為 Null ，不能為空字符串(“”), 也不能會空格字符串（“ ”），多了一個trim()得到效果。

代碼中無論是業務成功或者失敗，都需要封裝返回對象，目前代碼中都是哪里用到就在哪里進行封裝

我們可以統一封裝返回對象

優化后如下：

@Data publicclass Result

  {     private String code;     private String message;     private T data; // 請求成功，指定data     publicstatic    Result   success(T data) {         returnnew Result<>(ResultEnum.SUCCESS.getCode(), ResultEnum.SUCCESS.getMessage(), data);     }      // 請求成功，指定data和指定message     publicstatic    Result   success(String message, T data) {         returnnew Result<>(ResultEnum.SUCCESS.getCode(), message, data);     }      // 請求失敗     publicstatic Result failed() {         returnnew Result<>(ResultEnum.COMMON_FAILED.getCode(), ResultEnum.COMMON_FAILED.getMessage(), null);     }      // 請求失敗，指定message     publicstatic Result failed(String message) {         returnnew Result<>(ResultEnum.COMMON_FAILED.getCode(), message, null);     }          // 請求失敗，指定code和message     publicstatic Result failed(String code, String message) {         returnnew Result<>(code, message, null);     } }

controller層就變成了：

@RestController publicclass TestController {     @Autowired     private UserService userService;     @PostMapping("/test")     public Result service(@Validated  @RequesBody  UserRequestBo requestBo) throws Exception {         // 調用service更新user，更新可能拋出異常，要捕獲         try {          // 轉換業務對象             UserDTO userDTO = new UserDTO();             BeanUtils.copyProperties(requestBo, userDTO);             int count = userService.updateUser(userDTO);             // 組裝返回對象             Result.success(count);         } catch (Exception ex) {             // 異常處理             Result.failed(ex.getMessage());         }     } } 

Controller層和service存在大量的try-catch，都是重復代碼并且看起來也不優雅?？梢越ocontroller層的方法加上切面來統一處理異常。

用@ControllerAdvice注解(@RestControllerAdvice也可以)，用來定義controller層的切面，添加@Controller注解的類中的方法執行都會進入該切面，同時我們可以使用@ExceptionHandler來對不同的異常進行捕獲和處理，對于捕獲的異常，我們可以進行日志記錄，并且封裝返回對象。

優化后如下：

// @RestControllerAdvice(basePackages = "com.ruoyi.web.controller.demo.test"), 指定包路徑進行切面 // @RestControllerAdvice(basePackageClasses = TestController.class) , 指定Contrller.class進行切面 // @RestControllerAdvice 不帶參數默認覆蓋所有添加@Controller注解的類 @RestControllerAdvice(basePackageClasses = TestController.class) public class TestControllerAdvice {     @Autowired     HttpServletRequest httpServletRequest;     private void logErrorRequest(Exception e){         // 組裝日志內容         String logInfo = String.format("報錯API URL: %S, error = ", httpServletRequest.getRequestURI(), e.getMessage());         // 打印日志         System.out.println(logInfo);     }     /**      * {@code @RequestBody} 參數校驗不通過時拋出的異常處理      */     @ExceptionHandler({MethodArgumentNotValidException.class})     public Result handleMethodArgumentNotValidException(MethodArgumentNotValidException ex) {         // 打印日志         logErrorRequest(ex);         // 組織異常信息，可能存在多個參數校驗失敗         BindingResult bindingResult = ex.getBindingResult();         StringBuilder sb = new StringBuilder("校驗失敗:");         for (FieldError fieldError : bindingResult.getFieldErrors()) {        sb.append(fieldError.getField()).append("：").append(fieldError.getDefaultMessage()).append(", ");         }         return Result.failed(ResultEnum.VALIDATE_FAILED.getCode(), sb.toString());     }     /**      * 業務層異常，如果項目中有自定義異常則使用自定義業務異常，如果沒有，可以和其他異常一起處理      *      * @param exception      * @return      */     @ExceptionHandler(RuntimeException.class)     protected Result serviceException(RuntimeException exception) {         logErrorRequest(exception);         return Result.failed(exception.getMessage());     }     /**      * 其他異常      *      * @param exception      * @return      */     @ExceptionHandler({HttpClientErrorException.class, IOException.class, Exception.class})     protected Result serviceException(Exception exception) {         logErrorRequest(exception);         return Result.failed(exception.getMessage());     } }

controller層就變成了：

@RestController publicclass TestController {     @Autowired     private UserService userService;     @PostMapping("/test")     public Result service( @Validated  @RequesBody  UserRequestBo requestBo) throws Exception {         UserDTO userDTO = new UserDTO();         BeanUtils.copyProperties(requestBo, userDTO);         // 調用service層接口         int count = userService.updateUser(userDTO);         //組裝返回對象         return Result.success(count);     } }

代碼中可能有很多個地方轉換同一個業務對象，入參UserRequestBo可以轉換為userDTO，可以理解為這是UserRequestBo的一個特性或者能力，我們可以參考充血模式的思想，在UserRequestBo中定義convertToUserDTO方法，我們的目的是轉換業務對象，至于使用什么方式轉換，調用方并不關心，現在使用的BeanUtils.copyProperties()，如果有一天想修改成使用Mapstruct來進行對象轉換，只需要修改UserRequestBo的convertToUserDTO方法即可，不會涉及到業務代碼的修改。

優化后代碼：

@Data publicclass UserRequestBo {     @NotBlank     private String id;     @NotBlank     private String type;     @NotBlank     private String name;     @NotBlank     private String age;     /**      * UserRequestBo對象為UserDTO      * */     public UserDTO convertToUserDTO(){         UserDTO userDTO = new UserDTO();         // BeanUtils.copyProperties要求字段名和字段類型都要保持一致，如果有不一樣的字段，需要單獨set         BeanUtils.copyProperties(this, userDTO);         userDTO.setType(this.getType());         return userDTO;     } }

controller層就變成了：

@RestController public class TestController {     @Autowired     private UserService userService;     @PostMapping("/test")     public Result service(@Validated  @RequesBody  UserRequestBo requestBo) throws Exception {         return Result.success(userService.updateUser(requestBo.convertToUserDTO()));     } }

優化結束，打完收工。

作者：桃花影落丶飛神劍

https://blog.csdn.net/weixin_44271364/article/details/129157011

公眾號“Java精選”所發表內容注明來源的，版權歸原出處所有（無法查證版權的或者未注明出處的均來自網絡，系轉載，轉載的目的在于傳遞更多信息，版權屬于原作者。如有侵權，請聯系，筆者會第一時間刪除處理！

最近有很多人問，有沒有讀者交流群！加入方式很簡單，公眾號Java精選，回復“加群”，即可入群！

文章有幫助的話，點在看，轉發吧！