SpringBoot入门建站全系列（三十三）集成validator校验接口数据

深藏阁楼爱情的钟 2023-06-15 07:11 24阅读 0赞

### SpringBoot入门建站全系列（三十三）集成validator校验接口数据 ###

### 一、概述 ###

在开发中经常需要写一些字段校验的代码，比如字段非空，字段长度限制，邮箱格式验证等等,如果我们直接将这些校验写死在代码里，将会遇到这种现象：

1.  验证代码繁琐，重复劳动
2.  方法内代码显得冗长
3.  代码可读性不高

所以，我们可以使用hibernate validator来对字段的校验工作统一完成。

spring-boot-starter-web中默认引入了hibernate-validator，因此，在SpringBoot项目中，我们可以直接使用hibernate-validator的特性。

*这一篇篇文章本应该放在SpringBoot入门建站全系列的前面章节讲述，这里权做对该系列的补充了。*

首发地址：

[品茗IT: https://www.pomit.cn/p/2437125163256321][IT_ https_www.pomit.cn_p_2437125163256321]

**如果大家正在寻找一个java的学习环境，或者在开发中遇到困难，可以[加入我们的java学习圈，点击即可加入][java]，共同学习，节约学习时间，减少很多在学习中遇到的难题。**

### 二、基础知识 ###

**首先，基础知识是必须要了解的，我这里整理了下最新的注解，比网上一下子搜到的博客更全面。**

validator的功能是由hibernate-validator提供的，所以在Spring官方文档里是找不到关于它的说明的，需要到hibernate-validator官网查看：  
[https://docs.jboss.org/hibernate/stable/validator/reference/en-US/html\_single/\#section-builtin-constraints][https_docs.jboss.org_hibernate_stable_validator_reference_en-US_html_single_section-builtin-constraints]

<table> 
 <thead> 
 <tr> 
 <th>注解</th> 
 <th>释义</th> 
 <th>场景</th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td>@AssertFalse</td> 
 <td>验证注解的元素值是false</td> 
 <td>Boolean, boolean</td> 
 </tr> 
 <tr> 
 <td>@AssertTrue</td> 
 <td>验证注解的元素值是true</td> 
 <td>Boolean, boolean</td> 
 </tr> 
 <tr> 
 <td>@DecimalMax（value=x）</td> 
 <td>验证注解的元素值小于等于@ DecimalMax指定的value值</td> 
 <td>BigDecimal，BigInteger，CharSequence，byte，short，int，long和原始类型的相应的包装类;</td> 
 </tr> 
 <tr> 
 <td>@DecimalMin（value=x）</td> 
 <td>验证注解的元素值小于等于@ DecimalMin指定的value值</td> 
 <td>BigDecimal，BigInteger，CharSequence，byte，short，int，long和原始类型的相应的包装类;</td> 
 </tr> 
 <tr> 
 <td>@Digits(integer=整数位数, fraction=小数位数)</td> 
 <td>验证注解的元素值的整数位数和小数位数上限</td> 
 <td>BigDecimal的，BigInteger，CharSequence，byte，short，int，long和原始类型的相应的包装类;</td> 
 </tr> 
 <tr> 
 <td>@Future</td> 
 <td>检查带注释的日期是否是将来</td> 
 <td>java.util.Date，java.util.Calendar，java.time.Instant，java.time.LocalDate，java.time.LocalDateTime，java.time.LocalTime，java.time.MonthDay，java.time.OffsetDateTime，java.time.OffsetTime，java.time.Year，java.time.YearMonth，java.time.ZonedDateTime，java.time.chrono.HijrahDate，java.time.chrono.JapaneseDate，java.time.chrono.MinguoDate，java.time.chrono.ThaiBuddhistDate;</td> 
 </tr> 
 <tr> 
 <td>@FutureOrPresent</td> 
 <td>检查带注释的日期是现在还是将来</td> 
 <td>java.util.Date，java.util.Calendar，java.time.Instant，java.time.LocalDate，java.time.LocalDateTime，java.time.LocalTime，java.time.MonthDay，java.time.OffsetDateTime，java.time.OffsetTime，java.time.Year，java.time.YearMonth，java.time.ZonedDateTime，java.time.chrono.HijrahDate，java.time.chrono.JapaneseDate，java.time.chrono.MinguoDate，java.time.chrono.ThaiBuddhistDate;</td> 
 </tr> 
 <tr> 
 <td>@Max（value=x）</td> 
 <td>验证注解的元素值小于等于@Max指定的value值</td> 
 <td>BigDecimal，BigInteger，byte，short，int，long和原始类型的相应的包装类;</td> 
 </tr> 
 <tr> 
 <td>@Min（value=x）</td> 
 <td>验证注解的元素值大于等于@Min指定的value值</td> 
 <td>BigDecimal，BigInteger，byte，short，int，long和原始类型的相应的包装类;</td> 
 </tr> 
 <tr> 
 <td>@NotNull</td> 
 <td>验证注解的元素值不是null</td> 
 <td>任意</td> 
 </tr> 
 <tr> 
 <td>@Null</td> 
 <td>验证注解的元素值是null</td> 
 <td>任意</td> 
 </tr> 
 <tr> 
 <td>@Past</td> 
 <td>检查带注释的日期是否是过去</td> 
 <td>java.util.Date，java.util.Calendar，java.time.Instant，java.time.LocalDate，java.time.LocalDateTime，java.time.LocalTime，java.time.MonthDay，java.time.OffsetDateTime，java.time.OffsetTime，java.time.Year，java.time.YearMonth，java.time.ZonedDateTime，java.time.chrono.HijrahDate，java.time.chrono.JapaneseDate，java.time.chrono.MinguoDate，java.time.chrono.ThaiBuddhistDate;</td> 
 </tr> 
 <tr> 
 <td>@PastOrPresent</td> 
 <td>检查带注释的日期是过去还是现在</td> 
 <td>java.util.Date，java.util.Calendar，java.time.Instant，java.time.LocalDate，java.time.LocalDateTime，java.time.LocalTime，java.time.MonthDay，java.time.OffsetDateTime，java.time.OffsetTime，java.time.Year，java.time.YearMonth，java.time.ZonedDateTime，java.time.chrono.HijrahDate，java.time.chrono.JapaneseDate，java.time.chrono.MinguoDate，java.time.chrono.ThaiBuddhistDate;</td> 
 </tr> 
 <tr> 
 <td>@Pattern(regex=正则表达式, flag=)</td> 
 <td>验证注解的元素值与指定的正则表达式匹配</td> 
 <td>CharSequence</td> 
 </tr> 
 <tr> 
 <td>@Size(min=最小值, max=最大值)</td> 
 <td>验证注解的元素值的在min和max（包含）指定区间之内，如字符长度、集合大小</td> 
 <td>CharSequence，Collection，Map和数组</td> 
 </tr> 
 <tr> 
 <td>@Valid</td> 
 <td>验证关联的对象，如账户对象里有一个订单对象，指定验证订单对象</td> 
 <td>Any non-primitive type（引用类型）</td> 
 </tr> 
 <tr> 
 <td>@NotEmpty</td> 
 <td>验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）</td> 
 <td>CharSequence，Collection，Map和数组</td> 
 </tr> 
 <tr> 
 <td>@Range(min=最小值, max=最大值)</td> 
 <td>验证注解的元素值在最小值和最大值之间</td> 
 <td>CharSequence, Collection, Map and Arrays,BigDecimal, BigInteger, CharSequence, byte, short, int, long and the respective wrappers of the primitive types</td> 
 </tr> 
 <tr> 
 <td>@NotBlank</td> 
 <td>验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的空格</td> 
 <td>CharSequence</td> 
 </tr> 
 <tr> 
 <td>@Length(min=下限, max=上限)</td> 
 <td>验证注解的元素值长度在min和max区间内</td> 
 <td>CharSequence</td> 
 </tr> 
 <tr> 
 <td>@Email</td> 
 <td>验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email格式</td> 
 <td>CharSequence</td> 
 </tr> 
 <tr> 
 <td>@Negative</td> 
 <td>检查元素是否严格为负。零值被视为无效。</td> 
 <td>BigDecimal，BigInteger，byte，short，int，long和原始类型的相应的包装类</td> 
 </tr> 
 <tr> 
 <td>@NegativeOrZero</td> 
 <td>检查元素是负数还是零。</td> 
 <td>BigDecimal，BigInteger，byte，short，int，long和原始类型的相应的包装类</td> 
 </tr> 
 <tr> 
 <td>@Positive</td> 
 <td>检查元素是否严格为正。零值被视为无效。</td> 
 <td>BigDecimal，BigInteger，byte，short，int，long和原始类型的相应的包装类</td> 
 </tr> 
 <tr> 
 <td>@NegativeOrZero</td> 
 <td>检查元素是正数还是零。</td> 
 <td>BigDecimal，BigInteger，byte，short，int，long和原始类型的相应的包装类</td> 
 </tr> 
 <tr> 
 <td>@URL(protocol=, host=, port=, regexp=, flags=)</td> 
 <td>检查字符序列是否为有效URL。</td> 
 <td>CharSequence</td> 
 </tr> 
 <tr> 
 <td>@CreditCardNumber</td> 
 <td>检查带注释的字符序列是否通过了Luhn校验和测试。</td> 
 <td>CharSequence</td> 
 </tr> 
 <tr> 
 <td>@Currency</td> 
 <td>检查带注释的货币单位javax.money.MonetaryAmount是否为指定货币单位的一部分。</td> 
 <td>CharSequence</td> 
 </tr> 
 <tr> 
 <td>@DurationMax</td> 
 <td>检查带注释的java.time.Duration元素不大于由注释参数构造的元素。</td> 
 <td>java.time.Duration</td> 
 </tr> 
 <tr> 
 <td>@DurationMin</td> 
 <td>检查带注释的java.time.Duration元素不少于由注释参数构造的元素。</td> 
 <td>java.time.Duration</td> 
 </tr> 
 <tr> 
 <td>@EAN</td> 
 <td>检查带注释的字符序列是有效的EAN条形码。</td> 
 <td>CharSequence</td> 
 </tr> 
 <tr> 
 <td>@ISBN</td> 
 <td>检查带注释的字符序列是有效的ISBN。</td> 
 <td>CharSequence</td> 
 </tr> 
 <tr> 
 <td>@CodePointLength</td> 
 <td>验证带注释的字符序列的代码点长度在之间min并max包括在内。</td> 
 <td>CharSequence</td> 
 </tr> 
 <tr> 
 <td>@LuhnCheck</td> 
 <td>检查带注释的字符序列中的数字是否通过Luhn校验和算法</td> 
 <td>CharSequence</td> 
 </tr> 
 <tr> 
 <td>@Mod10Check</td> 
 <td>检查带注释的字符序列中的数字是否通过通用mod 10校验和算法。</td> 
 <td>CharSequence</td> 
 </tr> 
 <tr> 
 <td>@Mod11Check</td> 
 <td>检查带注释的字符序列中的数字是否通过了mod 11校验和算法。</td> 
 <td>CharSequence</td> 
 </tr> 
 <tr> 
 <td>@SafeHtml</td> 
 <td>检查带注释的值是否包含潜在的恶意片段，例如<h3><a rel="nofollow"></a>三、实体校验</h3> 假设当前有个实体叫userInfo <h4><a rel="nofollow"></a>3.1 实体</h4> <pre><code>package com.cff.springbootwork.validator.vo;

import java.util.Date;
import java.util.List;

import javax.validation.constraints.AssertFalse;
import javax.validation.constraints.AssertTrue;
import javax.validation.constraints.Digits;
import javax.validation.constraints.Email;
import javax.validation.constraints.Future;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.Negative;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Null;
import javax.validation.constraints.Past;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Positive;
import javax.validation.constraints.Size;

import org.hibernate.validator.constraints.Length;
import org.hibernate.validator.constraints.Range;
import org.hibernate.validator.constraints.URL;

import com.fasterxml.jackson.annotation.JsonFormat;

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class UserInfo { 
	@Null(message = "创建时间不能填")
	@JsonFormat(pattern = "yyyy-MM-dd", locale = "zh", timezone = "GMT+8")
	private Date createTime;
	
	@NotEmpty(message = "用户名不能为空")
	private String userName;

@NotBlank(message = "姓名不能为空或空字符串")
	private String name;

@Negative(message = "冬天温度在0°以下")
	private Integer temperatureWinter;
	
	@Positive(message = "夏天温度在0°以上")
	private Integer temperatureSummer;
	
	@Digits(integer = 11, message = "手机号是11位整数哦", fraction = 0)
	private String mobile;
	
	@NotNull(message = "年龄不能为空")
	@Min(value = 10, message = "年龄太小了")
	@Max(value = 35, message = "年龄太大了")
	private Integer age;

@Size(min = 0, max = 2, message = "你女朋友个数在0-2之间")
	private List&lt;String&gt; girlFrinds;
	
	@Range(min = 0, max = 100, message = "你钱包里的钱在0-2之间")
	private Integer money;
	
	@Length(min = 4, max = 64, message = "地址在4-64之间")
	private String address;

@AssertTrue(message = "对象必须是人")
	private Boolean people;

@AssertFalse(message = "不能上来就删除")
	private Boolean delete;
	
	@Pattern(regexp="[0-9]{6}",message = "密码格式错误")
	private String password;

@Email(message = "email格式错误")
	private String email;

@JsonFormat(pattern = "yyyy-MM-dd", locale = "zh", timezone = "GMT+8")
	@Future(message = "失效时间比当前时间晚")
	private Date expireTime;
	
	@JsonFormat(pattern = "yyyy-MM-dd", locale = "zh", timezone = "GMT+8")
	@Past(message = "出生日期比当前时间早")
	private Date birthDate;
	
	@URL(message = "url填写错误")
	private String url;
}

</code></pre> <h4><a rel="nofollow"></a>3.2 Web层数据接收</h4> 只需要加上@Valid注解即可，然后通过BindingResult来接收校验错误。 <pre><code>	@RequestMapping(value = "/test")
	public List&lt;String&gt; set(@Valid @RequestBody UserInfo userInfo, BindingResult bindingResult) { 
		if (bindingResult.hasErrors()) { 
			List&lt;String&gt; errorMsg = bindingResult.getAllErrors().stream().map(s -&gt; s.getDefaultMessage())
					.collect(Collectors.toList());
			return errorMsg;
		}
		return Collections.singletonList("0000");
	}
</code></pre> 这里，是打印了所有错误结果，如果只校验是否错误,抛出第一个错误，这样写即可： <pre><code>@RequestMapping(value = "/test")
	public List&lt;String&gt; set(@Valid @RequestBody UserInfo userInfo, BindingResult bindingResult) { 
		if (bindingResult.hasErrors()) { 
			String errorMsg = bindingResult.getAllErrors().get(0).getDefaultMessage();
			return Collections.singletonList(errorMsg);
		}
		return Collections.singletonList("0000");
	}

</code></pre> <h4><a rel="nofollow"></a>3.3 校验不通过测试</h4> <pre><code>请求参数：
{
 "createTime":"2018-08-09",
 "userName": "",
 "name": " ",
 "age": 9,
 "mobile": "123123123",
 "girlFrinds": ["1号","2号","3号"],
 "money": 101,
 "temperatureWinter": 0,
 "temperatureSummer": -1,
 "address": "12",
 "people": false,
 "delete": true,
 "password": "123",
 "email": "11@",
 "expireTime":"2019-11-11",
 "birthDate":"2020-11-11",
 "url":"qwe"
}

返回结果：
[
 "你女朋友个数在0-2之间",
 "地址在4-64之间",
 "密码格式错误",
 "email格式错误",
 "创建时间不能填",
 "你钱包里的钱在0-2之间",
 "对象必须是人",
 "出生日期比当前时间早",
 "冬天温度在0°以下",
 "年龄太小了",
 "失效时间比当前时间晚",
 "url填写错误",
 "夏天温度在0°以上",
 "不能上来就删除",
 "姓名不能为空或空字符串",
 "用户名不能为空"
]
</code></pre> <h4><a rel="nofollow"></a>3.4 校验通过测试</h4> <pre><code>请求参数：
{
 "createTime":"",
 "userName": " ",
 "name": "cff",
 "age": 11,
 "mobile": "13333333333",
 "girlFrinds": ["1号","2号"],
 "money": 100,
 "temperatureWinter": -1,
 "temperatureSummer": 12,
 "address": "12345",
 "people": true,
 "delete": false,
 "password": "123456",
 "email": "11@qq.com",
 "expireTime":"2020-11-11",
 "birthDate":"2019-11-11",
 "url":"http://www.pomit.cn"
}

返回结果：
[
 "0000"
]
</code></pre> <h3><a rel="nofollow"></a>四、级联校验</h3> 如果一个对象持有另一个对象的引用，可以使用@Valid注解进行级联校验。 如下所示： <h4><a rel="nofollow"></a>4.1 实体</h4> <pre><code>package com.cff.springbootwork.validator.vo;

import javax.validation.Valid;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;

@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class UserRole { 
	@NotEmpty(message = "用户名不能为空")
	private String userName;
	
	@NotNull(message = "roleId不能为空")
	private Integer roleId;
	
	@Valid
	private UserInfo userInfo;
}

</code></pre> <h4><a rel="nofollow"></a>4.2 测试Web</h4> <pre><code>@RequestMapping(value = "/test1")
	public List&lt;String&gt; test1(@Valid @RequestBody UserRole userRole, BindingResult bindingResult) { 
		if (bindingResult.hasErrors()) { 
			List&lt;String&gt; errorMsg = bindingResult.getAllErrors().stream().map(s -&gt; s.getDefaultMessage())
 .collect(Collectors.toList());
 return errorMsg;
		}
		return Collections.singletonList("0000");
	}
</code></pre> <h4><a rel="nofollow"></a>4.3 测试结果</h4> <pre><code>请求数据：
{
	"userName": "",
	"roleId": 1,
	"userInfo":{
		"createTime":"2018-08-09",
	 "userName": "",
	 "name": " ",
	 "age": 9,
	 "mobile": "123123123",
	 "girlFrinds": ["1号","2号","3号"],
	 "money": 101,
	 "temperatureWinter": 0,
	 "temperatureSummer": -1,
	 "address": "12",
	 "people": false,
	 "delete": true,
	 "password": "123",
	 "email": "11@",
	 "expireTime":"2019-11-11",
	 "birthDate":"2020-11-11",
	 "url":"qwe"
	}
}

返回结果：
[
 "失效时间比当前时间晚",
 "用户名不能为空",
 "用户名不能为空",
 "你女朋友个数在0-2之间",
 "密码格式错误",
 "你钱包里的钱在0-2之间",
 "姓名不能为空或空字符串",
 "url填写错误",
 "冬天温度在0°以下",
 "对象必须是人",
 "email格式错误",
 "不能上来就删除",
 "年龄太小了",
 "夏天温度在0°以上",
 "地址在4-64之间",
 "创建时间不能填",
 "出生日期比当前时间早"
]
</code></pre> <h3><a rel="nofollow"></a>五、手动校验</h3> 有时候，不用使用@Valid 自动校验，需要手动调起validator进行校验，可以使用<code>validator.validate(roleInfo);</code>进行校验： <h4><a rel="nofollow"></a>5.1 实体</h4> <pre><code>package com.cff.springbootwork.validator.vo;

import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;

</code></pre> <h4><a rel="nofollow"></a>5.2 测试</h4> Validator（import javax.validation.Validator;） 在SpringBoot中，可以作为bean之间被注入。 <pre><code>@Autowired
Validator validator;

@RequestMapping(value = "/test2")
public List&lt;String&gt; test2(@RequestParam("roleId") Integer roleId, @RequestParam("roleName") String roleName) { 
	RoleInfo roleInfo = new RoleInfo(roleId, roleName);
	Set&lt;ConstraintViolation&lt;RoleInfo&gt;&gt; sets = validator.validate(roleInfo);
	if(sets.isEmpty())return Collections.singletonList("0000");
	List&lt;String&gt; errorMsg = sets.stream().map(s -&gt; s.getMessage()).collect(Collectors.toList());
	return errorMsg;
}
</code></pre> <h3><a rel="nofollow"></a>六、分组校验</h3> 分组校验就是处理特殊情况下的校验，使不同的调用走不同的校验组。 如，一个对象A持有另一个对象B的引用，对象B中某些字段不想在对象A校验的时候被校验到，可以使用分组校验。 <h4><a rel="nofollow"></a>6.1 实体</h4> 假设有两个实体： <pre><code>import javax.validation.Valid;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;

@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class UserRoleInfo { 
	@NotEmpty(message = "用户名不能为空")
	private String userName;
	
	@NotNull(message = "roleId不能为空")
	private Integer roleId;
	
	@Valid
	private RoleInfo roleInfo;
}

</code></pre> <pre><code>import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;

@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class RoleInfo { 
	@NotNull(message = "roleId不能为空", groups=RoleGroup.class)
	private Integer roleId;
	
	@NotEmpty(message = "roleName不能为空", groups=RoleGroup.class)
	private String roleName;
}
</code></pre> 注意，这里的groups必须是接口。接口内容任意，只是个标识而已。 <pre><code>public interface RoleGroup {

}
</code></pre> <code>Default.class(javax.validation.groups.Default)</code>是默认分组，不需要自己建立. <h4><a rel="nofollow"></a>6.2 测试不带分组</h4> <pre><code>import java.util.Collections;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;

import javax.validation.ConstraintViolation;
import javax.validation.Validator;
import javax.validation.groups.Default;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import com.cff.springbootwork.validator.vo.RoleGroup;
import com.cff.springbootwork.validator.vo.RoleInfo;
import com.cff.springbootwork.validator.vo.UserRoleInfo;

@RestController
@RequestMapping("/valid")
public class ValidatorRest { 
	@Autowired
	Validator validator;

@RequestMapping(value = "/test3")
	public List&lt;String&gt; test3(@RequestParam("roleId") Integer roleId, @RequestParam("userName") String userName,
			@RequestParam("roleName") String roleName) { 
		UserRoleInfo userRoleInfo = new UserRoleInfo();
		userRoleInfo.setRoleId(roleId);
		userRoleInfo.setUserName(userName);
		RoleInfo roleInfo = new RoleInfo(roleId, roleName);
		userRoleInfo.setRoleInfo(roleInfo);
		Set&lt;ConstraintViolation&lt;UserRoleInfo&gt;&gt; sets = validator.validate(userRoleInfo);
		if (sets.isEmpty())
			return Collections.singletonList("0000");
		List&lt;String&gt; errorMsg = sets.stream().map(s -&gt; s.getMessage()).collect(Collectors.toList());
		return errorMsg;
	}
}
</code></pre> 结果： <pre><code>请求参数：
roleId:1
userName:
roleName:

返回结果：
[
 "用户名不能为空"
]
</code></pre> <h4><a rel="nofollow"></a>6.2 测试带分组</h4> 注意，<code>Default.class</code>是默认分组。 <pre><code>import java.util.Collections;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;

@RequestMapping(value = "/test3")
	public List&lt;String&gt; test3(@RequestParam("roleId") Integer roleId, @RequestParam("userName") String userName,
			@RequestParam("roleName") String roleName) { 
		UserRoleInfo userRoleInfo = new UserRoleInfo();
		userRoleInfo.setRoleId(roleId);
		userRoleInfo.setUserName(userName);
		RoleInfo roleInfo = new RoleInfo(roleId, roleName);
		userRoleInfo.setRoleInfo(roleInfo);
		Set&lt;ConstraintViolation&lt;UserRoleInfo&gt;&gt; sets = validator.validate(userRoleInfo, RoleGroup.class, Default.class);
		if (sets.isEmpty())
			return Collections.singletonList("0000");
		List&lt;String&gt; errorMsg = sets.stream().map(s -&gt; s.getMessage()).collect(Collectors.toList());
		return errorMsg;
	}
}
</code></pre> 结果： <pre><code>请求参数：
roleId:1
userName:
roleName:

返回结果：
[
 "roleName不能为空",
 "用户名不能为空"
]
</code></pre> <h3><a rel="nofollow"></a>七、自定义注解校验</h3> 有时候，我们仍需要自定义校验注解，如，我这里定义一个只校验0或1数据的验证器。 <h4><a rel="nofollow"></a>7.1 自定义注解</h4> <pre><code>package com.cff.springbootwork.validator.custom;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import javax.validation.Constraint;
import javax.validation.Payload;

/** * 自定义类校验注解 * 作用于类，用以校验0/1类型数据 * @author cff * */
@Target(value = { ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy=TypeZeroOneValidator.class)
public @interface ZeroOne { 
	
	String message() default "参数有误";

Class&lt;?&gt;[] groups() default { };

Class&lt;? extends Payload&gt;[] payload() default { };
}

</code></pre> <h4><a rel="nofollow"></a>7.2 自定义Validator</h4> <pre><code>package com.cff.springbootwork.validator.custom;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class TypeZeroOneValidator implements ConstraintValidator&lt;ZeroOne, Object&gt; {

@Override
	public void initialize(ZeroOne constraintAnnotation) {

}

@Override
	public boolean isValid(Object obj, ConstraintValidatorContext context) { 
		if (obj == null)
			return true;
		int curNum = 0;
		if (obj instanceof String) { 
			String s = (String) obj;
			curNum = Integer.parseInt(s);
		} else if (obj instanceof Boolean) { 
			boolean b = ((Boolean) obj).booleanValue();
			if (b) { 
				curNum = 1;
			}
		} else if (obj instanceof Long) { 
			curNum = ((Long) obj).intValue();
		} else { 
			curNum = ((Integer) obj).intValue();
		}
		if (curNum == 0 || curNum == 1)
			return true;
		return false;
	}

}

</code></pre> <h4><a rel="nofollow"></a>7.3 测试实体</h4> <pre><code>package com.cff.springbootwork.validator.vo;

import com.cff.springbootwork.validator.custom.ZeroOne;

@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class RoleInfoZeroOne { 
	@NotNull(message = "roleId不能为空")
	private Integer roleId;
	
	@NotEmpty(message = "roleName不能为空")
	private String roleName;
	
	@ZeroOne(message = "deleted只能为0/1")
	private Integer deleted;
}

</code></pre> <h4><a rel="nofollow"></a>7.4 测试Web</h4> 跟普通使用方法一样，无需更改。 <pre><code>@RequestMapping(value = "/test4")
	public List&lt;String&gt; test4(@Valid @RequestBody RoleInfoZeroOne roleInfoZeroOne, BindingResult bindingResult) { 
		if (bindingResult.hasErrors()) { 
			List&lt;String&gt; errorMsg = bindingResult.getAllErrors().stream().map(s -&gt; s.getDefaultMessage())
					.collect(Collectors.toList());
			return errorMsg;
		}
		return Collections.singletonList("0000");
	}
</code></pre> <h4><a rel="nofollow"></a>7.5 测试结果</h4> <pre><code>请求参数：
{
	"roleId":1,
	"deleted":3,
 "roleName": "cff"
}
返回结果：
[
 "deleted只能为0/1"
]
</code></pre> <a href="https://www.pomit.cn/lecture.html" rel="nofollow">品茗IT-博客专题:https://www.pomit.cn/lecture.html</a>汇总了<a href="https://www.pomit.cn/lecture/springunion.html" rel="nofollow">Spring专题</a>、<a href="https://www.pomit.cn/lecture/springbootfull.html" rel="nofollow">Springboot专题</a>、<a href="https://www.pomit.cn/lecture/springcloudfull.html" rel="nofollow">SpringCloud专题</a>、<a href="https://www.pomit.cn/lecture/webbasics.html" rel="nofollow">web基础配置</a>专题。 <h3><a rel="nofollow"></a>快速构建项目</h3> Spring项目快速开发工具： <a href="https://www.pomit.cn/java/spring/spring.html" rel="nofollow">一键快速构建Spring项目工具</a> <a href="https://www.pomit.cn/java/spring/springboot.html" rel="nofollow">一键快速构建SpringBoot项目工具</a> <a href="https://www.pomit.cn/java/spring/springcloud.html" rel="nofollow">一键快速构建SpringCloud项目工具</a> <a href="https://www.pomit.cn/java/java/sqlToSpringboot.html" rel="nofollow">一站式Springboot项目生成</a> <a href="https://www.pomit.cn/java/java/sqlToMybatis.html" rel="nofollow">Mysql一键生成Mybatis注解Mapper</a> <a href="https://www.pomit.cn/java/spring/spring.html" rel="nofollow">Spring组件化构建</a> <a href="https://www.pomit.cn/java/spring/springboot.html" rel="nofollow">SpringBoot组件化构建</a> <a href="https://www.pomit.cn/java/spring/springcloud.html" rel="nofollow">SpringCloud服务化构建</a> 喜欢这篇文章么，喜欢就加入我们一起讨论Java Web吧！ <img src="https://img-blog.csdnimg.cn/20190430181302249.png" alt="品茗IT交流群"> </td> 
 </tr> 
 </tbody> 
</table>

[IT_ https_www.pomit.cn_p_2437125163256321]: https://www.pomit.cn/p/2415889950231041
[java]: https://jq.qq.com/?_wv=1027&k=52sgH1J
[https_docs.jboss.org_hibernate_stable_validator_reference_en-US_html_single_section-builtin-constraints]: https://docs.jboss.org/hibernate/stable/validator/reference/en-US/html_single/#section-builtin-constraints