使用@RequestBody配合@Valid校验入参参数

更新时间：2022年03月15日 09:41:07 作者：击水三千里

这篇文章主要介绍了使用@RequestBody配合@Valid校验入参参数，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教

@RequestBody配合@Valid校验入参参数

自定义一个Controller

import com.example.demo.pojo.User;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController; 
import javax.validation.Valid;
/**
 * @Author: luoye
 * @Date: 2018-10-12
 */
@RestController
public class ValiController {
    @PostMapping(value = "/",produces = "application/json;charset=UTF-8")
    public User vali(@RequestBody @Valid User user){
        return user;
    }
}

自定义实体类

import javax.validation.constraints.Max;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
 
/**
 * @Author: luoye
 * @Date: 2018-10-12
 */
public class User {
    @NotBlank(message = "这个姓名不能为空")
    private String name;
    @NotNull(message = "这个年龄不能为空")
    @Max(value = 105,message = "太大了")
    private Integer age;
 
    public String getName() {
        return name;
    }
 
    public void setName(String name) {
        this.name = name;
    }
 
    public Integer getAge() {
        return age;
    }
 
    public void setAge(Integer age) {
        this.age = age;
    }
}

自定义全局异常处理器

import com.example.demo.pojo.ErrorMsg;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ResponseBody;
 
import java.util.ArrayList;
import java.util.List;
 
/**
 * @Author luoye
 * @Date: 2018/10/12 16:50
 */
@ControllerAdvice
public class ExceptionHandlerContrller { 
 
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    public List<ErrorMsg> exception(MethodArgumentNotValidException e) {
        BindingResult bindingResult = e.getBindingResult();
        List<ObjectError> allErrors = bindingResult.getAllErrors();
        List<ErrorMsg> errorMsgs = new ArrayList<>();
 
        allErrors.forEach(objectError -> {
            ErrorMsg errorMsg = new ErrorMsg();
            FieldError fieldError = (FieldError)objectError;
            errorMsg.setField(fieldError.getField());
            errorMsg.setObjectName(fieldError.getObjectName());
            errorMsg.setMessage(fieldError.getDefaultMessage());
            errorMsgs.add(errorMsg);
        });
        return errorMsgs;
    }
}

PostMan测试下

[
    {
        "field": "name",
        "message": "这个姓名不能为空",
        "objectName": "user"
    },
    {
        "field": "age",
        "message": "这个年龄不能为空",
        "objectName": "user"
    }
]

附录

@Valid 注解类型的使用：

@Null：限制只能为null
@NotNull：限制必须不为null
@AssertFalse：限制必须为false
@AssertTrue：限制必须为true
@DecimalMax(value)：限制必须为一个不大于指定值的数字
@DecimalMin(value)：限制必须为一个不小于指定值的数字
@Digits(integer,fraction)：限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction
@Future：限制必须是一个将来的日期
@Max(value)：限制必须为一个不大于指定值的数字
@Min(value)：限制必须为一个不小于指定值的数字
@Past：限制必须是一个过去的日期
@Pattern(value)：限制必须符合指定的正则表达式
@Size(max,min)：限制字符长度必须在min到max之间
@Past：验证注解的元素值（日期类型）比当前时间早
@NotEmpty：验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）
@NotBlank：验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的空格
@Email：验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email格式

@Valid校验@RequestBody的参数

希望通过注解校验post请求的body

需要用到@Valid注解

public String getResponse(@RequestBody @Valid MyRequest request) throws Exception {
	xxx
}

在request实体类添加注解进行校验

例如用@NotNull进行判空校验

@Data
public class MyRequest {
    @NotNull(message = "id 不能为空")
    private Integer id;
    @NotNull(message = "name 不能为空")
    private String name;
}

结合统一异常处理，处理MethodArgumentNotValidException

可以返回注解配置的错误信息

@ControllerAdvice
@Slf4j
public class ExceptionResolver {
    @ExceptionHandler(value = {Exception.class})
    @ResponseBody
    public String handleOtherExceptions(final Exception ex) {
        if (ex instanceof MethodArgumentNotValidException) {
            // 入参校验错误
            StringBuilder msg = new StringBuilder();
            MethodArgumentNotValidException mex = (MethodArgumentNotValidException) ex;
            BindingResult bindingResult = mex.getBindingResult();
            List<ObjectError> allErrors = bindingResult.getAllErrors();
            allErrors.forEach(objectError -> {
                FieldError fieldError = (FieldError) objectError;
                String oneMsg = fieldError.getDefaultMessage();
                msg.append(oneMsg);
                msg.append(";");
            });
            return msg.toString();
        } 
    }
}

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

mybatis实现增删改查_动力节点Java学院整理
本文通过实例代码给大家介绍了mybatis实现增删改查功能，非常不错，具有参考借鉴价值，需要的朋友参考下吧
2017-09-09
Java计算两个程序运行时间的实例
下面小编就为大家带来一篇Java计算两个程序运行时间的实例。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-04-04
SpringBoot中使用configtree读取树形文件目录中的配置详解
这篇文章主要介绍了SpringBoot中使用configtree读取树形文件目录中的配置详解,configtree通过spring.config.import + configtree:前缀的方式,加载以文件名为key、文件内容为value的配置属性,需要的朋友可以参考下
2023-12-12
Java访问数据库实例详解
这篇文章主要为大家详细介绍了Java访问数据库实例，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-03-03
Java concurrency之共享锁和ReentrantReadWriteLock_动力节点Java学院整理
本篇文章主要介绍了Java concurrency之共享锁和ReentrantReadWriteLock，非常具有实用价值，需要的朋友可以参考下
2017-06-06
Java编程思想对象的容纳实例详解
这篇文章主要介绍了Java编程思想对象的容纳实例详解，内容比较详细，涵盖的东西也比较多，具有参考价值，需要的朋友了解下。
2017-09-09
Java单链表的增删改查与面试题详解
单链表是链表的其中一种基本结构。一个最简单的结点结构如图所示，它是构成单链表的基本结点结构。在结点中数据域用来存储数据元素，指针域用于指向下一个具有相同结构的结点。因为只有一个指针结点，称为单链表
2022-09-09
Java实现驼峰与下划线互转的方法
这篇文章主要为大家详细介绍了Java实现驼峰与下划线互转的方法,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
2024-04-04
如何利用Java Agent 做Spring MVC Controller 层的出参入参打印日志
本文介绍了如何使用JavaAgent进行Spring MVC Controller层的出参入参打印日志,首先,建立了一个包含javassist和fastJSON依赖的Agent jar工程,并创建了一个Agent类,然后,编译并部署了这个Agent jar,最后,在Demo Web工程中启用Agent以实现日志打印
2024-11-11
详解MyBatis 常用写法
MyBatis 是一款优秀的持久层框架，它支持定制化 SQL、存储过程以及高级映射。这篇文章给大家介绍了MyBatis 常用写法，感兴趣的朋友跟随小编一起看看吧
2018-11-11