1. 分组验证

有的时候，我们对一个实体类需要有多中验证方式，在不同的情况下使用不同验证方式，比如说对于一个实体类来的 id 来说，新增的时候是不需要的，对于更新时是必须的，这个时候你是选择写一个实体类呢还是写两个呢？

在自定有数据有效性校验注解中介绍到注解需要有一个 groups 属性，这个属性的作用又是什么呢？

接下来就让我们看看如何用一个验证类实现多个接口之间不同规则的验证…

2.本章目标

利用一个验证类实现多个接口之间不同规则的验证…

3.具体代码

非常简单…

3.1 导入依赖

在 pom.xml 中添加上 spring-boot-starter-web 的依赖即可

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>com.lin</groupId>
	<artifactId>springboot-validator-groups</artifactId>
	<version>0.0.1-SNAPSHOT</version>

	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.0.5.RELEASE</version>
		<relativePath /> <!-- lookup parent from repository -->
	</parent>

	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
		<java.version>1.8</java.version>
	</properties>

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
	</dependencies>

	<build />
</project>

3.2 分组验证器

定义一个验证组，里面写上不同的空接口类即可

package com.lin.groups;

/**
 * 验证组
 * @author Mengmeng Lin
 * @time 2019年1月29日 上午11:48:46
 */
public class Groups {

	public interface update{
		
	}
	
	public interface Default{
		
	}
}

3.3 实体类

groups 属性的作用就让 @Validated 注解只验证与自身 value 属性相匹配的字段，可多个，只要满足就会去纳入验证范围；我们都知道针对新增的数据我们并不需要验证 ID 是否存在，我们只在做修改操作的时候需要用到，因此这里将 ID 字段归纳到 Groups.Update.class 中去，而其它字段是不论新增还是修改都需要用到所以归纳到 Groups.Default.class 中…

package com.lin.pojo;

import java.math.BigDecimal;

import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;

import com.lin.groups.Groups;

public class Book {

	@NotNull(message = "id 不能为空", groups = Groups.update.class)
	private Integer id;
	@NotBlank(message = "name 不允许为空", groups = Groups.Default.class)
	private String name;
	@NotNull(message = "price不允许为空", groups = Groups.Default.class)
	private BigDecimal price;

	public Integer getId() {
		return id;
	}

	public void setId(Integer id) {
		this.id = id;
	}

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public BigDecimal getPrice() {
		return price;
	}

	public void setPrice(BigDecimal price) {
		this.price = price;
	}

}

3.4 控制层

创建一个 ValidateController 类，然后定义好 insert、update 俩个方法，比由于 insert 方法并不关心 ID 字段，所以这里 @Validated 的 value 属性写成 Groups.Default.class 就可以了；而 update 方法需要去验证 ID 是否为空，所以此处 @Validated 注解的 value 属性值就要写成 Groups.Default.class, Groups.Update.class；代表只要是这分组下的都需要进行数据有效性校验操作…

package com.lin.controller;

import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import com.lin.groups.Groups;
import com.lin.pojo.Book;

@RestController
public class ValidateController {

	@GetMapping("/insert")
	public String insert(@Validated(value = Groups.Default.class) Book book){
		return "success";
	}
	
	@GetMapping("/update")
	public String update(@Validated(value = {Groups.Default.class, Groups.update.class}) Book book){
		return "success";
	}
}

3.5 主函数

package com.lin;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class ApplicationValidateGroups {

	public static void main(String[] args) throws Exception {
		SpringApplication.run(ApplicationValidateGroups.class, args);
	}

}

3.6 测试

完成准备事项后，启动 ApplicationValidateGroups 自行测试即可，测试手段相信大伙都不陌生了，如浏览器、postman、junit、swagger，此处基于 postman，如果你觉得自带的异常信息不够友好，那么配上一起来学SpringBoot | 第十八篇：轻松搞定全局异常可以轻松搞定…

insert 接口

在这里插入图片描述

update 接口

在这里插入图片描述
两个接口参数内容一致，都缺少 id 字段，但 insert 是成功的，而 update 接口中提示了 id 不能为空；
测试结果表明，符合我们的预期要求。

【转自】https://blog.battcn.com/2018/06/07/springboot/v2-other-validate3/

【转】一起来学SpringBoot | 第二十一篇：轻松搞定数据验证（三）

目录：