Spring validation参数校验基本使用

JingAi_jia917

已于 2024-04-22 15:27:35 修改

阅读量1.2k

点赞数 33

于 2024-04-01 08:54:19 首次发布

本文链接：https://blog.csdn.net/JingAi_jia917/article/details/137116880

版权

Spring validation参数校验系列

1、Spring validation参数校验基本使用

2、Spring validation参数校验之自定义校验规则及编程式校验等进阶篇

3、【源码】Spring validation参数校验原理解析之Controller控制器参数校验中@RequestBody参数校验实现原理

4、【源码】Spring validation参数校验原理解析之Controller控制器参数校验中@ModelAttribute及实体类参数校验实现原理

5、【源码】Spring validation参数校验原理解析之基本类型参数及Service层方法参数校验实现原理

6、【源码】Spring validation校验的核心类ValidatorImpl、MetaDataProvider和AnnotationMetaDataProvider源码分析

7、Spring validation参数校验高级篇之跨参数校验Cross-Parameter及分组序列校验@GroupSequenceProvider、@GroupSequence

8、【源码】Spring validation参数校验之跨参数校验Cross-Parameter原理分析

 9、【源码】Spring validation参数校验之分组序列校验@GroupSequenceProvider、@GroupSequence的实现原理

前言

在日常的开发工作中，为了程序的健壮性，大部分方法都需要进行入参数据有效性的校验。最直接的方法是在方法内对数据进行手动判断。如下：

    private static final Pattern MOBILE_PHONE_PATTERN = Pattern.compile("^(13[0-9]|14[579]|15[012356789]|16[6]|17[0135678]|18[0-9]|19[89])\\d{8}$");

    @PostMapping("saveuser1")
    public Map<String, Object> save1(@RequestBody UserVo user) {
        if (!StringUtils.hasText(user.getName())) {
            throw new IllegalArgumentException("姓名不能为空");
        }
        if (!StringUtils.hasText(user.getGender())) {
            throw new IllegalArgumentException("性别不能为空");
        }
        if(!StringUtils.hasText(user.getPhone())) {
            throw new IllegalArgumentException("手机号不能为空");
        }
        if(!MOBILE_PHONE_PATTERN.matcher(user.getPhone()).find()) {
            throw new IllegalArgumentException(("手机号格式错误"));
        }
        // 省略其他代码
        return ResponseUtil.success();
    }

为了减少一些if/else，也可以使用Spring的Assert写出如下比较优雅的代码：

    private static final Pattern MOBILE_PHONE_PATTERN = Pattern.compile("^(13[0-9]|14[579]|15[012356789]|16[6]|17[0135678]|18[0-9]|19[89])\\d{8}$");

    @PostMapping("saveuser2")
    public Map<String, Object> save2(@RequestBody UserVo user) {
        Assert.hasText(user.getName(), "姓名不能为空");
        Assert.hasText(user.getGender(), "性别不能为空");
        Assert.hasText(user.getPhone(), "手机号不能为空");
        if(!MOBILE_PHONE_PATTERN.matcher(user.getPhone()).find()) {
            throw new IllegalArgumentException(("手机号格式错误"));
        }
        // 省略其他代码
        return ResponseUtil.success();
    }

上面的两种方式虽然可以满足参数合法性校验，但当参数比较多的时候，扩展性、可读性以及复用性都比较差。

为了解决上述的问题，Validation框架诞生了，专门用来进行方法参数校验。

Java在2009年提出了Bean Validation（JSR）[1]规范，其中定义了一系列的校验注解，如@NotNull、@Size等，通过注解的方式对字段进行校验，避免在业务逻辑中耦合冗余的校验逻辑。

基本使用

1、引入依赖

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

注：从 springboot-2.3.x开始，spring-boot-starter-web不再引入 spring-boot-starter-validation，所以需要额外手动引入validation依赖，而 2.3之前的版本只需要引入 web 依赖。本文使用springboot-2.5.5的版本。

注解	功能
@AssertFalse	可以为null,如果不为null的话必须为false
@AssertTrue	可以为null,如果不为null的话必须为true
@DecimalMax	设置不能超过最大值
@DecimalMin	设置不能超过最小值
@Digits	设置必须是数字且数字整数的位数和小数的位数必须在指定范围内
@Future	日期必须在当前日期的未来
@Past	日期必须在当前日期的过去
@Max	最大不得超过此最大值
@Min	最大不得小于此最小值
@NotNull	不能为null，可以是空
@Null	必须为null
@Pattern	必须满足指定的正则表达式
@Size	集合、数组、map等的size()值必须在指定范围内
@Email	必须是email格式
@Length	长度必须在指定范围内
@NotBlank	字符串不能为null,字符串trim()后也不能等于空字符串
@NotEmpty	不能为null，集合、数组、map等size()不能为0；字符串trim()后可以等于空字符串
@Range	值必须在指定范围内
@URL	必须是一个URL

2、在方法的入参对应的自定义对象中配置校验注解：

package com.jingai.validation.vo;

import lombok.Data;

import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Pattern;

@Data
public class MemberVo {

    private int id;
    @NotBlank(message = "会员名称不能为空")
    private String name;

    @NotBlank(message = "性别不能为空")
//    @InEnum(enumType = GenderEnum.class, message = "性别不在枚举范围中")
    private String gender;

    @Min(value = 18, message = "年龄必须大于18岁")
    @Max(value = 200, message = "年龄必须小于200岁")
    private Integer age;
    @NotBlank(message = "手机号码不能为空")
    @Pattern(regexp = "^(13[0-9]|14[579]|15[012356789]|16[6]|17[0135678]|18[0-9]|19[89])\\d{8}$", message = "手机号码格式错误")
    private String phone;

}

注：被注释的@InEnum为自定义的注解，后文讲解。

3、在Controller方法中，使用@Valid或@Validated注解开启数据校验功能。

3.1 对象参数使用，代码如下：

package com.jingai.validation.controller;

import com.jingai.validation.util.ResponseUtil;
import com.jingai.validation.vo.MemberVo;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.Map;

@RestController
public class MemberController {

    /**
     * 前面加@RequestBody注解时，校验失败时，抛MethodArgumentNotValidException异常
     */
    @RequestMapping("addmember1")
    public Map<String, Object> addMember1(@RequestBody @Validated MemberVo member) {
        // 省略其他代码
        return ResponseUtil.success();
    }

    /**
     * 没有添加@RequestBody，校验失败抛BindException异常
     */
    @RequestMapping("addmember2")
    public Map<String, Object> addMember2(@Validated MemberVo member) {
        // 省略其他代码
        return ResponseUtil.success();
    }

}

项目启动后，分别访问上面的两个接口，返回信息如下：

访问addmember1接口时，校验失败抛MethodArgumentNotValidException异常。

访问addmember2，校验失败时，抛BindException异常。

3.2 基本类型使用，代码如下：

package com.jingai.validation.controller;

import com.jingai.validation.service.MemberService;
import com.jingai.validation.util.ResponseUtil;
import com.jingai.validation.vo.MemberVo;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;
import javax.validation.constraints.NotBlank;
import java.util.Map;

@RestController
@Validated
public class MemberController2 {

    /**
     * 注意：需要在类中加上@Validated注解。校验失败时，抛出ConstraintViolationException异常
     * @param name
     * @return
     */
    @GetMapping("getbyname")
    public Map<String, Object> getByName(@NotBlank(message = "会员名称不能为空") String name) {
        // 省略其他代码
        return ResponseUtil.success(String.format("获取会员：%s，年龄：20", name));
    }


}

注：在类中必须添加@Validated注解

访问getbyname，校验失败时，抛ConstraintViolationException异常。

全局异常处理

通过前面的测试，如果参数校验失败，三种使用场景会抛出三种异常，分别为MethodArgumentNotValidException、BindException和ConstraintViolationException异常，每种异常的响应格式又不一致。在项目开发中，可以添加一个异常捕获器来返回一个统一且友好的格式来提示。代码如下：

package com.jingai.validation.servlet;

import com.jingai.validation.util.RespCode;
import com.jingai.validation.util.ResponseUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.NotReadablePropertyException;
import org.springframework.validation.BindException;
import org.springframework.validation.BindingResult;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import java.util.Map;
import java.util.stream.Collectors;

/**
 * Validation校验异常处理器
 */
@Slf4j
@RestControllerAdvice
public class ValidationExceptionHandler {

    /**
     * 添加@RequestBody注解的校验失败抛MethodArgumentNotValidException异常
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Map<String, Object> handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
        log.error("参数校验异常", e);
        return ResponseUtil.response(RespCode.PARAM_ERROR, getErrorMessages(e.getBindingResult()));
    }

    /**
     * 不加@RequestBody注解的校验失败抛BindException异常
     */
    @ExceptionHandler(BindException.class)
    public Map<String, Object> handleBindException(BindException e) {
        log.error("参数校验异常", e);
        return ResponseUtil.response(RespCode.PARAM_ERROR, getErrorMessages(e.getBindingResult()));
    }

    /**
     * 基本数据类型添加@NotBlank等注解校验失败抛ConstraintViolationException异常
     */
    @ExceptionHandler(ConstraintViolationException.class)
    public Map<String, Object> handleConstraintViolationException(ConstraintViolationException e) {
        log.error("参数校验异常", e);
        String msg = e.getConstraintViolations().stream()
                .map(ConstraintViolation::getMessage).collect(Collectors.joining("；"));
        return ResponseUtil.response(RespCode.PARAM_ERROR, msg);
    }

    @ExceptionHandler({NotReadablePropertyException.class})
    public Map<String, Object> handleNotReadablePropertyException(NotReadablePropertyException e) {
        log.error("参数校验异常", e);
        return ResponseUtil.response(RespCode.PARAM_ERROR, e.getMessage());
    }

    private String getErrorMessages(BindingResult bindingResult) {
        return bindingResult.getAllErrors().stream()
                .map(ObjectError::getDefaultMessage).collect(Collectors.joining("；"));
    }

}

添加了统一异常处理之后再次访问如上的接口。

快速失败配置

从上面的测试中发现，Spring-validation不仅校验手机号，也校验了性别，如果还有别的属性，也都会一并校验，相对来说，校验更多的属性会消耗更多的资源，Spring-validation支持通过配置实现快速失败响应返回。代码如下：

package com.jingai.validation.config;

import org.hibernate.validator.HibernateValidator;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.validation.beanvalidation.MethodValidationPostProcessor;

import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;

@Configuration
public class AppConfig {

    @Bean
    public Validator validator() {
        ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)
                .configure()
                // 只要出现校验失败的情况就立即结束校验
                .failFast(true)
                .buildValidatorFactory();
        return validatorFactory.getValidator();
    }

    @Bean
    public MethodValidationPostProcessor validationPostProcessor() {
        MethodValidationPostProcessor methodValidationPostProcessor = new MethodValidationPostProcessor();
        methodValidationPostProcessor.setValidator(validator());
        return methodValidationPostProcessor;
    }

}

再次访问addmember接口

借助Spring-validation，可以非常简单、优雅的完成方法参数校验。假设后续对象新增了参数，只需要添加一个注解，而无需修改业务代码。

分组校验

针对上面的例子，添加的时候主键是不需要的，所以不用添加参数约束注解，但如果是修改的话，通常是需要通过主键进行修改，这时候难不成在方法内部独自判断？Spring-validation为了处理类似的问题，引入了分组。

1、@Valid和@Validated的区别

在开始讨论分组校验之前，需要区分一下@Valid和@Validated的区别。

1）@Valid注解，是 Bean Validation 所定义，可以添加在普通方法、构造方法、方法参数、方法返回、成员变量上，表示它们需要进行约束校验。

2）@Validated注解，是 Spring Validation 所定义，可以添加在类、方法参数、普通方法上，表示它们需要进行约束校验。

两者的区别在于@Validated有value属性，支持分组校验，@Valid支持嵌套校验，可以添加在成员变量上。

注：上面示例中没有指定分组，则默认使用javax.validation.groups.Default分组进行校验。

2、在方法的入参对应的自定义对象中配置校验注解，并添加分组：

2.1 分组定义

package com.jingai.validation.groups;

public interface UserValidatedGroup {

    interface Create extends UserValidatedGroup {}
    interface Update extends UserValidatedGroup {}
    interface Query extends UserValidatedGroup {}

}

2.2 在方法的入参对应的自定义对象中配置校验注解，并指定分组：

package com.jingai.validation.vo;

import com.jingai.validation.custom.GenderEnum;
import com.jingai.validation.custom.InEnum;
import com.jingai.validation.groups.UserValidatedGroup;
import lombok.Data;

import javax.validation.constraints.*;

@Data
public class UserVo {

    @NotNull(message = "用户id不能为null", groups = {UserValidatedGroup.Query.class, UserValidatedGroup.Update.class})
    @Min(value = 1, message = "用户id无效")
    private Integer id;

    @NotBlank(message = "用户名称不能为空", groups = {UserValidatedGroup.Create.class, UserValidatedGroup.Update.class})
    private String name;

    @NotBlank(message = "性别不能为空", groups = {UserValidatedGroup.Create.class, UserValidatedGroup.Update.class})
    //@InEnum(enumType = GenderEnum.class, message = "性别不在枚举范围中", groups = {UserValidatedGroup.Create.class, UserValidatedGroup.Update.class})
    private String gender;

    @NotNull(message = "年龄不能为空", groups = {UserValidatedGroup.Create.class, UserValidatedGroup.Update.class})
    @Min(value = 18, message = "年龄必须大于18岁", groups = {UserValidatedGroup.Create.class, UserValidatedGroup.Update.class})
    @Max(value = 200, message = "年龄必须小于200岁", groups = {UserValidatedGroup.Create.class, UserValidatedGroup.Update.class})
    private Integer age;

    @NotBlank(message = "手机号码不能为空", groups = {UserValidatedGroup.Create.class, UserValidatedGroup.Update.class})
    @Pattern(regexp = "^(13[0-9]|14[579]|15[012356789]|16[6]|17[0135678]|18[0-9]|19[89])\\d{8}$", message = "手机号码格式错误")
    private String phone;
}

注：被注释的@InEnum为自定义的注解，后文讲解。

3、在Controller方法中，使用@Valid或@Validated注解开启数据校验功能。

package com.jingai.validation.controller;

import com.jingai.validation.custom.RequestListValidated;
import com.jingai.validation.custom.ValidList;
import com.jingai.validation.groups.UserValidatedGroup;
import com.jingai.validation.service.UserService;
import com.jingai.validation.util.ResponseUtil;
import com.jingai.validation.vo.UserVo;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;
import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import javax.validation.Validator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.regex.Pattern;

@RestController
public class UserController {

    @Resource
    private UserService userService;

    @RequestMapping("adduser")
    public Map<String, Object> add(@RequestBody @Validated(value = UserValidatedGroup.Create.class) UserVo user) {
        // 省略其他代码
        return ResponseUtil.success();
    }

    @RequestMapping("updateuser")
    public Map<String, Object> update(@RequestBody @Validated(UserValidatedGroup.Update.class) UserVo user) {
        // 省略其他代码
        return ResponseUtil.success();
    }

    @RequestMapping("getuser")
    public Map<String, Object> get(@Validated(UserValidatedGroup.Query.class) UserVo user) {
        // 省略其他代码
        return ResponseUtil.success();
    }

}

访问adduer，效果如下：

访问getuser，效果如下：

Service中校验

更多情况下是需要对Service层的接口进行参数校验的，那么该如何配置呢？在校验方法入参的约束时，如果是@Override父类或接口的方法，入参约束只能写在父类或接口上面。示例如下：

1、定义接口

package com.jingai.validation.service;

import com.jingai.validation.custom.ValidList;
import com.jingai.validation.groups.UserValidatedGroup;
import com.jingai.validation.vo.UserVo;
import org.springframework.validation.annotation.Validated;

import javax.validation.Valid;
import javax.validation.constraints.Min;

@Validated
public interface UserService {

    @Validated(value = UserValidatedGroup.Create.class)
    int save(@Valid UserVo user);

    UserVo get(@Min(message = "id无效", value = 1) int id);
}

注：此处save方法添加@Validated注解，在方法参数中，添加@Valid注解

2、实现类

package com.jingai.validation.service.impl;

import com.jingai.validation.custom.ValidList;
import com.jingai.validation.service.UserService;
import com.jingai.validation.vo.UserVo;
import org.springframework.stereotype.Service;

import javax.validation.Valid;
import javax.validation.constraints.Min;

@Service
public class UserServiceImpl implements UserService {

    @Override
    public int save(UserVo user) {
        // 省略其他业务逻辑
        return 1;
    }

    @Override
    public UserVo get(@Min(message = "id无效", value = 1) int id) {
        // 省略其他业务逻辑
        return new UserVo();
    }


}

3、Controller控制类，在控制类中，无需添加校验注解

package com.jingai.validation.controller;

import com.jingai.validation.custom.RequestListValidated;
import com.jingai.validation.custom.ValidList;
import com.jingai.validation.groups.UserValidatedGroup;
import com.jingai.validation.service.UserService;
import com.jingai.validation.util.ResponseUtil;
import com.jingai.validation.vo.UserVo;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;
import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import javax.validation.Validator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.regex.Pattern;

@RestController
public class UserController {

    @Resource
    private UserService userService;

    @RequestMapping("save")
    public Map<String, Object> save(@RequestBody UserVo user) {
        int id = userService.save(user);
        return ResponseUtil.success(id);
    }

    @RequestMapping("get")
    public Map<String, Object> get(int id) {
        userService.get(id);
        // 省略其他代码
        return ResponseUtil.success();
    }


}

访问save接口，效果如下：

总结

限于篇幅，本次分享的Spring validation就到这边，Spring validation自定义校验规则、集合校验、编程式校验等留到下一篇分享。推荐大家在项目中使用。

如果大家有更优雅的处理方式，欢迎在评论区一起交流探讨下吧。

如果有需要源码的，可以在评论区留下邮箱，看到后第一时间回复。

JingAi_jia917

关注

33
点赞
踩
16

收藏

觉得还不错? 一键收藏
0
评论
Spring validation参数校验基本使用

本篇从基础使用开始层层深入讲解Spring validation的使用。分享了不同场景下校验失败时抛的MethodArgumentNotValidException、BindException，ConstraintViolationException异常及全局异常处理，同时分享了快速失败设置、分组校验以及在Service中Spring validation校验的使用
复制链接

扫一扫