SpringMVC參數校驗

使用SpringMVC時配合hibernate-validate進行參數的合法性校驗，能節省一定的代碼量。

 

1.搭建Web工程並引入hibernate-validate依賴

 

<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.0.7.Final</version>
</dependency> 

 

Maven依賴傳遞，自動依賴validation-api、jboss-logging、classmate。

 

 

2.使用校驗注解標注在屬性上(DTO)

 

 

 

*每個注解都有message屬性，該屬性用於填寫校驗失敗時的異常描述信息，當校驗失敗時可以獲取對應的message屬性值。

 

按 Ctrl+C 復制代碼

按 Ctrl+C 復制代碼

 

 

3.控制層中使用DTO接收參數並使用@Validated/@Valid注解開啟對參數的校驗

　

*@Validated注解表示開啟Spring的校驗機制，支持分組校驗,聲明在入參上。

*@Valid注解表示開啟Hibernate的校驗機制，不支持分組校驗,聲明在入參上。

*在DTO后面緊跟BindingResult對象，那么當參數不符合時，能通過該對象直接獲取不符合校驗的message描述信息。

*若使用了@Validated/@Valid注解開啟校驗，但DTO后面沒有緊跟BindingResult對象，那么當參數不符合時，將直接返回400 Bad Request狀態碼。 

 

按 Ctrl+C 復制代碼

按 Ctrl+C 復制代碼

 

演示：

 

 結果：

密碼不能為空!
id不能為空!
用戶名的長度在4~12之間!

 

*校驗的順序是隨機的，因此程序不能依賴校驗的順序去做相關的邏輯處理。

 

 

4.分組校驗

 

每個校驗注解都有group屬性用於指定校驗所屬的組，其值是Class數組，在Controller中使用@Validated注解開啟對參數的校驗時若指定要進行校驗的組，那么只有組相同的屬性才會被進行校驗(默認全匹配)

Class<?>[] groups() default { };

 

一般定義標識接口作為組資源

public interface GroupA {

}

public interface GroupB {

}

 

使用校驗注解標注在屬性上並進行分組

public class User {

    @NotNull(message="id不能為空!",groups = {GroupA.class})
    private Integer id;
    
    @NotBlank(message="用戶名不能為空!",groups = {GroupB.class})
    @Size(min=4,max=12,message="用戶名的長度在4~12之間!")
    private String username;

    @NotBlank(message="密碼不能為空!")
    private String password;
    
    @Email(message="非法郵箱!")
    private String email;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    public User() {
        super();
    }

}

 

 Controller中使用@Validated注解開啟對參數的校驗並指定校驗的組，那么只有組相同的屬性才會被進行校驗(默認全匹配)

@RestController
public class BaseController {

    @RequestMapping("/test")
    public User test(@Validated(value= {GroupB.class}) User user, BindingResult result) {
        if (result.hasErrors()) {
            List<ObjectError> errors = result.getAllErrors();
            for (ObjectError error : errors) {
                System.out.println(error.getDefaultMessage());
            }
        }
        return user;
    }

}

 

演示：

 

結果：

用戶名不能為空!

 

*后端一般只返回重名等錯誤描述信息，對於非空、字符長度、手機郵箱合法性校驗等由前端進行判斷並提示，后端校驗不通過時不返回錯誤描述信息，所以不需要使用BindingResult獲取錯誤描述，當參數不符合時直接返回400 Bad Request請求。