【禁止血壓飆升】阿裡大佬寫的 Controller 太優雅了!

来源:https://www.cnblogs.com/javastack/p/18343185
-Advertisement-
Play Games

作者:小塵 鏈接:https://juejin.cn/post/7357172505961578511 前言 見過幾千行代碼的 controller嗎?我見過。 見過全是 try catch 的 controller 嗎,我見過。 見過全是欄位校驗的 controller 嗎,我見過。 見過全是業務 ...


作者:小塵
鏈接:https://juejin.cn/post/7357172505961578511

前言

見過幾千行代碼的 controller嗎?我見過。

見過全是 try catch 的 controller 嗎,我見過。

見過全是欄位校驗的 controller 嗎,我見過。

見過全是業務代碼的 controller 嗎?不好意思,我們公司很多業務寫在 controller 的。

看見這些我真的血壓高。

正文

不優雅的 controller

@RestController
@RequestMapping("/user/test")
public class UserController {

    private static Logger logger = LoggerFactory.getLogger(UserController.class);

    @Autowired
    private UserService userService;

    @Autowired
    private AuthService authService;

    @PostMapping
    public CommonResult userRegistration(@RequestBody UserVo userVo) {
        if (StringUtils.isBlank(userVo.getUsername())){
            return CommonResult.error("用戶名不能為空");
        }
        if (StringUtils.isBlank(userVo.getPassword())){
            return CommonResult.error("密碼不能為空");
        }
        logger.info("註冊用戶:{}" , userVo.getUsername());
        try {
            userService.registerUser(userVo.getUsername());
            return CommonResult.ok();
        }catch (Exception e){
            logger.error("註冊用戶失敗:{}", userVo.getUsername(), e);
            return CommonResult.error("註冊失敗");
        }
    }

    @PostMapping("/login")
    @PermitAll
    @ApiOperation("使用賬號密碼登錄")
    public CommonResult<AuthLoginRespVO> login(@RequestBody AuthLoginReqVO reqVO) {
        if (StringUtils.isBlank(reqVO.getUsername())){
            return CommonResult.error("用戶名不能為空");
        }
        if (StringUtils.isBlank(reqVO.getPassword())){
            return CommonResult.error("密碼不能為空");
        }
        try {
            return success(authService.login(reqVO));
        }catch (Exception e){
            logger.error("註冊用戶失敗:{}", reqVO.getUsername(), e);
            return CommonResult.error("註冊失敗");
        }
    }

}

Spring Boot 基礎就不介紹了,推薦看這個實戰項目:

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

優雅的controller

@RestController
@RequestMapping("/user/test")
public class UserController1 {

    private static Logger logger = LoggerFactory.getLogger(UserController1.class);

    @Autowired
    private UserService userService;

    @Autowired
    private AuthService authService;

    @PostMapping("/userRegistration")
    public CommonResult userRegistration(@RequestBody @Valid UserVo userVo) {
        userService.registerUser(userVo.getUsername());
        return CommonResult.ok();
    }

    @PostMapping("/login")
    @PermitAll
    @ApiOperation("使用賬號密碼登錄")
    public CommonResult<AuthLoginRespVO> login(@RequestBody @Valid AuthLoginReqVO reqVO) {
        return success(authService.login(reqVO));
    }

}

代碼量直接減一半呀,這還不算上有些直接把業務邏輯寫在 controller 的,看到這些我真的直接吐血

改造流程

校驗方式

這個 if 校驗看得我哪哪都不爽。好歹給我寫一個斷言吧。Assert.notNull(userVo.getUsername(), "用戶名不能為空");

這不香嗎?確實不香。

使用 spring 提供的@Valid

在入參時使用@Valid註解,並且在 vo 中使用校驗註解,如AuthLoginReqVO

@ApiModel(value = "管理後臺 - 賬號密碼登錄 Request VO")
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class AuthLoginReqVO {

    @ApiModelProperty(value = "賬號", required = true, example = "user")
    @NotEmpty(message = "登錄賬號不能為空")
    @Length(min = 4, max = 16, message = "賬號長度為 4-16 位")
    @Pattern(regexp = "^[A-Za-z0-9]+$", message = "賬號格式為數字以及字母")
    private String username;

    @ApiModelProperty(value = "密碼", required = true, example = "password")
    @NotEmpty(message = "密碼不能為空")
    @Length(min = 4, max = 16, message = "密碼長度為 4-16 位")
    private String password;

}

@Valid

在SpringBoot中,@Valid是一個非常有用的註解,主要用於數據校驗。以下是關於@Valid的一些詳細信息:

  1. 為什麼使用 @Valid 來驗證參數:在編寫介面時,我們經常需要驗證請求參數。通常,我們可能會寫大量的 if 和 if else 代碼來進行判斷。但這樣的代碼不僅不優雅,而且如果存在大量的驗證邏輯,這會使代碼看起來混亂,大大降低代碼可讀性。為了簡化這個過程,我們可以使用 @Valid 註解來幫助我們簡化驗證邏輯。
  2. @Valid 註解的作用:@Valid 的主要作用是用於數據效驗,可以在定義的實體中的屬性上,添加不同的註解來完成不同的校驗規則,而在介面類中的接收數據參數中添加 @valid 註解,這時你的實體將會開啟一個校驗的功能。
  3. @Valid 的相關註解:在實體類中不同的屬性上添加不同的註解,就能實現不同數據的效驗功能。
  4. 使用 @Valid 進行參數效驗步驟:整個過程如下,用戶訪問介面,然後進行參數效驗,因為 @Valid 不支持平面的參數效驗(直接寫在參數中欄位的效驗)所以基於 GET 請求的參數還是按照原先方式進行效驗,而 POST 則可以以實體對象為參數,可以使用 @Valid 方式進行效驗。如果效驗通過,則進入業務邏輯,否則拋出異常,交由全局異常處理器進行處理。
  5. @Validated與@Valid的區別@Validated@Valid 的���體。通過聲明實體中屬性的 groups ,再搭配使用 @Validated ,就能決定哪些屬性需要校驗,哪些不需要校驗。

全局異常處理

這個全局異常處理,可以根據自己的異常,自定義異常處理,並設置一個兜底的異常處理

@ResponseBody
@RestControllerAdvice
public class ExceptionHandlerAdvice {
    protected Logger logger = LoggerFactory.getLogger(getClass());

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public CommonResult<Object> handleValidationExceptions(MethodArgumentNotValidException ex) {
        logger.error("[handleValidationExceptions]", ex);
        StringBuilder sb = new StringBuilder();
        ex.getBindingResult().getAllErrors().forEach(error -> {
            String fieldName = ((org.springframework.validation.FieldError) error).getField();
            String errorMessage = error.getDefaultMessage();
            sb.append(fieldName).append(":").append(errorMessage).append(";");
        });
        return CommonResult.error(sb.toString());
    }

    /**
     * 處理系統異常,兜底處理所有的一切
     */
    @ExceptionHandler(value = Exception.class)
    public CommonResult<?> defaultExceptionHandler(Throwable ex) {
        logger.error("[defaultExceptionHandler]", ex);
        // 返回 ERROR CommonResult
        return CommonResult.error(INTERNAL_SERVER_ERROR.getCode(), INTERNAL_SERVER_ERROR.getMsg());
    }

}

就這麼多,搞定,這樣就擁有了漂流優雅的 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最新版)

覺得不錯,別忘了隨手點贊+轉發哦!


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • # 字元串長度 - strlen() 描述 C 庫函數 size_t strlen(const char *str) 計算字元串 str 的長度,直到空結束字元,但不包括空結束字元。 聲明 下麵是 strlen() 函數的聲明。 size_t strlen(const char *str) 參數 s ...
  • P1223 排隊接水 題目描述 有 \(n\) 個人在一個水龍頭前排隊接水,假如每個人接水的時間為 \(T_i\),請編程找出這 \(n\) 個人排隊的一種順序,使得 \(n\) 個人的平均等待時間最小。 輸入格式 第一行為一個整數 \(n\)。 第二行 \(n\) 個整數,第 \(i\) 個整數 ...
  • 將Word文檔以圖片形式導出,既能方便信息的分享,也能保護數據安全,避免被二次編輯。文本將介紹如何使用 Spire.Doc for Python 庫在Python程式中實現Word到圖片的批量轉換。 Python 將Word轉換為JPG、JPEG、PNG、BMP等圖片格式 Python 將Word文 ...
  • 安裝Nginx並配置訪問 安裝PHP並輸出腳本結果 配置typecho Nginx安裝並驗證 apt install nginx systemctl start nginx 正常情況應該可以看到Nginx的歡迎頁面了,如果看不到就是防火牆的問題,設置下防火牆放通即可。 安裝PHP並使用Nginx代理 ...
  • 堆(Heap)的基本概念 堆是一種完全二叉樹(Complete Binary Tree),其性質使得堆可以高效地支持以下操作: 插入(Insert):將一個新元素加入到堆中。 刪除最大/最小元素(Delete Max/Min):移除並返回堆中的最大(大根堆)或最小(小根堆)元素。 獲取最大/最小元素 ...
  • 節點結構體設計 struct LinkNode { // 數據域 void* data; // 指針域 struct LinkNode * next; }; data:一個 void* 類型的指針,指向節點存儲的數據。使用 void* 是為了鏈表能夠存儲不同類型的數據。 next:一個指向下一個 L ...
  • strcat 描述 char *strcat(char *dest, const char *src) 把 src 所指向的字元串追加到 dest 所指向的字元串的結尾。 聲明 下麵是 strcat() 函數的聲明。 char *strcat(char *dest, const char *src) ...
  • Java RMI(Remote Method Invocation)是一種允許Java虛擬機之間進行通信和交互的技術。它使得遠程Java對象能夠像本地對象一樣被訪問和操作,從而簡化了分散式應用程式的開發。一些應用依然會使用 RMI 來實現通信和交互,今天的內容我們來聊聊 RMI 的那些事兒。 一、先 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...