关键词：
简单使用
Java API规范(JSR303)定义了Bean校验的标准validation-api，但没有提供实现。hibernate validation是对这个规范的实现，并增加了校验注解如@Email、@Length等。
Spring Validation是对hibernate validation的二次封装，用于支持spring mvc参数自动校验。接下来，我们以spring-boot项目为例，介绍Spring Validation的使用。
引入依赖
如果spring-boot版本小于2.3.x，spring-boot-starter-web会自动传入hibernate-validator依赖。如果spring-boot版本大于2.3.x，则需要手动引入依赖：
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.0.1.Final</version>
</dependency>
对于web服务来说，为防止非法参数对业务造成影响，在Controller层一定要做参数校验的！大部分情况下，请求参数分为如下两种形式：
- POST、PUT请求，使用requestBody传递参数；
- GET请求，使用requestParam/PathVariable传递参数。
下面我们简单介绍下requestBody和requestParam/PathVariable的参数校验实战！
requestBody参数校验
POST、PUT请求一般会使用requestBody传递参数，这种情况下，后端使用DTO对象进行接收。只要给DTO对象加上@Validated注解就能实现自动参数校验。比如，有一个保存User的接口，要求userName长度是2-10，account和password字段长度是6-20。
如果校验失败，会抛出MethodArgumentNotValidException异常，Spring默认会将其转为400（Bad Request）请求。
DTO表示数据传输对象（Data Transfer Object），用于服务器和客户端之间交互传输使用的。在spring-web项目中可以表示用于接收请求参数的Bean对象。
在DTO字段上声明约束注解
@Data
public class UserDTO
private Long userId;
@NotNull
@Length(min = 2, max = 10)
private String userName;
@NotNull
@Length(min = 6, max = 20)
private String account;
@NotNull
@Length(min = 6, max = 20)
private String password;
在方法参数上声明校验注解
@PostMapping("/save")
public Result saveUser(@RequestBody @Validated UserDTO userDTO)
// 校验通过，才会执行业务逻辑处理
return Result.ok();
这种情况下，使用@Valid和@Validated都可以。
requestParam/PathVariable参数校验
GET请求一般会使用requestParam/PathVariable传参。如果参数比较多(比如超过6个)，还是推荐使用DTO对象接收。
否则，推荐将一个个参数平铺到方法入参中。在这种情况下，必须在Controller类上标注@Validated注解，并在入参上声明约束注解(如@Min等)。如果校验失败，会抛出ConstraintViolationException异常。
代码示例如下：
@RequestMapping("/api/user")
@RestController
@Validated
public class UserController
// 路径变量
@GetMapping("userId")
public Result detail(@PathVariable("userId") @Min(10000000000000000L) Long userId)
// 校验通过，才会执行业务逻辑处理
UserDTO userDTO = new UserDTO();
userDTO.setUserId(userId);
userDTO.setAccount("11111111111111111");
userDTO.setUserName("xixi");
userDTO.setAccount("11111111111111111");
return Result.ok(userDTO);
// 查询参数
@GetMapping("getByAccount")
public Result getByAccount(@Length(min = 6, max = 20) @NotNull String account)
// 校验通过，才会执行业务逻辑处理
UserDTO userDTO = new UserDTO();
userDTO.setUserId(10000000000000003L);
userDTO.setAccount(account);
userDTO.setUserName("xixi");
userDTO.setAccount("11111111111111111");
return Result.ok(userDTO);
统一异常处理
前面说过，如果校验失败，会抛出MethodArgumentNotValidException或者ConstraintViolationException异常。在实际项目开发中，通常会用统一异常处理来返回一个更友好的提示。
比如我们系统要求无论发送什么异常，http的状态码必须返回200，由业务码去区分系统的异常情况。
@RestControllerAdvice
public class CommonExceptionHandler
@ExceptionHandler(MethodArgumentNotValidException.class)
@ResponseStatus(HttpStatus.OK)
@ResponseBody
public Result handleMethodArgumentNotValidException(MethodArgumentNotValidException ex)
BindingResult bindingResult = ex.getBindingResult();
StringBuilder sb = new StringBuilder("校验失败:");
for (FieldError fieldError : bindingResult.getFieldErrors())
sb.append(fieldError.getField()).append("：").append(fieldError.getDefaultMessage()).append(", ");
String msg = sb.toString();
return Result.fail(BusinessCode.参数校验失败, msg);
@ExceptionHandler(ConstraintViolationException.class)
@ResponseStatus(HttpStatus.OK)
@ResponseBody
public Result handleConstraintViolationException(ConstraintViolationException ex)
return Result.fail(BusinessCode.参数校验失败, ex.getMessage());
进阶使用
分组校验
在实际项目中，可能多个方法需要使用同一个DTO类来接收参数，而不同方法的校验规则很可能是不一样的。这个时候，简单地在DTO类的字段上加约束注解无法解决这个问题。因此，spring-validation支持了分组校验的功能，专门用来解决这类问题。
还是上面的例子，比如保存User的时候，UserId是可空的，但是更新User的时候，UserId的值必须>=10000000000000000L；其它字段的校验规则在两种情况下一样。这个时候使用分组校验的代码示例如下：
约束注解上声明适用的分组信息groups
@Data
public class UserDTO
@Min(value = 10000000000000000L, groups = Update.class)
private Long userId;
@NotNull(groups = Save.class, Update.class)
@Length(min = 2, max = 10, groups = Save.class, Update.class)
private String userName;
@NotNull(groups = Save.class, Update.class)
@Length(min = 6, max = 20, groups = Save.class, Update.class)
private String account;
@NotNull(groups = Save.class, Update.class)
@Length(min = 6, max = 20, groups = Save.class, Update.class)
private String password;
/**
* 保存的时候校验分组
*/
public interface Save
/**
* 更新的时候校验分组
*/
public interface Update
@Validated注解上指定校验分组
@PostMapping("/save")
public Result saveUser(@RequestBody @Validated(UserDTO.Save.class) UserDTO userDTO)
// 校验通过，才会执行业务逻辑处理
return Result.ok();
@PostMapping("/update")
public Result updateUser(@RequestBody @Validated(UserDTO.Update.class) UserDTO userDTO)
// 校验通过，才会执行业务逻辑处理
return Result.ok();
嵌套校验
前面的示例中，DTO类里面的字段都是基本数据类型和String类型。但是实际场景中，有可能某个字段也是一个对象，这种情况先，可以使用嵌套校验。
比如，上面保存User信息的时候同时还带有Job信息。需要注意的是，此时DTO类的对应字段必须标记@Valid注解。
@Data
public class UserDTO
@Min(value = 10000000000000000L, groups = Update.class)
private Long userId;
@NotNull(groups = Save.class, Update.class)
@Length(min = 2, max = 10, groups = Save.class, Update.class)
private String userName;
@NotNull(groups = Save.class, Update.class)
@Length(min = 6, max = 20, groups = Save.class, Update.class)
private String account;
@NotNull(groups = Save.class, Update.class)
@Length(min = 6, max = 20, groups = Save.class, Update.class)
private String password;
@NotNull(groups = Save.class, Update.class)
@Valid
private Job job;
@Data
public static class Job
@Min(value = 1, groups = Update.class)
private Long jobId;
@NotNull(groups = Save.class, Update.class)
@Length(min = 2, max = 10, groups = Save.class, Update.class)
private String jobName;
@NotNull(groups = Save.class, Update.class)
@Length(min = 2, max = 10, groups = Save.class, Update.class)
private String position;
/**
* 保存的时候校验分组
*/
public interface Save
/**
* 更新的时候校验分组
*/
public interface Update
嵌套校验可以结合分组校验一起使用。还有就是嵌套集合校验会对集合里面的每一项都进行校验，例如List<Job>字段会对这个list里面的每一个Job对象都进行校验
集合校验
如果请求体直接传递了json数组给后台，并希望对数组中的每一项都进行参数校验。此时，如果我们直接使用java.util.Collection下的list或者set来接收数据，参数校验并不会生效！我们可以使用自定义list集合来接收参数：
包装List类型，并声明@Valid注解
public class ValidationList<E> implements List<E>
@Delegate // @Delegate是lombok注解
@Valid // 一定要加@Valid注解
public List<E> list = new ArrayList<>();
// 一定要记得重写toString方法
@Override
public String toString()
return list.toString();
@Delegate注解受lombok版本限制，1.18.6以上版本可支持。如果校验不通过，会抛出NotReadablePropertyException，同样可以使用统一异常进行处理。
比如，我们需要一次性保存多个User对象，Controller层的方法可以这么写：
@PostMapping("/saveList")
public Result saveList(@RequestBody @Validated(UserDTO.Save.class) ValidationList<UserDTO> userList)
// 校验通过，才会执行业务逻辑处理
return Result.ok();
自定义校验
业务需求总是比框架提供的这些简单校验要复杂的多，我们可以自定义校验来满足我们的需求。
自定义spring validation非常简单，假设我们自定义加密id（由数字或者a-f的字母组成，32-256长度）校验，主要分为两步：
自定义约束注解
@Target(METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER)
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = EncryptIdValidator.class)
public @interface EncryptId
// 默认错误消息
String message() default "加密id格式错误";
// 分组
Class<?>[] groups() default ;
// 负载
Class<? extends Payload>[] payload() default ;
实现ConstraintValidator接口编写约束校验器
public class EncryptIdValidator implements ConstraintValidator<EncryptId, String>
private static final Pattern PATTERN = Pattern.compile("^[a-f\\\\d]32,256$");
@Override
public boolean isValid(String value, ConstraintValidatorContext context)
// 不为null才进行校验
if (value != null)
Matcher matcher = PATTERN.matcher(value);
return matcher.find();
return true;
这样我们就可以使用@EncryptId进行参数校验了！
编程式校验
上面的示例都是基于注解来实现自动校验的，在某些情况下，我们可能希望以编程方式调用验证。这个时候可以注入javax.validation.Validator对象，然后再调用其api。
@Autowired
private javax.validation.Validator globalValidator;
// 编程式校验
@PostMapping("/saveWithCodingValidate")
public Result saveWithCodingValidate(@RequestBody UserDTO userDTO)
Set<ConstraintViolation<UserDTO>> validate = globalValidator.validate(userDTO, UserDTO.Save.class);
// 如果校验通过，validate为空；否则，validate包含未校验通过项
if (validate.isEmpty())
// 校验通过，才会执行业务逻辑处理
else
for (ConstraintViolation<UserDTO> userDTOConstraintViolation : validate)
// 校验失败，做其它逻辑
System.out.println(userDTOConstraintViolation);
return Result.ok();
快速失败(Fail Fast)
Spring Validation默认会校验完所有字段，然后才抛出异常。可以通过一些简单的配置，开启Fali Fast模式，一旦校验失败就立即返回。
@Bean
public Validator validator()
ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)
.configure()
// 快速失败模式
.failFast(true)
.buildValidatorFactory();
return validatorFactory.getValidator();
@Valid和@Validated区别
实现原理
requestBody参数校验实现原理
在spring-mvc中，RequestResponseBodyMethodProcessor是用于解析@RequestBody标注的参数以及处理@ResponseBody标注方法的返回值的。显然，执行参数校验的逻辑肯定就在解析参数的方法resolveArgument()中：
public class RequestResponseBodyMethodProcessor extends AbstractMessageConverterMethodProcessor
@Override
public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,
NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception
parameter = parameter.nestedIfOptional();
//将请求数据封装到DTO对象中
Object arg = readWithMessageConverters(webRequest, parameter, parameter.getNestedGenericParameterType());
String name = Conventions.getVariableNameForParameter(parameter);
if (binderFactory != null)
WebDataBinder binder = binderFactory.createBinder(webRequest, arg, name);
if (arg != null)
// 执行数据校验
validateIfApplicable(binder, parameter);
if (binder.getBindingResult().hasErrors() && isBindExceptionRequired(binder, parameter))
throw new MethodArgumentNotValidException(parameter, binder.getBindingResult());
if (mavContainer != null)
mavContainer.addAttribute(BindingResult.MODEL_KEY_PREFIX + name, binder.getBindingResult());
return adaptArgumentIfNecessary(arg, parameter);
可以看到，resolveArgument()调用了validateIfApplicable()进行参数校验。
protected void validateIfApplicable(WebDataBinder binder, MethodParameter parameter)
// 获取参数注解，比如@RequestBody、@Valid、@Validated
Annotation[] annotations = parameter.getParameterAnnotations();
for (Annotation ann : annotations)
// 先尝试获取@Validated注解
Validated validatedAnn = AnnotationUtils.getAnnotation(ann, Validated.class);
//如果直接标注了@Validated，那么直接开启校验。
//如果没有，那么判断参数前是否有Valid起头的注解。
if (validatedAnn != null || ann.annotationType().getSimpleName().startsWith("Valid"))
Object hints = (validatedAnn != null ? validatedAnn.value() : AnnotationUtils.getValue(ann));
Object[] validationHints = (hints instanceof Object[] ? (Object[]) hints : new Object[] hints);
//执行校验
binder.validate(validationHints);
break;
看到这里，大家应该能明白为什么这种场景下@Validated、@Valid两个注解可以混用。我们接下来继续看WebDataBinder.validate()实现。
@Override
public void validate(Object target, Errors errors, Object... validationHints)
if (this.targetValidator != null)
processConstraintViolations(
//此处调用Hibernate Validator执行真正的校验
this.targetValidator.validate(target, asValidationGroups(validationHints)), errors);
最终发现底层最终还是调用了Hibernate Validator进行真正的校验处理。
方法级别的参数校验实现原理
上面提到的将参数一个个平铺到方法参数中，然后在每个参数前面声明约束注解的校验方式，就是方法级别的参数校验。
实际上，这种方式可用于任何Spring Bean的方法上，比如Controller/Service等。其底层实现原理就是AOP，具体来说是通过MethodValidationPostProcessor动态注册AOP切面，然后使用MethodValidationInterceptor对切点方法织入增强。
public class MethodValidationPostProcessor extends AbstractBeanFactoryAwareAdvisingPostProcessorimplements InitializingBean
@Override
public void afterPropertiesSet()
//为所有`@Validated`标注的Bean创建切面
Pointcut pointcut = new AnnotationMatchingPointcut(this.validatedAnnotationType, true);
//创建Advisor进行增强
this.advisor = new DefaultPointcutAdvisor(pointcut, createMethodValidationAdvice(this.validator));
//创建Advice，本质就是一个方法拦截器
protected Advice createMethodValidationAdvice(@Nullable Validator validator)
return (validator != null ? new MethodValidationInterceptor(validator) : new MethodValidationInterceptor());
接着看一下MethodValidationInterceptor：
public class MethodValidationInterceptor implements MethodInterceptor
@Override
public Object invoke(MethodInvocation invocation) throws Throwable
//无需增强的方法，直接跳过
if (isFactoryBeanMetadataMethod(invocation.getMethod()))
return invocation.proceed();
//获取分组信息
Class<?>[] groups = determineValidationGroups(invocation);
ExecutableValidator execVal = this.validator.forExecutables();
Method methodToValidate = invocation.getMethod();
Set<ConstraintViolation<Object>> result;
try
//方法入参校验，最终还是委托给Hibernate Validator来校验
result = execVal.validateParameters(
invocation.getThis(), methodToValidate, invocation.getArguments(), groups);
catch (IllegalArgumentException ex)
...
//有异常直接抛出
if (!result.isEmpty())
throw new ConstraintViolationException(result);
//真正的方法调用
Object returnValue = invocation.proceed();
//对返回值做校验，最终还是委托给Hibernate Validator来校验
result = execVal.validateReturnValue(invocation.getThis(), methodToValidate, returnValue, groups);
//有异常直接抛出
if (!result.isEmpty())
throw new ConstraintViolationException(result);
return returnValue;
实际上，不管是requestBody参数校验还是方法级别的校验，最终都是调用Hibernate Validator执行校验，Spring Validation只是做了一层封装。
springboot实现各种参数校验，写得太好了……(代码片段)
作者：伍陆七来源：https://juejin.cn/post/6856541106626363399之前也写过一篇关于SpringValidation使用的文章，不过自我感觉还是浮于表面，本次打算彻底搞懂SpringValidation。本文会详细介绍SpringValidation各种场景下的最佳实践... 查看详情
springboot进行优雅的字段校验，写得太好了！
点击关注公众号，Java干货及时送达作者：何甜甜在吗来源：juejin.cn/post/6913735652806754311前段时间提交代码审核，同事提了一个代码规范缺陷：参数校验应该放在controller层。到底应该如何做参数校验呢Controller层V... 查看详情
springboot进行优雅的字段校验，写得太好了！(代码片段)
作者：何甜甜在吗来源：juejin.cn/post/6913735652806754311前段时间提交代码审核，同事提了一个代码规范缺陷：参数校验应该放在controller层。到底应该如何做参数校验呢Controller层VSService层去网上查阅了一些资料，... 查看详情
springboot+redis实现各种操作，写得太好了吧！(代码片段)
来源：blog.csdn.net/qq_42105629/article/details/102589319一、Jedis,Redisson,Lettuce三者的区别共同点：都提供了基于Redis操作的JavaAPI，只是封装程度，具体实现稍有不同。不同点：1.1、Jedis是Redis的Java实现的客户端。支持基... 查看详情
springboot+webmagic实现网页爬虫，写得太好了！
...使用请参考官方文档：http://webmagic.io/docs/。本文是对springboot+WebMagic+MyBat 查看详情
springboot+webmagic实现网页爬虫，写得太好了！(代码片段)
作者：jessehua来源：www.jianshu.com/p/cfead4b3e34eWebMagic是一个开源的java爬虫框架。WebMagic框架的使用并不是本文的重点，具体如何使用请参考官方文档：http://webmagic.io/docs/。本文是对springboot+WebMagic+MyBatis做了整合& 查看详情
springboot+redis实现延时队列，写得太好了！(代码片段)
来源：blog.csdn.net/qq330983778/article/details/99341671业务流程首先我们分析下这个流程用户提交任务。首先将任务推送至延迟队列中。延迟队列接收到任务后，首先将任务推送至jobpool中，然后计算其执行时间。然后生成延迟... 查看详情
springboot+vue+shiro实现前后端分离，写得太好了！
...9813177.html本文总结自实习中对项目的重构。原先项目采用Springboot+freemarker模版，开发过程中觉得前端逻辑写的实在恶心，后端Controller层还必须返回Freemarker模版的 查看详情
springboot如何统计监控sql运行情况？写得太好了。。。
来源：juejin.cn/post/70625069231945810291基本概念Druid是Java语言中最好的数据库连接池。虽然HikariCP的速度稍快，但是，Druid能够提供强大的监控和扩展功能，也是阿里巴巴的开源项目。Druid是阿里巴巴开发的号称为监控... 查看详情
springboot如何统计监控sql运行情况？写得太好了。。。(代码片段)
来源：juejin.cn/post/70625069231945810291基本概念Druid是Java语言中最好的数据库连接池。虽然HikariCP的速度稍快，但是，Druid能够提供强大的监控和扩展功能，也是阿里巴巴的开源项目。Druid是阿里巴巴开发的号称为监控而生的数据库连... 查看详情
springboot+websocket打造实时监控异常，写得太好了！
点击关注公众号，Java干货及时送达来源：cnblogs.com/jae-tech/p/15409340.html写在前面此异常非彼异常，标题所说的异常是业务上的异常。最近做了一个需求，消防的设备巡检，如果巡检发现异常，通过手机端提... 查看详情
springcloud如何统一异常处理？写得太好了！
作者：BNDong链接：https://www.cnblogs.com/bndong/p/10135370.html前言在启动应用时会发现在控制台打印的日志中出现了两个路径为[/error]的访问地址，当系统中发送异常错误时，SpringBoot会根据请求方式分别跳转到以JS 查看详情
图解用户登录验证流程，写得太好了！
...前言本文通过图示及代码的方式介绍用户登录流程及技术实现，内容包括用户登录，用户验证，如何获取操作用户的信息以及一些黑名单及匿名接口如何免验证相关的实现。业务图解对于用户登录来说、涉及到了用户注册、登录... 查看详情
springboot如何统计监控sql运行情况？写得太好了。。。(代码片段)
来源：juejin.cn/post/70625069231945810291基本概念Druid是Java语言中最好的数据库连接池。虽然HikariCP的速度稍快，但是，Druid能够提供强大的监控和扩展功能，也是阿里巴巴的开源项目。Druid是阿里巴巴开发的号称为监控... 查看详情
springboot+websocket打造实时监控异常，写得太好了！(代码片段)
来源：cnblogs.com/jae-tech/p/15409340.html写在前面此异常非彼异常，标题所说的异常是业务上的异常。最近做了一个需求，消防的设备巡检，如果巡检发现异常，通过手机端提交，后台的实时监控页面实时获取到... 查看详情
sharding-jdbc实现读写分离+分库分表，写得太好了……(代码片段)
1、概览ShardingSphere-Jdbc定位为轻量级Java框架，在Java的Jdbc层提供的额外服务。它使用客户端直连数据库，以jar包形式提供服务，可理解为增强版的Jdbc驱动，完全兼容Jdbc和各种ORM框架2、MySQL主从复制1）、docker配... 查看详情
springboot+shiro前后端分离vue项目，写得太好了吧！
...，苦于找不到好的基础项目，于是我亲自录制了SpringBoot+Vue的前后端分离的综合项目，已经上传到B站，现在免费分享给大家！项目编写了详细的开发文档，包括前端和后端。只需要按照文档，结合讲... 查看详情
sharding-jdbc实现读写分离+分库分表，写得太好了！(代码片段)
点击关注公众号，Java干货及时送达1、概览ShardingSphere-Jdbc定位为轻量级Java框架，在Java的Jdbc层提供的额外服务。它使用客户端直连数据库，以jar包形式提供服务，可理解为增强版的Jdbc驱动，完全兼容Jdbc和各种... 查看详情