基于javax.validation結(jié)合spring的最佳實踐
本人先將用到的配置、工具類貼出來,然后一步步告訴大家怎么使用
JSR303 是一套JavaBean參數(shù)校驗的標(biāo)準(zhǔn),它定義了很多常用的校驗注解,我們可以直接將這些注解加在我們JavaBean的屬性上面,就可以在需要校驗的時候進(jìn)行校驗了。
注解如下:
Hibernate validator 在JSR303的基礎(chǔ)上對校驗注解進(jìn)行了擴(kuò)展,擴(kuò)展注解如下:
<!--jsr 303--><dependency> <groupId>javax.validation</groupId> <artifactId>validation-api</artifactId> <version>1.1.0.Final</version></dependency><!-- hibernate validator--><dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-validator</artifactId> <version>5.2.0.Final</version></dependency>Spring配置
<bean />自己的Violation實體
這里使用的Lombok獲取get和set,使用的@Getter注解
@AllArgsConstructor 這個注解是lombok中為類提供一個全參的構(gòu)造方法
package com.alibaba.xianzhi.validator;import java.io.Serializable;import lombok.AllArgsConstructor;import lombok.Getter;/** * Created by Jackielee on 2017 * @author: lizhilong * @date: 2017-11-14 18:01:34 */@Getter@AllArgsConstructorpublic class Violation implements Serializable { private static final long serialVersionUID = -1731546219600067986L; private final String message; private final Object bean; private final String property; private final Object value;}封裝一個ViolationBuild
后面會說這個類的用法
package com.alibaba.xianzhi.validator;import java.util.ArrayList;import java.util.HashSet;import java.util.List;import java.util.Set;import javax.validation.ConstraintViolation;import lombok.AllArgsConstructor;import lombok.Getter;import org.apache.commons.collections.CollectionUtils;/** * @author: lizhilong * @date: 2017-11-15 11:41:12 */@AllArgsConstructorpublic class ViolationBuild{ @Getter private Set<Violation> violations; public String getMessage() {List<String> list = new ArrayList<String>();for (Violation violation : violations) { list.add(violation.getMessage());}return list.size() > 0 ? list.get(0) : ''; } public static <T> ViolationBuild build(Set<ConstraintViolation<T>> cvs) {Set<Violation> result = new HashSet<Violation>();if (CollectionUtils.isNotEmpty(cvs)) { for (ConstraintViolation cv : cvs) {result.add(new Violation(cv.getMessage(), cv.getRootBean() == null ? null : cv.getRootBean().toString(), cv.getPropertyPath() == null ? null : cv.getPropertyPath().toString(), cv.getInvalidValue())); }}return new ViolationBuild(result); }}用來校驗實體,構(gòu)建并存儲校驗后的信息ValidatorProvider
package com.alibaba.xianzhi.validator;import java.util.Set;import javax.validation.ConstraintViolation;import javax.validation.ValidationException;import javax.validation.Validator;import lombok.AllArgsConstructor;import lombok.Getter;/** * @author: lizhilong * @date: 2017-11-15 11:40:59 */@AllArgsConstructor@Getterpublic class ValidatorProvider { private final Validator validator; public <T> ViolationBuild validate(T object) {Set<ConstraintViolation<T>> violations;try { violations = validator.validate(object);} catch (IllegalArgumentException iae) { throw iae;} catch (ValidationException ve) { throw ve;}return ViolationBuild.build(violations); } public <T> ViolationBuild validate(T object, Class<?>... groups) {Set<ConstraintViolation<T>> violations;try { violations = validator.validate(object, groups);} catch (IllegalArgumentException iae) { throw iae;} catch (ValidationException ve) { throw ve;}return ViolationBuild.build(violations); } public <T> ViolationBuild validateProperty(T object, String propertyName, Class<?>... groups) {Set<ConstraintViolation<T>> violations;try { violations = validator.validateProperty(object, propertyName, groups);} catch (IllegalArgumentException iae) { throw iae;} catch (ValidationException ve) { throw ve;}return ViolationBuild.build(violations); } public <T> ViolationBuild validateValue(Class<T> beanType, String propertyName, Object value, Class<?>... groups) {Set<ConstraintViolation<T>> violations;try { violations = validator.validateValue(beanType, propertyName, value, groups);} catch (IllegalArgumentException iae) { throw iae;} catch (ValidationException ve) { throw ve;}return ViolationBuild.build(violations); }}BaseService讓自己的service繼承此類
java不能多繼承 所以如果已經(jīng)繼承了別的類,可以將此類注入出來
此類是為了拿到一個單例的ValidatorProvider
package com.alibaba.xianzhi.base.web;import javax.annotation.Resource;import javax.validation.Validator;import com.alibaba.xianzhi.validator.ValidatorProvider;/** * BaseService * @author: lizhilong * @date: 2017-11-15 11:41:24 */public abstract class BaseService { @Resource protected Validator validator; private ValidatorProvider validatorProvider; protected ValidatorProvider getValidatorProvider() {if (validatorProvider == null) { validatorProvider = new ValidatorProvider(validator);}return validatorProvider; }}所需校驗的實體類
說明:Constants為接口常量
@Getter@AllArgsConstructorpublic class SubmitVO extends BaseVO { @NotNull(message='廠商不能為空') private Long companyId; @Length(min=0, max=100, message='標(biāo)題請控制在' + Constants.MAX_TITLE + '個字符以內(nèi)') @NotNull(message='標(biāo)題不能為空') private String title; @Length(min=0, max=65535, message='修復(fù)方案長度不能超過' + Constants.MAX_FIX_ADVICE) @NotNull(message='修復(fù)方案不能為空') private String fixAdvice;}下面就是如何使用
public BaseResponse save(SubmitVO submitVO ) {/** * getValidatorProvider()此方法是BaserService中, * 上面說到本人的service是繼承此 * service的所以可以直接用 **/ValidatorProvider validatorProvider = getValidatorProvider();/** * validatorProvider調(diào)用validate(Object obj)進(jìn)行校驗 * 返回ViolationBuild **/ViolationBuild validateFlaw = validatorProvider.validate(submitVO);/** * 此時如果校驗有失敗的 容器中便會存儲信息,ViolationBuild可以通過自己的 * getMessage方法獲取信息(此方法可以自己封裝成自己想要的樣子) **/System.out.println(validateFlaw.getMessage()); }
打印結(jié)果:標(biāo)題請控制在100個字符以內(nèi)
以上為個人經(jīng)驗,希望能給大家一個參考,也希望大家多多支持好吧啦網(wǎng)。
相關(guān)文章:
1. PHP正則表達(dá)式函數(shù)preg_replace用法實例分析2. 一個 2 年 Android 開發(fā)者的 18 條忠告3. vue使用moment如何將時間戳轉(zhuǎn)為標(biāo)準(zhǔn)日期時間格式4. js select支持手動輸入功能實現(xiàn)代碼5. Android 實現(xiàn)徹底退出自己APP 并殺掉所有相關(guān)的進(jìn)程6. Android studio 解決logcat無過濾工具欄的操作7. 什么是Python變量作用域8. vue-drag-chart 拖動/縮放圖表組件的實例代碼9. Spring的異常重試框架Spring Retry簡單配置操作10. Vue實現(xiàn)仿iPhone懸浮球的示例代碼
