Springboot结合@validated优化代码验证

更新时间：2022年08月23日 09:37:55 作者：weixin_47088026

这篇文章主要介绍了Springboot与@validated注解结合从而实现让你的代码验证更清爽，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

创建项目

创建spring-boot项目，这里我网络不好，就创建普通maven项目，通过依赖手动完成spring-boot项目创建。

添加注解

<parent>
        <artifactId>spring-boot-starter-parent</artifactId>
        <groupId>org.springframework.boot</groupId>
        <version>2.7.2</version>
</parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>2.7.2</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.24</version>
        </dependency>
		<!-- 数据验证的依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>
    </dependencies>

常用注解说明

@AssertFalse 校验false
@AssertTrue 校验true
@DecimalMax(value=,inclusive=) 小于等于value，inclusive=true,是小于等于
@DecimalMin(value=,inclusive=) 与上类似
@Max(value=) 小于等于value
@Min(value=) 大于等于value
@NotNull 检查Null
@Past 检查日期
@Pattern(regex=,flag=) 正则
@Size(min=, max=) 字符串，集合，map限制大小
@Validate 对po实体类进行校验

创建实体类

package com.hopeful.pojo;
import lombok.Data;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
import java.io.Serializable;
@Data
public class User implements Serializable {
    private Integer id;
    @NotNull(message = "姓名不能为空")
    private String name;
    @NotNull
    @Size(min = 6,message = "密码不能没空，且不能少于6位")
    private String pwd;
}

创建controller

package com.hopeful;
import com.hopeful.pojo.User;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
@RequestMapping("/user")
@RestController
public class controller {
    @RequestMapping("/hello")
    public String hello() {
        return "hello";
    }
    @PostMapping("/insertUser")
    public String insert2(@Validated @RequestBody User user) {
        System.out.println(user);
        return "新增成功";
    }
}

数据验证失败，会报错，需要处理

数据验证失败处理

方法一：controller处理

package com.hopeful;
import com.hopeful.pojo.User;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
import java.util.List;
@RequestMapping("/user")
@RestController
public class controller {
    @RequestMapping("/hello")
    public String hello() {
        return "hello";
    }
    @GetMapping("/insertUser")
    public User insert(@Validated User user) {
        return user;
    }
    @PostMapping("/insertUser")
    public String insert2(@Validated @RequestBody User user, BindingResult bindingResult) {
        if(bindingResult.hasErrors()) {
            String msg = "";
            msg = getString(bindingResult, msg);
            return msg;
        }
        System.out.println(user);
        return "新增成功";
    }
    public static String getString(BindingResult bindingResult, String msg) {
        List<FieldError> fieldErrors = bindingResult.getFieldErrors();
        int size = fieldErrors.size();
        for (int i = 0; i < size; i++) {
            FieldError fieldError = fieldErrors.get(i);
            if(fieldError != null) {
                msg += fieldError.getDefaultMessage();
            }
            if(i < size - 1) {
                msg += ";";
            }
        }
        return msg;
    }
}

方法二：全局异常处理

我们建议使用全局异常处理。

创建全局异常处理

package com.hopeful.pojo.common;
import org.springframework.validation.BindException;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
import javax.validation.ConstraintViolationException;
import javax.validation.ValidationException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
@ControllerAdvice
@ResponseBody
public class globalException extends RuntimeException {
    @ExceptionHandler(value = {BindException.class, ValidationException.class,MethodArgumentNotValidException.class})
    public String MethodArgumentNotValidException(Exception e) {
        String msg = "";
        if (e instanceof MethodArgumentNotValidException) {
            BindingResult bindingResult = ((MethodArgumentNotValidException) e).getBindingResult();
            // getFieldError获取的是第一个不合法的参数(P.S.如果有多个参数不合法的话)
            //FieldError fieldError = bindingResult.getFieldError();
            //if (fieldError != null) {
            //    msg = fieldError.getDefaultMessage();
            //}
            List<FieldError> fieldErrors = bindingResult.getFieldErrors();
            int size = fieldErrors.size();
            for (int i = 0; i < size; i++) {
                FieldError fieldError = fieldErrors.get(i);
                if(fieldError != null) {
                    msg += fieldError.getDefaultMessage();
                }
                if(i < size - 1) {
                    msg += ";";
                }
            }
        } else if (e instanceof BindException) {
            // getFieldError获取的是第一个不合法的参数(P.S.如果有多个参数不合法的话)
            FieldError fieldError = ((BindException) e).getFieldError();
            if (fieldError != null) {
                msg = fieldError.getDefaultMessage();
            }
        } else if (e instanceof ConstraintViolationException) {
            /*
             * ConstraintViolationException的e.getMessage()形如
             *     {方法名}.{参数名}: {message}
             *  这里只需要取后面的message即可
             */
            msg = e.getMessage();
            if (msg != null) {
                int lastIndex = msg.lastIndexOf(':');
                if (lastIndex >= 0) {
                    msg = msg.substring(lastIndex + 1).trim();
                }
            }
            /// ValidationException 的其它子类异常
        } else {
            msg = "处理参数时异常";
        }
        return msg;
    }
}

##测试

结果如下：

到此这篇关于Springboot结合@validated优化代码验证的文章就介绍到这了,更多相关Springboot @validated内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java实现聊天机器人完善版
这篇文章主要为大家详细介绍了Java实现聊天机器人完善版，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-07-07
Spring IOC xml方式进行工厂Bean操作详解
这篇文章主要介绍了Spring IOC xml方式进行工厂Bean操作，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习吧
2023-01-01
深入浅析Mybatis的缺陷问题
Mybatis是业界非常流行的持久层框架，轻量级、易用，在金融IT领域完全是领军地位，比Hibernate更受欢迎，优势非常多，也是非常值得我们学习的。这篇文章主要介绍了Mybatis的缺陷问题的相关资料,需要的朋友可以参考下
2016-10-10
Java中的NoClassDefFoundError报错含义解析
这篇文章主要为大家介绍了Java中的NoClassDefFoundError含义详解，有需要的朋友可以借鉴参考下，希望能够有所帮助
2023-11-11
Spring框架JavaMailSender发送邮件工具类详解
这篇文章主要为大家详细介绍了Spring框架JavaMailSender发送邮件工具类，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-04-04
超简单的java获取鼠标点击位置坐标的实例（鼠标在Jframe上的坐标）
在Java窗体Jframe上获取鼠标点击的坐标，其中使用了匿名内部类,实例代码非常简单易懂，大家可以学习一下
2018-03-03
java数组输出的实例代码
这篇文章主要介绍了java数组输出的实例代码，有需要的朋友可以参考一下
2013-12-12
java实现表格数据的存储
这篇文章主要为大家详细介绍了java实现表格数据的存储，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-04-04
用Java进行zip文件压缩与解压缩
这篇文章主要介绍了用Java进行zip文件压缩与解压缩的方法，帮助大家更好的理解和使用Java，感兴趣的朋友可以了解下
2020-12-12
Maven依赖管理之parent与dependencyManagement深入分析
首先我们来说说parent标签，其实这个不难解释，就是父的意思，pom也有继承的。比方说我现在有A，B，C，A是B，C的父级。现在就是有一个情况B，C其实有很多jar都是共同的，其实是可以放在父项目里面，这样，让B，C都继承A就方便管理了
2022-10-10