Spring boot開發web項目有時候我們需要對controller層傳過來的參數進行一些基本的校驗，比如非空、整數值的范圍、字符串的長度、日期、郵箱等等。Spring支持JSR-303 Bean Validation API，可以方便的進行校驗。
使用注解進行校驗
先定義一個form的封裝對象
class RequestForm { @Size(min = 1, max = 5) private String name; public String getName() { return name; } public void setName(String name) { this.name = name; }}其中name這個字段用Size注解限制長度1到5。Size是javax.validation包中的constraint注解。
在使用時用@Valid注解表示要校驗這個bean。
@ResponseBody @GetMapping(value = "bean") public String validate(@Valid RequestForm request) { System.out.println(request.getName()); return "OK"; }自定義注解
如果內置的注解不夠用，可以自定義注解。
比如先定義一個注解NameConstraint，限制name字段只能從特定數據中選取。
@Target({ ElementType.FIELD, ElementType.PARAMETER })@Retention(RetentionPolicy.RUNTIME)@Constraint(validatedBy = NameConstraintValidator.class)@interface NameConstraint { String[] allowedValues(); Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; String message();}其中allowedValues表示合法的取值范圍，message是校驗失敗的顯示信息。
message、groups、payload是hibernate validator要求的字段，想了解的請看官方文檔
再定義一個validator做真正的校驗
class NameConstraintValidator implements ConstraintValidator<NameConstraint, String> { private String[] validValues; @Override public void initialize(NameConstraint constraintAnnotation) { validValues = constraintAnnotation.allowedValues(); } @Override public boolean isValid(String value, ConstraintValidatorContext context) { for (String s : this.validValues) { if (s.equals(value)) { return true; } } return false; }}在form bean中按如下方式使用
class RequestFormWithCustomConstraint { @NameConstraint(allowedValues = { "bar", "foo" }, message = "只允許bar,foo") private String name; public String getName() { return name; } public void setName(String name) { this.name = name; }}直接校驗參數
只有一個name字段，不想封裝一個對象怎么辦？可以直接校驗該參數
@Controller@Validated@RequestMapping(value = "validator")public class ParameterValidatorDemoController { @ResponseBody @GetMapping(value = "simple") public String validateParameter(@Size(min = 1, max = 5) String name) { System.out.println(name); return "OK"; }}controller上面的@Validated注解則告訴spring需要掃描這個類，來檢查其中的constraint注解。
詳細信息可以參考官方文檔有關章節
https://docs.spring.io/spring-boot/docs/1.5.9.RELEASE/reference/htmlsingle/#boot-features-validation
https://docs.spring.io/spring/docs/4.3.16.RELEASE/spring-framework-reference/htmlsingle/#validation-beanvalidation
代碼在github
https://github.com/kabike/spring-boot-demo
總結
以上所述是小編給大家介紹的Spring boot進行參數校驗的方法實例詳解,希望對大家有所幫助,如果大家有任何疑問歡迎給我留言,小編會及時回復大家的!
新聞熱點
疑難解答
圖片精選
