spring validation多层对象校验教程

 更新时间:2021年10月20日 11:23:54   作者:xixingzhe2  
这篇文章主要介绍了spring validation多层对象校验教程,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

spring validation多层对象校验

1、第一层对象定义

import java.io.Serializable; 
import javax.validation.Valid;
/**   
 * 请求参数
 * @Title: ReqIn.java 
 * @Package com.spring.pro.model 
 * @Description:  
 * @author ybwei  
 * @date 2018年9月18日 下午1:43:26 
 * @version V1.0   
 */
public class ReqIn<T> implements Serializable{ 
 private static final long serialVersionUID = 25549320423002325L;
 /**
  * 请求头信息
  */
 private String head;
 /**
  * 请求主体信息
  */
 @Valid
 private T data;
 public String getHead() {
  return head;
 }
 public void setHead(String head) {
  this.head = head;
 }
 public T getData() {
  return data;
 }
 public void setData(T data) {
  this.data = data;
 }
}

2、第二层对象

import java.io.Serializable; 
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
/**   
 * @Title: User.java 
 * @Package com.spring.pro.model 
 * @Description:  
 * @author ybwei  
 * @date 2018年9月18日 下午1:46:15 
 * @version V1.0   
 */
public class User implements Serializable{ 
 private static final long serialVersionUID = 6747944028911495569L;
 private String id;
 @NotBlank
 private String name;
 @NotNull
 private Integer age;
 public String getId() {
  return id;
 }
 public void setId(String id) {
  this.id = id;
 }
 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;
 }
}

3、Controller层校验使用

import javax.validation.Valid; 
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController; 
import com.alibaba.fastjson.JSON;
import com.spring.pro.model.ReqIn;
import com.spring.pro.model.User;
/**   
 * @Title: UserController.java 
 * @Package com.spring.pro.controller 
 * @Description:  
 * @author ybwei  
 * @date 2018年9月18日 下午1:48:14 
 * @version V1.0   
 */
@RestController
public class UserController {
 private Logger logger=LoggerFactory.getLogger(getClass());
 
 /**
  * 校验
  * @param reqIn
  * @return
  * @author ybwei
  */
 @PostMapping("/valid")
 public HttpStatus valid(@Valid @RequestBody ReqIn<User> reqIn){
  logger.info("reqIn:{}",JSON.toJSONString(reqIn));
  return HttpStatus.OK;
 }
}

validation校验对象多个字段返回的消息内容顺序随机问题

问题描述

model中的代码如下

public class User {
  @NotNull(message = "id不能为空", groups = UserGroup.UPDATE.class)
  protected Integer id;
  /**
   * 姓名
   */
  @NotBlank(message = "请输入姓名", groups = UserGroup.ADD.class)
  private String name;
  /**
   * 性别
   */
  @NotBlank(message = "请输入性别", groups = UserGroup.ADD.class)
  private String sex;
  /**
   * 手机号
   */
  @NotBlank(message = "请输入手机号", groups = UserGroup.ADD.class)
  private String phone;
  /**
   * 邮箱
   */
  @NotBlank(message = "请输入邮箱", groups = UserGroup.ADD.class)
  private String email;
  /**
   * 公司名
   */
  @NotBlank(message = "请输入公司名", groups = UserGroup.ADD.class)
  private String companyName;
  /**
   * 职务
   */
  @NotBlank(message = "请输入职务", groups = UserGroup.ADD.class)
  private String position;
}

定义的分组接口如下

public interface UserGroup {
  interface ADD {
  }
  interface UPDATE {
  }
}

在使用Spring的@Validated注解对对象中的多个参数进行校验时,在MethodArgumentNotValidException异常拦截器处发现如果有多个条件不符和校验规则的参数,MethodArgumentNotValidException中的bindingResult.getAllErrors()异常消息集合中的数据是按照随机顺序返回的,按照正常逻辑来说,我们肯定是想要按顺序将第一个不符合规范字段错误信息返回给用户。

解决办法

经过一番搜索发现可以给类上每个验证的注解都指定不同的group,然后在创建一个interface接口添加@GroupSequence对加在字段上的那些接口进行汇总,如下:

public interface UserGroup {
  @GroupSequence({ADD.NAME.class,
                  ADD.SEX.class,
                  ADD.PHONE.class,
                  ADD.EMAIL.class,
                  ADD.COMPANY_NAME.class,
                  ADD.POSITION.class})
  interface ADD {
    interface NAME {}
    interface SEX {}
    interface PHONE {}
    interface EMAIL {}
    interface COMPANY_NAME {}
    interface POSITION {}
  }
  interface UPDATE {
  }
}

Model

@NoArgsConstructor
public class User {
  @NotNull(message = "id不能为空", groups = UserGroup.UPDATE.class)
  protected Integer id;
  /**
   * 姓名
   */
  @NotBlank(message = "请输入姓名", groups = UserGroup.ADD.NAME.class)
  private String name;
  /**
   * 性别 1.男 2.女 3.未知
   */
  @NotBlank(message = "请输入性别", groups = UserGroup.ADD.SEX.class)
  private String sex;
  /**
   * 手机号
   */
  @NotBlank(message = "请输入手机号", groups = UserGroup.ADD.PHONE.class)
  private String phone;
  /**
   * 邮箱
   */
  @NotBlank(message = "请输入邮箱", groups = UserGroup.ADD.EMAIL.class)
  private String email;
  /**
   * 公司名
   */
  @NotBlank(message = "请输入公司名", groups = UserGroup.ADD.COMPANY_NAME.class)
  private String companyName;
  /**
   * 职务
   */
  @NotBlank(message = "请输入职务", groups = UserGroup.ADD.POSITION.class)
  private String position;
}

在@GroupSequence注解中指定设置的接口数组顺序,然后在参数进行校验的时候直接在@Validated注解中放入UserGroup.ADD.class这个接口类即可public Result add(@Validated(UserGroup.ADD.class) @RequestBody User user),validation就会按照顺序返回错误信息,在异常拦截器中直接这样取出第一个错误信息即可MethodArgumentNotValidException.getBindingResult().getAllErrors().get(0).getDefaultMessage()

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

相关文章

  • java面向对象的三大特性之一继承用法实例分析

    java面向对象的三大特性之一继承用法实例分析

    这篇文章主要介绍了java面向对象的三大特性之一继承用法,结合实例形式分析了java面向对象程序设计中继承的基本原理与具体使用方法,需要的朋友可以参考下
    2019-11-11
  • JAVA异常分类和处理解析

    JAVA异常分类和处理解析

    这篇文章主要介绍了JAVA异常分类和处理解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-08-08
  • java分页工具类的使用方法

    java分页工具类的使用方法

    这篇文章主要为大家详细介绍了java分页工具类的使用方法,稳定的分页效果,包括导航页码功能,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-03-03
  • 详谈HashMap和ConcurrentHashMap的区别(HashMap的底层源码)

    详谈HashMap和ConcurrentHashMap的区别(HashMap的底层源码)

    下面小编就为大家带来一篇详谈HashMap和ConcurrentHashMap的区别(HashMap的底层源码)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-08-08
  • 在IDEA中安装MyBatis Log Plugin插件,执行mybatis的sql语句(推荐)

    在IDEA中安装MyBatis Log Plugin插件,执行mybatis的sql语句(推荐)

    这篇文章主要介绍了在IDEA中安装MyBatis Log Plugin插件,执行mybatis的sql语句,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-07-07
  • Java连接redis及基本操作示例

    Java连接redis及基本操作示例

    这篇文章主要介绍了Java连接redis及基本操作,结合实例形式较为详细的分析了java针对redis数据库的基本连接、配置及操作相关实现技巧,需要的朋友可以参考下
    2019-04-04
  • Mybatis分解式查询使用方法

    Mybatis分解式查询使用方法

    这篇文章主要介绍了Mybatis分解式查询使用方法,分解式查询就是将一条Sql语句拆分成多条。在 MyBatis 多表查询中,使用连接查询时一个 Sql 语句就可以查询出所有的数据
    2023-04-04
  • 解决IDEA中下载free maven plugin插件无效的问题

    解决IDEA中下载free maven plugin插件无效的问题

    这篇文章主要介绍了解决IDEA中下载free maven plugin插件无效的问题,本文通过图文并茂的形式给大家分享解决方案,供大家参考,需要的朋友可以参考下
    2020-11-11
  • Java 中Timer和TimerTask 定时器和定时任务使用的例子

    Java 中Timer和TimerTask 定时器和定时任务使用的例子

    这篇文章主要介绍了Java 中Timer和TimerTask 定时器和定时任务使用的例子,非常具有实用价值,需要的朋友可以参考下
    2017-05-05
  • Scheduler定时任务调度详解

    Scheduler定时任务调度详解

    文章介绍了SysJobServiceImpl类中定时任务调度的相关方法,包括清除、检查存在性、创建、暂停、恢复、删除任务,以及触发任务,并提到了JobKey、CronUtils、ScheduleUtils、SpringUtils等工具类的使用,适用于Spring管理环境
    2025-01-01

最新评论