使用註解@Validated和BindingResult對入參進行非空校驗方式

Posted on by

註解@Validated和BindingResult對入參非空校驗

在項目當中少不瞭入參校驗，服務器和瀏覽器互不信任，不能因為前端加入參判斷瞭後臺就不處理瞭，這樣是不對的。

比如前臺傳過來一個對象作為入參參數，這個對象中有些屬性允許為空，有些屬性不允許為空。那麼你還在使用if()else{}進行非空判斷嗎？不妨嘗試下使用註解，可以使用@Validated和BindingResult。

註意：BindingResult需要放到@Validated後面

示例代碼如下：普通屬性可以用@NotEmpty() 特殊的使用@NotNull() 比如：枚舉類型

實體類：什麼不允許為空就加

@NotEmpty(groups = {SchoolDTO.SchoolGroup.class},message = "學校名不能為空")

註意：重要的事情叮囑兩遍。public interface SchoolGroup{} 別忘瞭加這個！public interface SchoolGroup{} 別忘瞭加這個！

public class SchoolDTO implements Serializable { 
    private Long id;
    @NotEmpty(groups = {SchoolDTO.SchoolGroup.class},message = "學校名不能為空")
    private String schoolName;
 
    @NotNull
    @NotEmpty(groups = {SchoolDTO.SchoolGroup.class},message = "學校負責人不能為空")
    private String schoolPrincipal;
 
    @NotNull
    @NotEmpty(groups = {SchoolDTO.SchoolGroup.class},message = "職務不能為空")
    private String principalPosition;
 
    @NotNull
    @NotEmpty(groups = {SchoolDTO.SchoolGroup.class},message = "聯系電話不能為空")
    private String schoolPhone; 
    //getter setter tostring 省略
    public interface SchoolGroup{}  別忘瞭加這個
}

控制層：在入參對象上加@Validated({SchoolDTO.SchoolGroup.class}), BindingResult bindingResult @Validated進行驗證，BindingResult可以獲取校驗錯誤信息

  @PostMapping("/schools")
    @PreAuthorize("hasRole(\"" + AuthoritiesConstants.ADMIN + "\")")
    public Map<String,Object> createSchool(@RequestBody @Validated({SchoolDTO.SchoolGroup.class}) SchoolDTO schoolDTO,BindingResult bindingResult) throws Exception {
      //返回校驗錯誤信息
        Map<String,Object>map=new HashMap<>();
        if(bindingResult.hasErrors()){
            map.put("success","false");
            map.put("message",bindingResult.getAllErrors());
            return map;
        }
        // .........業務省略 
            return map;
        }
    }

測試：入參的時候我沒有傳principalPosition和schoolPhone

@Validated 和 BindingResult 使用遇到的坑

@Validated 與BindingResult 需要相鄰，否則 變量result 不能接受錯誤信息

控制臺輸出

Field error in object ‘entity’ on field ‘變量’: rejected value [null]; codes [NotNull.entity.變量,NotNull.變量,NotNull.java.lang.String,NotNull]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes

正確的內容截圖

在這裡插入圖片描述

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：