spring-boot-starter-validation字段数据校验

validation

概述

spring-boot-starter-validation是 Spring Boot 官方提供的用于数据校验的启动器，它基于 Bean Validation API (JSR 380) 标准，并默认使用 Hibernate Validator 作为其实现。这个框架能让你通过声明式的注解，轻松地对控制器接收的参数、服务层的方法参数以及任何 Java Bean 进行校验，确保数据的完整性和有效性。

添加依赖

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-validation</artifactId></dependency>

常用注解

自定义注解

定义注解

@Target({ElementType.FIELD})@Retention(RetentionPolicy.RUNTIME)@Constraint(validatedBy=PhoneValidator.class)// 指定校验器public@interfacePhone{Stringmessage()default"手机号格式不正确";Class<?>[]groups()default{};Class<?extendsPayload>[]payload()default{};}

实现校验逻辑

publicclassPhoneValidatorimplementsConstraintValidator<Phone,String>{privatestaticfinalStringPHONE_REGEX="^1[3-9]\\d{9}$";@OverridepublicbooleanisValid(Stringvalue,ConstraintValidatorContextcontext){returnvalue!=null&&value.matches(PHONE_REGEX);}}

使用自定义注解

publicclassUserDTO{@PhoneprivateStringphoneNumber;}

实战开发步骤

在DTO中定义校验规则

将校验注解直接添加到数据传输对象（DTO）的字段上，并可以通过message属性自定义错误信息。

publicclassUserCreateRequest{@NotBlank(message="用户名不能为空")@Size(max=50,message="用户名长度不能超过50")privateStringname;@Email(message="邮箱格式不正确")privateStringemail;@Min(value=18,message="年龄必须大于等于18")privateIntegerage;// getters and setters...}

在Controller层触发校验

在控制器方法的参数前使用@Valid或@Validated注解，即可触发对该参数的校验。

@RestController@RequestMapping("/users")publicclassUserController{@PostMappingpublicResponseEntity<String>createUser(@RequestBody@ValidUserCreateRequestrequest){// 如果校验通过，代码会执行到这里returnResponseEntity.ok("用户创建成功");}}

@Valid与@Validated的区别

统一处理校验异常

校验失败会抛出MethodArgumentNotValidException异常。通常使用@RestControllerAdvice进行全局统一处理，向客户端返回结构化的错误信息。

@RestControllerAdvicepublicclassGlobalExceptionHandler{@ExceptionHandler(MethodArgumentNotValidException.class)publicResponseEntity<Map<String,String>>handleValidationException(MethodArgumentNotValidExceptionex){Map<String,String>errors=newHashMap<>();// 收集所有字段错误信息ex.getBindingResult().getFieldErrors().forEach(err->errors.put(err.getField(),err.getDefaultMessage()));returnResponseEntity.badRequest().body(errors);}}

分组校验

分组校验允许你在不同场景下应用不同的校验规则，例如创建（Create）和更新（Update）操作。

定义分组接口

publicclassUserGroups{publicinterfaceCreate{}publicinterfaceUpdate{}}

在DTO中指定分组

publicclassUserDTO{// 创建时ID必须为null，更新时ID不能为null@Null(groups=UserGroups.Create.class)@NotNull(groups=UserGroups.Update.class)privateLongid;@NotBlank(groups={UserGroups.Create.class,UserGroups.Update.class})privateStringusername;// getters and setters...}

在Controller中使用指定分组

@PostMapping("/create")publicStringcreate(@RequestBody@Validated(UserGroups.Create.class)UserDTOuser){...}@PutMapping("/update")publicStringupdate(@RequestBody@Validated(UserGroups.Update.class)UserDTOuser){...}