SpringBoot @Validated注解实现参数分组校验的方法实例

前言

在前后端分离开发的时候我们需要用到参数校验,前端需要进行参数校验,后端接口同样的也需要,以防传入不合法的数据。

1、首先还是先导包,导入pom文件。

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

2、解释一下注解的作用

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

3、在实体类加上要验证的字段。(我这里随便写下)

标注的地方就是用来分组校验的,下下面会解释。

@Data
public class LoginVo {

 @ApiModelProperty(value = "用户名称")
 @NotEmpty(message = "用户名不能为空!",groups = LoginModel.class)
 @NotEmpty(message = "添加时用户名不能为空!",groups = SaveModel.class)
 private String userName;

 @ApiModelProperty(value = "密码")
 @Size(min = 2,message = "密码最少为2位",groups = LoginModel.class)
 @Size(min = 6,message = "密码最少为6位",groups = SaveModel.class)
 private String password;
}

通过groups的属性来分组,假设我在使用登录分组校验的时候,设定用户名不能为空和密码最少为2位的验证。而在添加分组设定添加时用户名不能为空和密码最少为6位的验证。

4、在来解释下上面标注的分组接口。

LoginModel

import javax.validation.groups.Default;
public interface LoginModel extends Default {
}

必须继承默认的Defaut接口不然后抛出异常。

SaveModel

import javax.validation.groups.Default;
public interface SaveModel extends Default{
}

5、在controller的接口上加上@Validated注解,参数就加上你需要根据那种规则来校验。

 @ApiOperation(value = "登录以后返回token")
  @PostMapping(value = "/login")
  public Result login(@RequestBody @Validated(LoginModel.class) LoginVo loginVo) {
    String token = userService.login(loginVo.getUserName(), loginVo.getPassword());
    return Result.success(token);
  }

运行后只能在控制台显示错误的结果,新的问题又来了怎么把错误的结果通过自己的result类返回给前端。这就需要对错误全局捕捉了。

6、写一个对Response换回结果的处理。

@RestControllerAdvice
@Slf4j
public class ParameterCalibration {

  @ExceptionHandler({MethodArgumentNotValidException.class, BindException.class})
  @ResponseStatus(HttpStatus.OK)
  @ResponseBody
  public Result handleMethodArgumentNotValidException(Exception exception) {
    StringBuilder errorInfo = new StringBuilder();
    BindingResult bindingResult=null;
    if(exception instanceof MethodArgumentNotValidException){
      bindingResult= ((MethodArgumentNotValidException)exception).getBindingResult();
    }
    if(exception instanceof BindException){
      bindingResult= ((BindException)exception).getBindingResult();
    }
    for(int i = 0; i < bindingResult.getFieldErrors().size(); i++){
      if(i > 0){
        errorInfo.append(",");
      }
      FieldError fieldError = bindingResult.getFieldErrors().get(i);
      errorInfo.append(fieldError.getField()).append(" :").append(fieldError.getDefaultMessage());
    }
    log.error(errorInfo.toString());
    //这里返回自己的Result的结果类。
    return Result.validateFailed(errorInfo.toString());
  }

  @ExceptionHandler(Exception.class)
  @ResponseStatus(HttpStatus.BAD_REQUEST)
  @ResponseBody
  public Result handleDefaultException(Exception exception) {
    log.error(exception.toString());
     //这里返回自己的Result的结果类。
    return Result.validateFailed("服务器错误",exception);
  }
}

``

7. 先测试LoginModel的校验规则

控制台打印的数据

前端收到的数据

切换成SaveModel控制台打印的数据

切换成SaveModel前端收到的数据

可以看到两次的验证规则时不同的,完成了简易的分组操作。

8 、总结,就是在添加验证规则的时候指定对应的分组,在使用时传入需要的分组。可能理解有误,发现请指导。

总结

到此这篇关于SpringBoot @Validated注解实现参数分组校验的文章就介绍到这了,更多相关SpringBoot @Validated注解实现参数分组校验内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

(0)

相关推荐

  • springboot常用注释的讲解

    1:@Qualifier @Qualifier 注释指定注入 Bean 的名称,这样歧义就消除了.所以@Autowired 和@Qualifier 结合使用时,自动注入的策略就从 byType 转变成 byName 了.例子如下: 有一个接口: public interface EmployeeService { public String getEmployeeById(Long id); } 有两个实现类: @Service("service") public class Empl

  • Springboot @Validated和@Valid的区别及使用详解

    概述: @Valid是使用Hibernate validation的时候使用 @Validated是只用Spring Validator校验机制使用 说明:java的JSR303声明了@Valid这类接口,而Hibernate-validator对其进行了实现 @Validation对@Valid进行了二次封装,在使用上并没有区别,但在分组.注解位置.嵌套验证等功能上有所不同,这里主要就这几种情况进行说明. 注解位置: @Validated:用在类型.方法和方法参数上.但不能用于成员属性(fie

  • SpringBoot @Validated注解实现参数分组校验的方法实例

    前言 在前后端分离开发的时候我们需要用到参数校验,前端需要进行参数校验,后端接口同样的也需要,以防传入不合法的数据. 1.首先还是先导包,导入pom文件. <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency> 2.解释一下注解的作用 @N

  • SpringBoot接口如何对参数进行校验

    目录 前言 什么是不优雅的参数校验 实现案例 POM 请求参数封装 Controller中获取参数绑定结果 校验结果 进一步理解 Validation分组校验? @Validate和@Valid什么区别? 有哪些常用的校验? 自定义validation? 前言 在以SpringBoot开发Restful接口时, 对于接口的查询参数后台也是要进行校验的,同时还需要给出校验的返回信息放到上文我们统一封装的结构中.那么如何优雅的进行参数的统一校验呢? 什么是不优雅的参数校验 后端对前端传过来的参数也是

  • springboot @Valid注解对嵌套类型的校验功能

    @Valid注解可以实现数据的验证,你可以定义实体,在实体的属性上添加校验规则,而在API接收数据时添加@valid关键字,这时你的实体将会开启一个校验的功能,具体的代码如下,是最基本的应用: 实体: public class DepartmentDto { @ApiModelProperty("id") private String id; @ApiModelProperty("上级Id") private String parentId; @ApiModelPr

  • Spring boot进行参数校验的方法实例详解

    Spring boot开发web项目有时候我们需要对controller层传过来的参数进行一些基本的校验,比如非空.整数值的范围.字符串的长度.日期.邮箱等等.Spring支持JSR-303 Bean Validation API,可以方便的进行校验. 使用注解进行校验 先定义一个form的封装对象 class RequestForm { @Size(min = 1, max = 5) private String name; public String getName() { return n

  • Java使用@Validated注解进行参数验证的方法

    目前项目中大部分代码进行参数验证都是写代码进行验证,为了提升方便性和代码的简洁性,所以整理了下使用注解进行参数验证.使用效果如下: // 要验证的实体类 @Data public class User implements Serializable { @NotBlank(message = "id不能为空!",groups = Update.class) protected String id = ""; @NotBlank(message = "商户i

  • SpringBoot自定义注解使用读写分离Mysql数据库的实例教程

    需求场景 为了防止代码中有的SQL慢查询,影响我们线上主数据库的性能.我们需要将sql查询操作切换到从库中进行.为了使用方便,将自定义注解的形式使用. mysql导入的依赖 <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>8.0.16</version> </dependency&

  • SpringBoot启动执行sql脚本的3种方法实例

    目录 背景 配置application.yml文件 自定义DataSourceInitializer Bean 启动时执行方法 Springboot自动执行sql文件 总结 背景 项目里后端需要计算坐标距离,想用sql实现算法,然后通过执行一个sql脚本,创建一个函数供各业务调用.我们需要在springboot项目启动时执行sql脚本,在网上一顿搜索,总结了有三种做法: 配置application.yml文件 自定义DataSourceInitializer Bean 启动时执行方法 第一种做法

  • C#中参数个数可变的方法实例分析

    本文实例讲述了C#中参数个数可变的方法.分享给大家供大家参考.具体方法如下: 要实现C#中参数个数可变关键是使用params关键字.并且,可变参数只能是所有参数中的最后一个. 简单示例一下即可: 复制代码 代码如下: void ParamsExample(params string[] sz) { } void ParamsExample2(int i,string str,params string[] sz) { } void Main() {    ParamsExample("aa&qu

  • springboot FeignClient注解及参数

    一.FeignClient注解 FeignClient注解被@Target(ElementType.TYPE)修饰,表示FeignClient注解的作用目标在接口上 @FeignClient(name = "github-client", url = "https://api.github.com", configuration = GitHubExampleConfig.class) public interface GitHubClient { @Request

  • SpringBoot Java后端实现okhttp3超时设置的方法实例

    目录 前言 导入 okhttp3方法简介 两种版本超时设置用法 总结 前言 okhttp是一个处理网络请求的开源项目,是安卓端最火热的轻量级框架,由移动支付Square公司开发.OkHttp 是一个默认高效的 HTTP 客户端.OkHttp3是Java和Android都能用,Android还有一个著名网络库叫Volley,那个只有Android能用. okttp3的github官方地址是:官方地址 HTTP/2 支持允许对同一主机的所有请求共享一个套接字. 连接池减少了请求延迟(如果 HTTP/

随机推荐