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 阻塞队列和线程池原理分析

    这篇文章主要介绍了Java 阻塞队列和线程池原理分析,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • SpringBoot如何整合SpringDataJPA

    SpringBoot如何整合SpringDataJPA

    这篇文章主要介绍了SpringBoot整合SpringDataJPA代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-02-02
  • 关于SpringBoot打包测试、生产环境方式

    关于SpringBoot打包测试、生产环境方式

    这篇文章主要介绍了关于SpringBoot打包测试、生产环境方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-09-09
  • Mybatis的@select和@SelectProvider注解方式动态SQL语句解读

    Mybatis的@select和@SelectProvider注解方式动态SQL语句解读

    这篇文章主要介绍了Mybatis的@select和@SelectProvider注解方式动态SQL语句,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-12-12
  • mybatis-plus 拦截器敏感字段加解密的实现

    mybatis-plus 拦截器敏感字段加解密的实现

    数据库在保存数据时,对于某些敏感数据需要脱敏或者加密处理,本文主要介绍了mybatis-plus 拦截器敏感字段加解密的实现,感兴趣的可以了解一下
    2021-11-11
  • springboot整合spring-data-redis遇到的坑

    springboot整合spring-data-redis遇到的坑

    使用springboot整合redis,使用默认的序列化配置,然后使用redis-client去查询时查询不到相应的key.问题出在哪,怎么解决呢?下面小编给大家带来了springboot整合spring-data-redis遇到的坑,需要的的朋友参考下吧
    2017-04-04
  • java方法实现简易ATM功能

    java方法实现简易ATM功能

    这篇文章主要为大家详细介绍了用java方法实现简易ATM功能,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-04-04
  • java datetime数据类型去掉时分秒的案例详解

    java datetime数据类型去掉时分秒的案例详解

    在Java中,如果我们想要表示一个日期而不包括时间(时分秒),我们通常会使用java.time包中的LocalDate类,这篇文章主要介绍了java datetime数据类型去掉时分秒,需要的朋友可以参考下
    2024-06-06
  • Java泛型最全知识总结

    Java泛型最全知识总结

    面试被问到Java泛型怎么办,有了这篇文章,让你直接保送,文中有非常详细的知识总结及相关代码示例,需要的朋友可以参考下
    2021-06-06
  • Linux系统下搭建Java开发环境

    Linux系统下搭建Java开发环境

    本文主要是记录了如何在Linux环境下一步步安装JAVA JDK环境,非常简单实用,有需要的朋友可以参考下
    2014-10-10

最新评论