Spring Boot專案傳參校驗的方法-java教程-PHP中文網

Spring Boot專案傳參校驗的方法

PHPz

發布： 2023-05-15 13:58:17

轉載

1640 人瀏覽過

場景還原

簡單業務場景模擬：

假如你現在在做一個成績輸入系統，你愉快地用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分，介面回傳結果會提示出錯誤詳情：

Spring Boot專案傳參校驗的方法

當然，關於這個事情的原理，既然用到了註解，無非用的也就是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專案傳參校驗的方法