Spring Boot專案傳參校驗的最佳實踐指南

2022-04-05 13:00:30

場景還原

簡單業務場景模擬：

假如你現在在做一個成績錄入系統，你愉快地用Spring Boot框架寫了一個後臺介面，用於接收前臺瀏覽器傳過來的 Student物件，並插入後臺資料庫。

我們將傳入的 Student物件定義為：

public class Student {
    private String name;    // 姓名
    private Integer score;  // 考試分數（滿分100分）
    private String mobile;  // 電話號碼（11位）
}

然後寫一個Post請求的後臺介面，來接收網頁端傳過來的 Student物件：

@RestController
public class TestController {

    @Autowired
    private StudentService studentService;

    @PostMapping("/add")
    public String addStudent( @RequestBody Student student ) {
        studentService.addStudent( student ); // 將student物件存入資料庫
        return "SUCCESS";
    }
}

此時我想你一定看出來了上面這段程式碼的漏洞，因為我們並沒有對傳入的 Student物件做任何資料校驗，比如：

Student物件裡三個欄位的某一個忘傳了，為 null怎麼辦？Student的 score分數，假如寫錯了，寫成 101分怎麼辦？Student的 mobile11位手機號碼，假如填錯了，多寫了一位怎麼辦？...等等

這些資料雖然在前端頁面一般會做校驗，但我們作為一個嚴謹且良心的後端開發工程師，我們肯定要對傳入的每一項資料做嚴格的校驗，所以我們應該怎麼寫？

@PostMapping("/add")
public String addStudent( @RequestBody Student student ) {
    if( student == null )
        return "傳入的Student物件為null，請傳值";
    if( student.getName()==null || "".equals(student.getName()) )
        return "傳入的學生姓名為空，請傳值";
    if( student.getScore()==null )
        return "傳入的學生成績為null，請傳值";
    if( (student.getScore()<0) || (student.getScore()>100) )
        return "傳入的學生成績有誤，分數應該在0~100之間";
    if( student.getMobile()==null || "".equals(student.getMobile()) )
        return "傳入的學生電話號碼為空，請傳值";
    if( student.getMobile().length()!=11 )
        return "傳入的學生電話號碼長度有誤，應為11位";
    studentService.addStudent( student ); // 將student物件存入MySQL資料庫
    return "SUCCESS";
}

寫是寫完了，就是感覺手有點酸，並且心有點累，這個 Student物件倒還好，畢竟內部僅3個欄位，假如一個複雜的物件有30個欄位怎麼辦？簡直不敢想象！

神註解加持

其實Spring框架很早版本開始，就通過註解的方式，來方便地為我們提供了各項互動資料的校驗工作，比如上面的例子，我們只需要在傳入的 Student實體類的欄位中加入對應註解即可方便的解決問題：

public class Student {
    @NotNull(message = "傳入的姓名為null，請傳值")
    @NotEmpty(message = "傳入的姓名為空字串，請傳值")
    private String name;    // 姓名

    @NotNull(message = "傳入的分數為null，請傳值")
    @Min(value = 0,message = "傳入的學生成績有誤，分數應該在0~100之間")
    @Max(value = 100,message = "傳入的學生成績有誤，分數應該在0~100之間")
    private Integer score;  // 分數

    @NotNull(message = "傳入的電話為null，請傳值")
    @NotEmpty(message = "傳入的電話為空字串，請傳值")
    @Length(min = 11, max = 11, message = "傳入的電話號碼長度有誤，必須為11位")
    private String mobile;  // 電話號碼
}

當然，於此同時，我們還需要在物件入口處，加上註解 @Valid來開啟對傳入 Student物件的驗證工作：

@PostMapping("/add")
public String addStudent( @RequestBody  @Valid Student student ) {
    // 棒棒噠！原先各種繁雜的引數校驗工作統統都省了！一行程式碼不用寫
    studentService.addStudent( student ); // 將student物件存入MySQL資料庫
    return "SUCCESS";
}

這時候，如果某個欄位傳入錯誤，比如我傳資料的時候，將學生的成績誤傳為 101分，則介面返回結果便會提示出錯誤詳情：

當然，關於這個事情的原理，既然用到了註解，無非用的也就是Java裡的各種反射等知識來實現的，感興趣的小夥伴可以藉此機會研究一下！

資料異常統一攔截

上面利用註解的方式做統一資料校驗感覺十分美好，但唯一美中不足的就是返回的結果太過繁雜，不一定使我們需要的格式，我們需要做統一處理，比如：我只想將具體引數校驗的錯誤提示資訊給摳出來返回給前端即可。

為此，我們為專案設定全域性統一異常攔截器來格式化所有資料校驗的返回結果。

@ControllerAdvice
@ResponseBody
public class GlobalExceptionInterceptor {
  @ExceptionHandler(value = Exception.class)
  public String exceptionHandler(HttpServletRequest request, Exception e) {
    String failMsg = null;
    if (e instanceof MethodArgumentNotValidException) {
      // 拿到引數校驗具體異常資訊提示
      failMsg = ((MethodArgumentNotValidException) e).getBindingResult().getFieldError().getDefaultMessage();
    }
    return failMsg; // 直接吐回給前端
  }
}

如上面程式碼所示，我們全域性統一攔截了引數校驗異常 MethodArgumentNotValidException，並僅僅只拿到對應異常的詳細 Message資訊吐給前端，此時返回給前端的資料就清楚得多：

可以的，非常優雅！

總結

到此這篇關於Spring Boot專案傳參校驗的文章就介紹到這了,更多相關SpringBoot專案傳參校驗內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！

Spring Boot專案傳參校驗的最佳實踐指南

目錄

場景還原

神註解加持

資料異常統一攔截

總結

熱門文章