基于javax.validation结合spring的最佳实践
前言
本人先将用到的配置、工具类贴出来,然后一步步告诉大家怎么使用
JSR303 是一套JavaBean参数校验的标准,它定义了很多常用的校验注解,我们可以直接将这些注解加在我们JavaBean的属性上面,就可以在需要校验的时候进行校验了。
注解如下:
Hibernate validator 在JSR303的基础上对校验注解进行了扩展,扩展注解如下:
pom中添加注解
<!--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 id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean"/>
自己的Violation实体
这里使用的Lombok获取get和set,使用的@Getter注解
@AllArgsConstructor 这个注解是lombok中为类提供一个全参的构造方法
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 @AllArgsConstructor public 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 */ @AllArgsConstructor public 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); } }
用来校验实体,构建并存储校验后的信息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 @Getter public 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不能多继承 所以如果已经继承了别的类,可以将此类注入出来
此类是为了拿到一个单例的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 @AllArgsConstructor public class SubmitVO extends BaseVO { @NotNull(message="厂商不能为空") private Long companyId; @Length(min=0, max=100, message="标题请控制在" + Constants.MAX_TITLE + "个字符以内") @NotNull(message="标题不能为空") private String title; @Length(min=0, max=65535, message="修复方案长度不能超过" + Constants.MAX_FIX_ADVICE) @NotNull(message="修复方案不能为空") private String fixAdvice; }
下面就是如何使用
public BaseResponse save(SubmitVO submitVO ) { /** * getValidatorProvider()此方法是BaserService中, * 上面说到本人的service是继承此 * service的所以可以直接用 **/ ValidatorProvider validatorProvider = getValidatorProvider(); /** * validatorProvider调用validate(Object obj)进行校验 * 返回ViolationBuild **/ ViolationBuild validateFlaw = validatorProvider.validate(submitVO); /** * 此时如果校验有失败的 容器中便会存储信息,ViolationBuild可以通过自己的 * getMessage方法获取信息(此方法可以自己封装成自己想要的样子) **/ System.out.println(validateFlaw.getMessage()); }
打印结果:标题请控制在100个字符以内
以上为个人经验,希望能给大家一个参考,也希望大家多多支持猪先飞。
相关文章
- 这篇文章主要介绍了Spring AOP 对象内部方法间的嵌套调用方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-08-29
Spring Cloud 中@FeignClient注解中的contextId属性详解
这篇文章主要介绍了Spring Cloud 中@FeignClient注解中的contextId属性详解,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-09-25Springboot如何实现Web系统License授权认证
这篇文章主要介绍了Springboot如何实现Web系统License授权认证,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-05-28- 这篇文章主要介绍了详解SpringCloudGateway内存泄漏问题,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2020-07-16
如何在Spring WebFlux的任何地方获取Request对象
这篇文章主要介绍了如何在Spring WebFlux的任何地方获取Request对象,帮助大家更好的理解和使用springboot框架,感兴趣的朋友可以了解下...2021-01-26- @Autowired 注解的主要功能就是完成自动注入,使用也非常简单,但这篇文章主要给大家介绍了关于Spring为什么不推荐使用@Autowired注解的相关资料,需要的朋友可以参考下...2021-11-03
Springboot如何使用mybatis实现拦截SQL分页
这篇文章主要介绍了Springboot使用mybatis实现拦截SQL分页,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-06-19- 这篇文章主要介绍了SpringMVC文件上传原理及实现过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-07-15
Spring Data JPA 关键字Exists的用法说明
这篇文章主要介绍了Spring Data JPA 关键字Exists的用法说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-06-10- 这篇文章主要为大家详细介绍了jquery表单验证插件validation使用方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2017-01-23
tomcat启动完成执行 某个方法 定时任务(Spring)操作
这篇文章主要介绍了tomcat启动完成执行 某个方法 定时任务(Spring)操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-09-25使用Maven 搭建 Spring MVC 本地部署Tomcat的详细教程
这篇文章主要介绍了使用Maven 搭建 Spring MVC 本地部署Tomcat,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2021-08-16- 这篇文章主要介绍了Spring Cloud负载均衡及远程调用实现详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2021-09-18
- 这篇文章主要介绍了SpringMvc自动装箱及GET请求参数原理解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-09-19
- 这篇文章主要介绍了SpringMvc获取请求头请求体消息过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-09-17
- 这篇文章主要介绍了Springboot使用thymeleaf动态模板实现刷新,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-08-31
Idea打包springboot项目没有.original文件解决方案
这篇文章主要介绍了Idea打包springboot项目没有.original文件解决方案,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-07-26- 这篇文章主要介绍了spring boot 使用utf8mb4的操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2021-02-20
Springmvc ResponseBody响应json数据实现过程
这篇文章主要介绍了Springmvc ResponseBody响应json数据实现过程,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-10-26- 这篇文章主要介绍了SpringData Repository接口用法解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-08-27