Spring Boot集成validation用於優雅的校驗API參數的合法性頭條網

2020-12-06 16:41:47 佚名

validation主要是校驗用戶提交的數據的合法性，比如是否為空，密碼是否符合規則，郵箱格式是否正確等等，校驗框架比較多，用的比較多的是hibernate-validator，也支持國際化，也可以自定義校驗類型的註解，這裡只是簡單的演示校驗框架在Spring Boot中的簡單集成，要想了解更多可以參考 hibernate-validator

1. pom.xml

<code>
 org.springframework.boot
 spring-boot-starter-validation
/<code>

2. dto

<code>public class UserInfoIDto {
 private Long id;
 @NotBlank
 @Length(min=3, max=10)
 private String username;
 @NotBlank
 @Email
 private String email;
 @NotBlank
 @Pattern(regexp="^((13[0-9])|(15[^4,\\D])|(18[0,3-9]))\\d{8}$", message="手機號格式不正確")
 private String phone;
 @Min(value=18)
 @Max(value = 200)
 private int age;
 @NotBlank
 @Length(min=6, max=12, message="暱稱長度為6到12位")
 private String nickname;
 // Getter & Setter
}/<code>

3. controller

<code>import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
@RestController
public class SimpleController {
 @PostMapping("/users")
 public String register(@Valid @RequestBody UserInfoIDto userInfoIDto, BindingResult result){
 if (result.hasErrors()) {
 FieldError fieldError = result.getFieldError();
 String field = fieldError.getField();
 String msg = fieldError.getDefaultMessage();
 return field + ":" + msg;
 }
 System.out.println("開始註冊用戶...");
 return "success";
 }
}/<code>