概述
spring validation使用文档
本案例包含了spring validation的3种不同的使用方式（纯注解，bindingResult，手动校验），可在https://gitee.com/dtzds/spring-validation-demo 下载本案例demo
基本注解
空检查
@Null 验证对象是否为null
@NotNull 验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
@NotEmpty 检查约束元素是否为NULL或者是EMPTY.
Booelan检查
@AssertTrue 验证 Boolean 对象是否为 true
@AssertFalse 验证 Boolean 对象是否为 false
长度检查
@Size(min=, max=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内
@Length(min=, max=) 验证注解的元素值长度在min和max区间内
日期检查
@Past 验证 Date 和 Calendar 对象是否在当前时间之前
@Future 验证 Date 和 Calendar 对象是否在当前时间之后
@Pattern 验证 String 对象是否符合正则表达式的规则
数值检查，建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为“”时无法转换为int，但可以转换为Stirng为"",Integer为null
@Min 验证 Number 和 String 对象是否大等于指定的值
@Max 验证 Number 和 String 对象是否小等于指定的值
@DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度
@DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度
@Digits 验证 Number 和 String 的构成是否合法
@Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。
@Range(min=, max=) 验证注解的元素值在最小值和最大值之间
@Range(min=10000,max=50000,message="range.bean.wage")
@Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)
@CreditCardNumber信用卡验证
@Email 验证是否是邮件地址，如果为null,不进行验证，算通过验证。
@ScriptAssert(lang= ,script=, alias=)
@URL(protocol=,host=, port=,regexp=, flags=)
基本使用
1、引入依赖
注意：spring-boot-starter-web 2.3.x以下版本不需要引入该依赖，spring-boot-starter-web 2.3.x及以上需要引入
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.0.1.Final</version>
</dependency>
2、接收参数实体上添加校验注解
可以查看demo中的
com.bw.demo.model中的Dto
package com.bw.demo.model;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
import com.bw.demo.enums.TypeEnum;
import com.bw.demo.valid.anno.EnumValid;
public class UserDto
{
@NotBlank(message = "id参数丢失")
private String id;
@NotBlank(message = "名称不能为空")
private String name;
@NotNull(message = "年龄不能为空")
private Integer age;
@EnumValid(target = TypeEnum.class, enumType = "value", message = "状态值非法")
private String type;
// 添加@Valid，可以对对象进行级联校验
// @Valid
@NotNull
private Course course;
// ..... getter/setter
}
3、*Controller中的api接口添加校验注解
-
方式一：使用纯注解的方式
使用纯注解时，校验失败会抛出如下3中异常，可定义全局异常处理器进行捕获
- org.springframework.web.bind.MethodArgumentNotValidException
- org.springframework.validation.BindException
- javax.validation.ConstraintViolationException
@Validated @RestController @RequestMapping("/test") public class UserController { /******************** 方式一：纯注解模式 *************************/ // 校验不通过，抛出org.springframework.web.bind.MethodArgumentNotValidException @RequestMapping(value = "save", method = RequestMethod.POST) public BwResult save(@Validated @RequestBody UserDto user) { return BwResult.success().setData(user); } // 校验不通过，抛出org.springframework.validation.BindException @RequestMapping(value = "save", method = RequestMethod.GET) public BwResult save(@Validated Course user) { return BwResult.success().setData(user); } /** * 此种方式需要在类上添加 @Validated 注解才会生效 */ // 校验不通过，抛出javax.validation.ConstraintViolationException @RequestMapping(value = "get", method = RequestMethod.POST) public BwResult getPost(@NotBlank(message = "id不能为空") String id) { return BwResult.success().setData(id); } /** * 此种方式需要在类上添加 @Validated 注解才会生效 */ // 校验不通过，抛出javax.validation.ConstraintViolationException @RequestMapping(value = "get", method = RequestMethod.GET) public BwResult get(@NotBlank(message = "id不能为空") String id) { return BwResult.success().setData(id); } } -
**方式二：**使用
BindingResult接收参数方式@RestController @RequestMapping("/test") public class UserController { /************************** 方式二：BindingResult接收校验结果 ***********************/ @RequestMapping(value = "save2", method = RequestMethod.POST) public BwResult save2(@Validated @RequestBody UserDto user, BindingResult result) { if (result.hasErrors()) { // TODO，可以获取校验 throw new RuntimeException("参数校验失败"); } return BwResult.success().setData(user); } } -
**方式三：**手动校验模式
@RestController @RequestMapping("/test") public class UserController { /************************* 方式三：手动校验模式 ************************/ @RequestMapping(value = "save3", method = RequestMethod.POST) public BwResult save3(@RequestBody UserDto user) { // 构建校验器， failFast-true:快速失败 Validator validator = Validation.byProvider(HibernateValidator.class).configure() .failFast(false).buildValidatorFactory().getValidator(); // 校验 Set<ConstraintViolation<UserDto>> validResult = validator.validate(user); if (validResult.size() > 0) { // TODO 可以获取错误 throw new RuntimeException("参数校验失败"); } return BwResult.success().setData(user); } }
4、使用全局异常处理器处理抛出的异常
spring validation参数校验时，会抛出3种异常，分别是：
org.springframework.web.bind.MethodArgumentNotValidException，org.springframework.validation.BindException以及javax.validation.ConstraintViolationException3种异常。详情见demo：
com.bw.demo.controllerAdvice.GlobalExceptionHandler
// 400错误
@ExceptionHandler(MethodArgumentNotValidException.class)
public BwResult validateExceptionHandler(MethodArgumentNotValidException ex) {
return resultFormat(SysErrorCodeEnum.HTTP_400.getCode(), SysErrorCodeEnum.HTTP_400.getMsg(), ex);
}
// 400错误
@ExceptionHandler(BindException.class)
public BwResult validateExceptionHandler(BindException ex) {
return resultFormat(SysErrorCodeEnum.HTTP_400.getCode(), SysErrorCodeEnum.HTTP_400.getMsg(), ex);
}
// 400错误，单参数校验
@ExceptionHandler(ConstraintViolationException.class)
public BwResult validateExceptionHandler(ConstraintViolationException ex) {
return resultFormat(SysErrorCodeEnum.HTTP_400.getCode(), SysErrorCodeEnum.HTTP_400.getMsg(), ex);
}
分组使用
1、定义分组
package com.bw.demo.valid.group;
public class ValidationGroup
{
/**
* 新增分组
*/
public interface AddGroup {};
/**
* 编辑分组
*/
public interface EditGroup {};
/**
* id必填分组
*/
public interface IdGroup {};
// ......
}
2、接收参数实体上添加校验注解及分组
package com.bw.demo.model;
public class UserGroupDto
{
@NotBlank(message = "id参数丢失", groups = {IdGroup.class, EditGroup.class})
private String id;
@NotBlank(message = "名称不能为空", groups = {AddGroup.class, EditGroup.class})
private String name;
@NotNull(message = "年龄不能为空", groups = {AddGroup.class, EditGroup.class})
private Integer age;
@EnumValid(target = TypeEnum.class, enumType = "value", message = "状态值非法", groups = {AddGroup.class, EditGroup.class})
private String type;
// 添加@Valid，可以对对象进行级联校验
// @Valid
@NotNull
private Course course;
// .... getter/setter
}
3、*Controller中的api接口添加校验注解及分组
-
方式一： 纯注解使用
package com.bw.demo.controller; @Validated @RestController @RequestMapping("/test/group") public class UserGroupController { /******************** 方式一：纯注解模式 *************************/ /** * 添加分组 * @param user * @return */ @RequestMapping(value = "save", method = RequestMethod.POST) public BwResult save(@Validated(AddGroup.class) @RequestBody UserGroupDto user) { return BwResult.success().setData(user); } @RequestMapping(value = "update", method = RequestMethod.GET) public BwResult update(@Validated(EditGroup.class) UserGroupDto user) { return BwResult.success().setData(user); } @RequestMapping(value = "delete", method = RequestMethod.GET) public BwResult delete(@Validated(IdGroup.class) UserGroupDto user) { return BwResult.success().setData(user); } @RequestMapping(value = "batchDelete", method = RequestMethod.POST) public BwResult batchDelete(@Validated @RequestBody IdsReq ids) { return BwResult.success().setData(ids); } @RequestMapping(value = "get", method = RequestMethod.GET) public BwResult get(@Validated(SelectGroup.class) UserGroupDto user) { return BwResult.success().setData(user); } } -
方式二： BindingResult使用
BindingResult方式同纯注解方式，只需要在@Validated中添加需要校验的注解即可
package com.bw.demo.controller; @RestController @RequestMapping("/test/group") public class UserGroupController { /************************** 方式二：BindingResult接收校验结果 ***********************/ @RequestMapping(value = "save2", method = RequestMethod.POST) public BwResult save2(@Validated(AddGroup.class) @RequestBody UserGroupDto user, BindingResult result) { if (result.hasErrors()) { for (ObjectError error : result.getAllErrors()) { System.out.println(error.getDefaultMessage()); } throw new RuntimeException("参数校验失败"); } return BwResult.success().setData(user); } } -
方式三： 手动校验模式
手动校验时，使用validator.validate(T object, Class<?> … groups)，第二个参数可传入分组
package com.bw.demo.controller; @Validated @RestController @RequestMapping("/test/group") public class UserGroupController { /************************* 方式三：手动校验模式 ************************/ @RequestMapping(value = "save3", method = RequestMethod.POST) public BwResult save3(@RequestBody UserGroupDto user) { // 构建校验器， failFast-true:快速失败 Validator validator = Validation.byProvider(HibernateValidator.class).configure() .failFast(false).buildValidatorFactory().getValidator(); // 校验时，可以添加分组 Set<ConstraintViolation<UserGroupDto>> validResult = validator.validate(user, AddGroup.class); if (validResult.size() > 0) { throw new RuntimeException("参数校验失败"); /* * for (ConstraintViolation<UserDto> constraintViolation : validResult) * { * String message = constraintViolation.getMessage(); * } */ } return BwResult.success().setData(user); } }
自定义注解
自定义的校验注解使用方式和其它注解一致
1、自定义一个校验注解
String message() default "";，Class<?>[] groups() default { };以及Class<? extends Payload>[] payload() default { };3个方法是默认的
@Constraint(validatedBy = { EnumConstraintValidator.class })中指定的是该自定义枚举注解的校验器，可以定义多个
package com.bw.demo.valid.anno;
/**
* 对枚举进行校验
*/
@Documented
@Constraint(validatedBy = { EnumConstraintValidator.class })
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
public @interface EnumValid {
String message() default "";
Class<?>[] groups() default { };
Class<? extends Payload>[] payload() default { };
/**
* 目标枚举类
* @return
*/
Class<?> target();
/**
* 需要校验的目标枚举类中的字段名，该枚举中需要有该字段的get方法
* @return
*/
String enumType() default "value";
}
2、自定义校验器
自定义校验器对
ConstraintValidator<A extends Annotation, T>进行实现，A为自定义的校验注解，T为校验的参数类型
package com.bw.demo.valid.validator;
/**
* 枚举校验
* @author tao zhisheng
*
*/
public class EnumConstraintValidator implements ConstraintValidator<EnumValid, String>
{
private Logger logger = LoggerFactory.getLogger(EnumConstraintValidator.class);
/** 保存枚举中的值*/
private Set<String> values = new HashSet<String>();
/**
* 初始化方法
*/
@Override
public void initialize(EnumValid constraintAnnotation)
{
// 获取校验的enum类
Class<?> enumClass = constraintAnnotation.target();
// 获取需要校验的enum类里取的值的字段名
String enumType = constraintAnnotation.enumType();
// 获取方法
String methodName = "get" + enumType.substring(0, 1).toUpperCase() + enumType.substring(1);
String result = null;
Method method = null;
if (enumClass.isEnum())
{
Object[] enums = enumClass.getEnumConstants();
for (Object o : enums)
{
try
{
method = o.getClass().getDeclaredMethod(methodName);
result = (String) method.invoke(o);
values.add(result);
} catch (Exception e)
{
logger.error("枚举校验异常：{}", e);
}
}
}
}
@Override
public boolean isValid(String value, ConstraintValidatorContext context)
{
// 为空时，直接放行
if (value == null || "".equals(value.trim()))
{
return true;
}
if (values.contains(value))
{
return true;
}
return false;
}
}
最后
以上就是暴躁网络为你收集整理的spring validation的使用详解spring validation使用文档的全部内容，希望文章能够帮你解决spring validation的使用详解spring validation使用文档所遇到的程序开发问题。
如果觉得靠谱客网站的内容还不错，欢迎将靠谱客网站推荐给程序员好友。
本图文内容来源于网友提供，作为学习参考使用，或来自网络收集整理，版权属于原作者所有。
发表评论 取消回复