什么是Hibernate Validator?

Hibernate Validator是Hibernate提供的一个开源框架,使用注解方式非常方便的实现服务端的数据校验。

官网:http://hibernate.org/validator/

hibernate Validator是 Bean Validation 的参考实现 。

Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint(约束) 的实现,除此之外还有一些附加的 constraint。

在日常开发中,Hibernate Validator经常用来验证bean的字段,基于注解,方便快捷高效。

在SpringBoot的spring-boot-starter-web启动器中已经集成了相关依赖:

或者可以添加依赖:

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

Bean校验的常用注解:

@Valid 被注释的元素是一个对象,需要检查此对象的所有字段值
@Validated 被注解的元素是一个对象或者一个类,需要检查此对象的所有字段值
@AssertFalse 所注解的元素必须是Boolean类型,且值为false
@AssertTrue 所注解的元素必须是Boolean类型,且值为true
@DecimalMax 所注解的元素必须是数字,且值小于等于给定的值
@DecimalMin 所注解的元素必须是数字,且值大于等于给定的值
@Digits 所注解的元素必须是数字,且值必须是指定的位数
@Future 所注解的元素必须是将来某个日期
@Max(value) 所注解的元素必须是数字,且值小于等于给定的值
@Min(value) 所注解的元素必须是数字,且值小于等于给定的值
@Range 所注解的元素需在指定范围区间内
@NotNull 所注解的元素值不能为null
@NotBlank 所注解的元素值有内容
@Null 所注解的元素值为null
@Past 所注解的元素必须是某个过去的日期
@PastOrPresent 所注解的元素必须是过去某个或现在日期
@Pattern(value) 所注解的元素必须满足给定的正则表达式
@Size 所注解的元素必须是String、集合或数组,且长度大小需保证在给定范围之内
@Email 所注解的元素需满足Email格式

第一类:实体类参数校验

(1)实体类上加上注解,使用json传参,加@RequestBody解析json参数映射为实体类

@Data
public class User implements Serializable {
private String id; @NotNull(message = "姓名不能为空")
@Size(min = 1, max = 20, message = "姓名长度必须在1-20之间")
private String name; @Min(value = 10, message = "年龄必须大于10")
@Max(value = 150, message = "年龄必须小于150")
private Integer age; @Email(message = "邮箱格式不正确")
private String email; }

(2)Controller中加上注解

@Controller
public class LoginController { @PostMapping("/test")
@ResponseBody
public AjaxResult test(@Validated @RequestBody User user){
System.out.println(user);
return AjaxResult.success(user);
} }

(3)PostMan测试

响应数据:数据不友好,使用全局异常捕获返回友好提示。

{
"timestamp": "2020-06-17T10:16:50.591+0000",
"status": 400,
"error": "Bad Request",
"errors": [
{
"codes": [
"Email.user.email",
"Email.email",
"Email.java.lang.String",
"Email"
],
"arguments": [
{
"codes": [
"user.email",
"email"
],
"arguments": null,
"defaultMessage": "email",
"code": "email"
},
[],
{
"arguments": null,
"defaultMessage": ".*",
"codes": [
".*"
]
}
],
"defaultMessage": "邮箱格式不正确",
"objectName": "user",
"field": "email",
"rejectedValue": "123456789",
"bindingFailure": false,
"code": "Email"
},
{
"codes": [
"NotNull.user.name",
"NotNull.name",
"NotNull.java.lang.String",
"NotNull"
],
"arguments": [
{
"codes": [
"user.name",
"name"
],
"arguments": null,
"defaultMessage": "name",
"code": "name"
}
],
"defaultMessage": "姓名不能为空",
"objectName": "user",
"field": "name",
"rejectedValue": null,
"bindingFailure": false,
"code": "NotNull"
}
],
"message": "Validation failed for object='user'. Error count: 2",
"path": "/test"
}

(4)全局处理异常,处理 @RequestBody参数校验异常,统一返回格式自定义

@RestControllerAdvice
public class GlobalExceptionHandler { /**
* 处理 @RequestBody参数校验异常
*/
@ExceptionHandler(value = MethodArgumentNotValidException.class)
public AjaxResult handleBindGetException(MethodArgumentNotValidException ex) { Map<String, Object> body = new LinkedHashMap<>();
body.put("timestamp", new Date()); // 获取所有异常
List<String> errors = ex.getBindingResult()
.getFieldErrors()
.stream()
.map(DefaultMessageSourceResolvable::getDefaultMessage)
.collect(Collectors.toList());
body.put("errors", errors);
return AjaxResult.error("提交的数据校验失败", body);
} }

(5)再次测试:

第二类:使用表单传参,即不使用@RequestBody,跟上面的第一类异常捕获的异常类型不同而已。

@Controller
public class LoginController { @PostMapping("/test1")
@ResponseBody
public AjaxResult test1(@Validated User user){
System.out.println(user);
return AjaxResult.success(user);
} }
@RestControllerAdvice
public class GlobalExceptionHandler {
/**
* 处理不带任何注解的参数绑定校验异常,即没有@RequestBody
*/
@ExceptionHandler(BindException.class)
public AjaxResult handleBingException(BindException ex) {
Map<String, Object> body = new LinkedHashMap<>();
body.put("timestamp", new Date());
// 获取所有异常
List<String> errors = ex.getBindingResult()
.getFieldErrors()
.stream()
.map(DefaultMessageSourceResolvable::getDefaultMessage)
.collect(Collectors.toList());
body.put("errors", errors);
return AjaxResult.error("提交的数据校验失败", body);
}
}

第三类:单个参数校验

(1)直接在参数前加上校验注解

@RestController
@Validated
public class UserController {
@GetMapping("/test3")
public AjaxResult test3(@NotNull(message = "name不能为空") String name ,@Email(message = "邮箱格式不正确") String email){
System.out.println(name);
System.out.println(email);
return AjaxResult.success(name+" "+email);
}
}

注意:需要在类上添加@Validated注解,否则不会校验。

@RestControllerAdvice
public class GlobalExceptionHandler { /**
* 处理所有参数校验时抛出的异常
* @param ex
* @return
*/
@ExceptionHandler(value = ValidationException.class)
public AjaxResult handleBindException(ValidationException ex) {
AjaxResult body = new AjaxResult(); body.put("timestamp", new Date()); // 获取所有异常
List<String> errors = new LinkedList<>();
if (ex instanceof ConstraintViolationException) {
ConstraintViolationException exs = (ConstraintViolationException) ex;
Set<ConstraintViolation<?>> violations = exs.getConstraintViolations();
for (ConstraintViolation<?> item : violations) {
errors.add(item.getMessage());
}
}
body.put("errors", errors);
body.put("code",900);
body.put("msg","提交的数据校验失败"); return body;
} }

第四类:参数校验分组

在实际开发中经常会遇到这种情况:添加用户时,id是由后端生成的,不需要校验id是否为空,但是修改用户时就需要校验id是否为空。如果在接收参数的User实体类的id属性上添加NotNull,那么都会校验,显然不符合要求。这时候就可以定义分组,在需要校验id的时候校验,不需要的时候不校验。

(1)定义表示组别的接口类

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

(2)在实体类的注解中标记id使用上面定义的组

@Data
public class User implements Serializable { @NotNull(message = "id不能为空",groups = Update.class)
private String id; @NotNull(message = "姓名不能为空")
@Size(min = 1, max = 20, message = "姓名长度必须在1-20之间")
private String name; @Min(value = 10, message = "年龄必须大于10")
@Max(value = 150, message = "年龄必须小于150")
private Integer age; @Email(message = "邮箱格式不正确")
private String email; }

(3)在controller中使用@Validated指定使用哪个@Controllerpublicclass LoginController {

    @PostMapping("/test4")
@ResponseBody
// 指定Update,这样就会校验id属性是否为空
// 注意:一般来说要添加Default.class,否则不会执行其他的校验(但是我也可以不加,也校验了,哈哈哈,不知道为啥)public AjaxResult test4(@Validated({Update.class, Default.class}) User user){
     System.out.println(user);
return AjaxResult.success(user);
} }

@Controller
public class LoginController { @PostMapping("/test4")
@ResponseBody
  // 这里就没有加default.class,但是测试结果还是校验其他数据了的
public AjaxResult test4(@Validated(Create.class) User user){
System.out.println(user);
return AjaxResult.success(user);
} }

在controller中使用@Valid 或者@Validated 注解校验的区别:

嵌套验证:

public class Item {
@NotNull(message = "id不能为空")
@Min(value = 1, message = "id必须为正整数")
private Long id; @Valid
@NotNull(message = "props不能为空")
@Size(min = 1, message = "至少要有一个属性")
private List<Prop> props;
}
public class Prop {
@NotNull(message = "pid不能为空")
@Min(value = 1, message = "pid必须为正整数")
private Long pid; @NotNull(message = "vid不能为空")
@Min(value = 1, message = "vid必须为正整数")
private Long vid; @NotBlank(message = "pidName不能为空")
private String pidName; @NotBlank(message = "vidName不能为空")
private String vidName;
}
@RestController
public class ItemController {
@RequestMapping("/item/add")
public void addItem(@Validated Item item, BindingResult bindingResult) {
doSomething();
}
}

验证多个对象:

@Controller
public class PeopleController {
@RequestMapping("/add")
public @ResponseBody String add(@Validated People pp, BindingResult result1, @Validated Person ps, BindingResult result2)
{
if(result1.hasErrors())
{
return false;
}
if(result2.hasErrors())
{
return false;
}
return true;
}
}

springboot参数据校验的更多相关文章

  1. 补习系列(4)-springboot 参数校验详解

    目录 目标 一.PathVariable 校验 二.方法参数校验 三.表单对象校验 四.RequestBody 校验 五.自定义校验规则 六.异常拦截器 参考文档 目标 对于几种常见的入参方式,了解如 ...

  2. SpringBoot 参数校验的方法

    Introduction 有参数传递的地方都少不了参数校验.在web开发中,前端的参数校验是为了用户体验,后端的参数校验是为了安全.试想一下,如果在controller层中没有经过任何校验的参数通过s ...

  3. SpringBoot接口 - 如何优雅的对参数进行校验?

    在以SpringBoot开发Restful接口时, 对于接口的查询参数后台也是要进行校验的,同时还需要给出校验的返回信息放到上文我们统一封装的结构中.那么如何优雅的进行参数的统一校验呢? @pdai ...

  4. # SpringBoot使用Validation校验参数 ##

    SpringBoot使用Validation校验参数 一.简介 参考 (14条消息) 1. 不吹不擂,第一篇就能提升你对Bean Validation数据校验的认知_@decimalmax和@max_ ...

  5. SpringBoot 参数校验

    一.添加依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId> ...

  6. SpringBoot系列: Java应用程序传参和SpringBoot参数文件

    ===========================向java 程序传参的几种形式:===========================1. 使用 OS 环境变量. 这个不推荐. 2. 使用JVM ...

  7. 前端参数统一校验工具类ValidParamUtils

    1,前端参数不可信,对于后端开发人员来说应该是一条铁律,所以对于前端参数的校验,必不可少,而统一的前端参数校验工具,对我们进行参数校验起到事半功倍的效果 2,统一参数校验工具ValidParamUti ...

  8. WebApi安全性 参数签名校验(结合Axios使用)

    接口参数签名校验,是WebApi接口服务最重要的安全防护手段之一. 结合项目中实际使用情况,介绍下前后端参数签名校验实现方案. 签名校验规则 http请求,有两种传参形式: 1.通过url传参,最常见 ...

  9. SpringBoot 请求参数后端校验

    1.例如: package com.model.user; import com.model.PageEntity;import lombok.Getter;import lombok.Setter; ...

  10. springboot 参数校验详解

    https://www.jianshu.com/p/89a675b7c900 在日常开发写rest接口时,接口参数校验这一部分是必须的,但是如果全部用代码去做,显得十分麻烦,spring也提供了这部分 ...

随机推荐

  1. 【Jmeter】按比例分配Api压测

    先看 [Jmeter]基础介绍-详细 [Jmeter]Request1输出作为Request2输入-后置处理器 继续聊提出的第二个问题,即 2.需要按比例分配API请求并发,以模拟真实的API压力场景 ...

  2. Rsync+Inotify 实现数据同步

    Rsync 是UNIX及类UNIX-Like平台下一款强大的数据镜像备份软件,它不像FTP或其他文件传输服务那样需要进行全备份,Rsync 可以根据数据的变化进行差异备份,从而减少数据流量,提高工作效 ...

  3. 最好的个人博客评论区实现方案推荐:waline

    我的博客一直没有一个好看的评论区,自己做又不会..没错,我是个前端渣渣.调研了一下,一开始想套用一些网上的静态模板,但是改造成本还是挺大的,后来接触到了Waline,简单了解了以下,我就知道了,它就是 ...

  4. shell 两个数组比较,得到元素的并集、交集等

    linux shell 实现数组比较,取元素的并集.交集时,可以使用sort排序.uniq统计和awk数据过滤. shell 实现如下 file_list_1=("test1" & ...

  5. JOISC 2020 记录

    Day1 T1 Building 4 首先有一个 \(O(n^2)\) 的 DP:记 \(f_{i,j,0/1}\) 表示已经填了前 \(i\) 位,其中有 \(j\) 位选择了 A 序列,当前第 \ ...

  6. NC20139 [JLOI2014]松鼠的新家

    题目链接 题目 题目描述 松鼠的新家是一棵树,前几天刚刚装修了新家,新家有n个房间,并且有n-1根树枝连接,每个房间都可以相互到达,且俩个房间之间的路线都是唯一的.天哪,他居然真的住在"树& ...

  7. 使用TensorFlow实现MNIST数据集分类

    1 MNIST数据集 MNIST数据集由70000张28x28像素的黑白图片组成,每一张图片都写有0~9中的一个数字,每个像素点的灰度值在0 ~ 255(0是黑色,255是白色)之间. MINST数据 ...

  8. 【framework】ConfigurationContainer简介

    1 前言 ​ 如图所示,ConfigurationContainer 是 AMS 家族的重要基类:WindowContainer 继承自 ConfigurationContainer,是 WMS 家族 ...

  9. php+bootstrap+jquery+mysql实现购物车项目案例

    获取源码 一键三连后,评论区留下邮箱安排发送:) 介绍 使用php,bootstrap,jquery,mysql实现的简易购物车案例. 通过本案例,你将学习到以下知识点: php 操作 mysql 实 ...

  10. 免费接口API

    前言 我们经常在不同的应用中见到镶嵌的本地地理位置气象信息,一般配合定位使用,即先获取用户位置,然后通过用户的区域请求免费的天气接口,获取气象数据,json解析后展示. 一,常用的三个接口 我常用的接 ...