資料的校驗是互動網站一個不可或缺的功能,前端的js校驗可以涵蓋大部分的校驗職責,如使用者名稱唯一性,生日格式,郵箱格式校驗等等常用的校驗。但是為了避免用戶繞過瀏覽器,使用http工具直接向後端請求一些違法數據,服務端的數據校驗也是必要的,可以防止髒數據落到數據庫中,如果數據庫中出現一個非法的郵箱格式,也會讓維運人員頭痛不已。可以使用本文將要介紹的validation來對資料進行校驗。
1.JSR303/JSR-349: JSR303是一項標準,只提供規範不提供實現,規定一些校驗規範即校驗註解,如@ Null,@NotNull,@Pattern,位於javax.validation.constraints套件下。 JSR-349是其的升級版本,增加了一些新功能。
@Null 被註解的元素必須為null
#@NotNull 被註解的元素必須不為null
#@AssertTrue 被註解的元素必須為true
#@AssertFalse 被註解的元素必須為false
@Min( value) 被註解的元素必須是一個數字,其值必須大於等於指定的最小值
@Max(value) 被註解的元素必須是一個數字,其值必須小於等於指定的最大值
@DecimalMin(value) 被註解的元素必須是一個數字,其值必須大於等於指定的最小值
##。
@Pattern(value) 被註解的元素必須符合指定的正規表示式 2.hibernate validation:hibernate validation是對這個規範的實現,並增加了一些其他校驗註解,如@Email,@Length,@Range等等 @Email 被註解的元素必須是電子郵件位址 @Length 被註解的字串的大小必須在指定的範圍內 @NotEmpty 被註解的字串的必須非空<dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> </dependencies>
3.3 建立需要被校驗的實體類別<dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-validator</artifactId> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> </dependency>登入後複製3.2 建置啟動類別
@SpringBootApplication public class App { public static void main(String[] args) { SpringApplication.run(App.class, args); System.out.println("Start app success."); } }登入後複製
public class Person { @NotEmpty(message = "name不能为空") private String name; @Range(min = 0, max = 100, message = "age不能大于100小于0") private int age; public String getName() { return name; } public void setName(String name) { this.name = name; } public int getAge() { return age; } public void setAge(int age) { this.age = age; } }
@RequestMapping("/test") public String valid(@Validated Person person, BindingResult bindingResult) { if (bindingResult.hasErrors()) { for (FieldError fieldError : bindingResult.getFieldErrors()) { System.out.println(fieldError); } return "fail"; } return "success"; }
@RequestMapping(value = "valid", method = RequestMethod.GET) public String valid(@Validated Person person) { System.out.println(person); return "success"; }
@RestControllerAdvice public class BindExceptionHanlder { @ExceptionHandler(BindException.class) public String handleBindException(HttpServletRequest request, BindException exception) { List<FieldError> allErrors = exception.getFieldErrors(); StringBuilder sb = new StringBuilder(); for (FieldError errorMessage : allErrors) { sb.append(errorMessage.getField()).append(": ").append(errorMessage.getDefaultMessage()).append(", "); } System.out.println(sb.toString()); return sb.toString(); } }
输出:age: age不能大于100小于0,
@Documented @Constraint(validatedBy = NameValidationValidator.class) @Target({ElementType.METHOD, ElementType.FIELD}) @Retention(RUNTIME) public @interface NameValidation { String message() default "不是合法的名字"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; @Target({PARAMETER, ANNOTATION_TYPE}) @Retention(RUNTIME) @Documented @interface List { NameValidation[] value(); } }
public class NameValidationValidator implements ConstraintValidator<NameValidation, String> { @Override public boolean isValid(String value, ConstraintValidatorContext context) { if ("steven".equalsIgnoreCase(value)) { return true; } String defaultConstraintMessageTemplate = context.getDefaultConstraintMessageTemplate(); System.out.println("default message :" + defaultConstraintMessageTemplate); //禁用默认提示信息 //context.disableDefaultConstraintViolation(); //设置提示语 //context.buildConstraintViolationWithTemplate("can not contains blank").addConstraintViolation(); return false; } }
@NotEmpty(message = "name不能为空") @NameValidation private String name;
测试: http://localhost:8080/valid?age=105&name=lxy
输出:age: age不能大于100小于0, name: 不是合法的名字,
以上是SpringBoot如何利用validation實現優雅的校驗參數的詳細內容。更多資訊請關注PHP中文網其他相關文章!