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内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 一篇文章搞定Struts2的类型转换

    一篇文章搞定Struts2的类型转换

    这篇文章主要介绍了关于Struts2类型转换的相关资料,文中主要介绍了Struts2的类型转换器和自定义类型转换器的实现,有需要的朋友可以参考借鉴,下面来一起看看吧。
    2017-02-02
  • java IP归属地功能实现详解

    java IP归属地功能实现详解

    前一阵子抖音和微博开始陆续上了IP归属地的功能,引起了众多热议,有大批在国外的老铁们开始"原形毕露",被定位到国内来,那么IP归属到底是怎么实现的呢?那么网红们的归属地到底对不对呢
    2022-07-07
  • MyBatis中执行SQL语句的几种方式总结

    MyBatis中执行SQL语句的几种方式总结

    MyBatis是一个优秀的持久层框架,它支持定制化SQL、存储过程以及高级映射,下面这篇文章主要给大家介绍了关于MyBatis中执行SQL语句的几种方式,需要的朋友可以参考下
    2024-04-04
  • java 数学计算的具体使用

    java 数学计算的具体使用

    这篇文章主要介绍了java 数学计算的具体使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-01-01
  • SpringBoot实现文件下载功能的方式分享

    SpringBoot实现文件下载功能的方式分享

    这篇文章主要为大家详细介绍了SpringBoot这哪个实现文件下载功能的几种方式,文中的实现方法简介易懂,感兴趣的小伙伴可以跟随小编一起学习一下
    2023-03-03
  • Java Collection集合用法详解

    Java Collection集合用法详解

    首先Collection是属于单列集合的顶层接口,表示为一组对象。其类型为引用数据类型,具体创建对象,通过多态的形式进行,本文将给大家详细的介绍,需要的朋友可以参考下
    2021-10-10
  • 如何在 Linux 上搭建 java 部署环境(安装jdk/tomcat/mysql) + 将程序部署到云服务器上的操作)

    如何在 Linux 上搭建 java 部署环境(安装jdk/tomcat/mys

    这篇文章主要介绍了如何在 Linux 上搭建 java 部署环境(安装jdk/tomcat/mysql) + 将程序部署到云服务器上的操作),本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-01-01
  • CentOS 7下JDK8的详细安装步骤

    CentOS 7下JDK8的详细安装步骤

    这篇文章主要为大家介绍了CentOS 7下JDK8的详细安装步骤,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-11-11
  • 深入java事件注册的应用分析

    深入java事件注册的应用分析

    本篇文章是对java事件注册进行了详细的分析介绍,需要的朋友参考下
    2013-05-05
  • Spring中AOP概念与两种动态代理模式原理详解

    Spring中AOP概念与两种动态代理模式原理详解

    AOP是面向切面编程的技术,AOP基于IoC基础,是对OOP的有益补充,流行的AOP框架有Sping AOP、AspectJ,这篇文章主要给大家介绍了关于Spring中AOP概念与两种动态代理模式原理的相关资料,需要的朋友可以参考下
    2021-10-10

最新评论