Spring validation参数校验基本使用

最新推荐文章于 2024-05-21 20:40:02 发布

2401_83641314

最新推荐文章于 2024-05-21 20:40:02 发布

阅读量421

点赞数 23

分类专栏：程序员文章标签： spring java 后端

本文链接：https://blog.csdn.net/2401_83641314/article/details/138046347

版权

程序员专栏收录该内容

506 篇文章 0 订阅

订阅专栏

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;
 **自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。**

**深知大多数Python工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！**

**因此收集整理了一份《2024年Python开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。**

![img](https://img-blog.csdnimg.cn/img_convert/64bf80f682a5e1d6bff3f93a5ee91914.png)

![img](https://img-blog.csdnimg.cn/img_convert/f19d973937ac5f179295ab7b846e3ace.png)

![img](https://img-blog.csdnimg.cn/img_convert/ea35a89f96ac958d6bde4c62623123ae.png)

![img](https://img-blog.csdnimg.cn/img_convert/38b78380da6d900cb139031888ccf23d.png)

![img](https://img-blog.csdnimg.cn/img_convert/6c361282296f86381401c05e862fe4e9.png)

![img](https://img-blog.csdnimg.cn/img_convert/9f49b566129f47b8a67243c1008edf79.png)

**既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上前端开发知识点，真正体系化！**

**由于文件比较大，这里只是将部分目录大纲截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且后续会持续更新**

**如果你觉得这些内容对你有帮助，可以扫码获取！！！（备注：Python）**

img-4Jryhs2B-1713706671403)]

[外链图片转存中...(img-mUoxSkdj-1713706671403)]

[外链图片转存中...(img-JfbNotWR-1713706671404)]

![img](https://img-blog.csdnimg.cn/img_convert/6c361282296f86381401c05e862fe4e9.png)

![img](https://img-blog.csdnimg.cn/img_convert/9f49b566129f47b8a67243c1008edf79.png)

**既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上前端开发知识点，真正体系化！**

**由于文件比较大，这里只是将部分目录大纲截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且后续会持续更新**

**如果你觉得这些内容对你有帮助，可以扫码获取！！！（备注：Python）**

![](https://img-blog.csdnimg.cn/img_convert/7ec90ca91218ef8aceed41a38e739136.jpeg)

2401_83641314

关注

23
点赞
踩
9

收藏

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

注：被注释的@InEnum为自定义的注解，后文讲解。3、在Controller方法中，使用@Valid或@Validated注解开启数据校验功能。项目启动后，分别访问上面的两个接口，返回信息如下：访问addmember1接口时，校验失败抛异常。访问addmember2，校验失败时，抛异常。注：在类中必须添加@Validated注解访问getbyname，校验失败时，抛异常。
复制链接

扫一扫