環(huán)境:Springboot2.6.12
Spring Validation是一種輕量級的數(shù)據(jù)驗證框架,主要用于對Java對象進行校驗。它為數(shù)據(jù)驗證提供了統(tǒng)一的接口和基本的校驗功能,解決了數(shù)據(jù)校驗這一常見問題,讓開發(fā)人員能夠方便地對數(shù)據(jù)進行驗證,從而保證數(shù)據(jù)的有效性和安全性。
Spring Validation提供了一套注解,用于對Java對象進行校驗,支持嵌套校驗和分組校驗,支持國際化和自定義注解和校驗器,可以滿足各種復(fù)雜的校驗需求。它的主要特點包括:
Bean Validation 為Java應(yīng)用程序提供了一種通過約束聲明和元數(shù)據(jù)進行驗證的通用方法。要使用它,只需要對POJO屬性進行注釋,然后由運行時強制執(zhí)行這些約束。有內(nèi)置的約束,你也可以定義自己的自定義約束。如下所示:
public class Person { @NotNull @Size(max=64) private String name; @Min(0) private int age;}
Bean驗證驗證器然后根據(jù)聲明的約束驗證此類的實例。有關(guān)API的一般信息,請參見Bean驗證。有關(guān)特定約束,請參閱Hibernate驗證程序文檔。
Spring提供了對Bean驗證API的全面支持,包括將Bean驗證提供者作為Spring Bean。這使你可以在應(yīng)用程序中需要驗證的任何位置注入javax.validation.ValidatorFactory或javax.validation.Validator。
你可以使用LocalValidatorFactoryBean將默認驗證器配置為Spring Bean,如下例所示:
import org.springframework.validation.beanvalidation.LocalValidatorFactoryBean;@Configurationpublic class AppConfig { @Bean public LocalValidatorFactoryBean validator() { return new LocalValidatorFactoryBean(); }}
上面的示例中的基本配置使用默認引導(dǎo)機制觸發(fā)bean驗證進行初始化。Bean驗證提供程序(如Hibernate驗證程序)應(yīng)該出現(xiàn)在類路徑中,并被自動檢測到。
@Servicepublic class PersonService { // inject javaee validator object @Resource private Validator validator ; // inject spring validator object @Resource private org.springframework.validation.Validator valid ;}
接著上面的配置,我們只需要做驗證動作即可。
@Servicepublic class PersonService { @Resource private Validator validator ; @Resource private org.springframework.validation.Validator valid ; public void validator(Person person) { Set<ConstraintViolation<Person>> res = validator.validate(person) ; res.forEach(cv -> { System.out.println(cv.getMessage()) ; }); System.out.println("----------------------") ; BindingResult errors = new MapBindingResult(new HashMap<String, Object>(), "person") ; valid.validate(person, errors) ; if (errors.hasErrors()) { errors.getAllErrors().forEach(oe -> { System.out.println(oe.getDefaultMessage()) ; }); } }}
@SpringBootTestclass SpringBootValidationApplicationTests { @Resource private PersonService ps ; @Test public void testValidator() { Person person = new Person() ; person.setAge(-1); ps.validator(person) ; }}
最小不能小于0不能為null----------------------最小不能小于0不能為null
每個Bean驗證約束由兩部分組成:
要將聲明與實現(xiàn)關(guān)聯(lián),每個@Constraint注釋都會引用相應(yīng)的ConstraintValidator實現(xiàn)類。在運行時,當域模型中遇到約束注釋時,ConstraintValidatorFactory將實例化引用的實現(xiàn)。下面的示例實現(xiàn)一個前綴匹配的驗證邏輯:
自定義注解
@Target({ElementType.METHOD, ElementType.FIELD})@Retention(RetentionPolicy.RUNTIME)@Constraint(validatedBy = PrefixConstraintValidator.class)public @interface PrefixConstraint { String value() default "" ; // 這里的{validator.prefix.error}就是資源文件中定義的錯誤信息 String message() default "{validator.prefix.error}"; Class<?>[] groups() default { }; Class<? extends Payload>[] payload() default { };}
以上的注解屬性都是必須的。
注意message屬性是我們將發(fā)生錯誤后錯誤信息定義在配置文件中,而該文件的basename必須是ValidationMessages,如果你需要國際化支持,那么就這樣命名:ValidationMessages_zh_CN.properties。
public class PrefixConstraintValidator implements ConstraintValidator<PrefixConstraint, CharSequence> { @Resource private DataService ds ; private String prefix ; @Override public boolean isValid(CharSequence value, ConstraintValidatorContext context) { ds.ak() ; if ( value == null ) { return false ; } return ((String) value).startsWith(prefix) ; } @Override public void initialize(PrefixConstraint pc) { prefix = pc.value() ; }}
驗證器必須實現(xiàn)ConstraintValidator接口,該接口是泛型接口,第一個參數(shù)是該驗證器要用于在那個注解,第二個參數(shù)是該注解應(yīng)用在什么數(shù)據(jù)類型上。注意:在自定義驗證器中我們是可以隨意地注入其它Bean對象,是不是很強大?
你可以通過MethodValidationPostProcessor Bean定義將Bean validation 1.1(以及Hibernate Validator 4.3的自定義擴展)支持的方法驗證功能集成到Spring上下文中:
@Beanpublic MethodValidationPostProcessor validationPostProcessor() { return new MethodValidationPostProcessor();}@Service@Validatedpublic class PersonService { @NotNull(message = "返回值不能為空") public Person findPerson(@NotEmpty(message = "ID 不能為空") String id) { return null ; }}
注意:類上必須有@Validated注解;因為上面的BeanPostProcessor中定義的Advisor(DefaultPointcutAdvisor)使用的切入的Pointcut在類級別上過濾條件是必須有@Validated注解,而方法則是攔截所有的方法。
這里是拋出的異常javax.validation.ConstraintViolationException,所有我們需要一個全局的異常攔截器來對異常做處理。
默認的LocalValidatoryFactoryBean配置對于大多數(shù)情況都足夠了。對于各種Bean驗證構(gòu)造,有許多配置選項,從消息插值到遍歷解析。有關(guān)這些選項的更多信息,請參閱LocalValidatorFactoryBean Javadoc。
https://docs.spring.io/spring-framework/docs/5.3.11/javadoc-api/org/springframework/validation/beanvalidation/LocalValidatorFactoryBean.html
本文鏈接:http://www.www897cc.com/showinfo-26-17391-0.htmlAPI接口參數(shù)驗證的必備神器,讓你的代碼更高效!
聲明:本網(wǎng)頁內(nèi)容旨在傳播知識,若有侵權(quán)等問題請及時與本網(wǎng)聯(lián)系,我們將在第一時間刪除處理。郵件:2376512515@qq.com
上一篇: 了不起的Base64