学习Spring Boot：（十）使用hibernate validation完成数据后端校验

前言

后台数据的校验也是开发中比较注重的一点，用来校验数据的正确性，以免一些非法的数据破坏系统，或者进入数据库，造成数据污染，由于数据检验可能应用到很多层面，所以系统对数据校验要求比较严格且追求可变性及效率。

了解

了解一点概念性的东东。
* JSR 303 是 Java 为 Bean 数据合法性校验提供的标准框架,它已经包含在 JavaEE 6.0 中 。
* Hibernate Validator 是 JSR 303 的一个参考实现，所以它多实现了几个校验规则。
* Spring 4.0 拥有自己独立的数据校验框架,同时支持 JSR303 标准的校验框架。
* 在已经标注了 JSR303 注解的表单/命令对象前标注一个@Valid,Spring MVC 框架在将请求参数绑定到该入参对象后,就会调用校验框架根据注解声明的校验规则实施校验
* Spring MVC 是通过对处理方法签名的规约来保存校验结果的:前一个表单/命令对象的校验结果保存到随后的入参中,这个保存校验结果的入参必须是 BindingResult 或Errors 类型,这两个类都位于org.springframework.validation 包中。
* 需校验的 Bean 对象和其绑定结果对象或错误对象时成对出现的,它们之间不允许声明其他的入参
* Errors 接口提供了获取错误信息的方法,如 getErrorCount() 或getFieldErrors(String field)
* BindingResult 扩展了 Errors 接口。

支持的注解

JSR 提供的校验注解:

@Null   被的注解元素必须为 null    
@NotNull    被注解的元素必须不为 null    
@AssertTrue     被注解的元素必须为 true    
@AssertFalse    被注解的元素必须为 false    
@Min(value)     被注解的元素必须是一个数字，其值必须大于等于指定的最小值    
@Max(value)     被注解的元素必须是一个数字，其值必须小于等于指定的最大值    
@DecimalMin(value)  被注解的元素必须是一个数字，其值必须大于等于指定的最小值    
@DecimalMax(value)  被注解的元素必须是一个数字，其值必须小于等于指定的最大值    
@Size(max=, min=)   被注解的元素的大小必须在指定的范围内   集合或数组 集合或数组的大小是否在指定范围内 
@Digits (integer, fraction)     被注解的元素必须是一个数字，验证是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。   
@Past   被注解的元素必须是一个过去的日期    
@Future     被注解的元素必须是一个将来的日期    
@Pattern(regex=,flag=)  被注解的元素必须符合指定的正则表达式

Hibernate Validator 提供的校验注解：

@NotBlank(message =)   验证字符串非null，且长度必须大于0    
@Email  被注释的元素必须是电子邮箱地址    
@Length(min=,max=)  被注解的值大小必须在指定的范围内    
@NotEmpty   被注解的字符串的必须非空    
@Range(min=,max=,message=)  验证该值必须在合适的范围内

可以在需要验证的属性上，使用多个验证方式，它们同时生效。
spring boot web 已经有 hibernate-validation 的依赖，所以不需要再手动添加依赖。

使用

首先我在我的实体类上写了几个校验注解。

public class SysUserEntity implements Serializable {private static final long serialVersionUID = 1L;//主键private Long id;//用户名@NotBlank(message = "用户名不能为空", groups = {AddGroup.class, UpdateGroup.class})private String username;//密码@NotBlank(message = "密码不能为空", groups = {AddGroup.class})private String password;//手机号@Pattern(regexp = "^1([345789])\\d{9}$",message = "手机号码格式错误")@NotBlank(message = "手机号码不能为空")private String mobile;//邮箱@Email(message = "邮箱格式不正确")private String email;//创建者private Long createUserId;//创建时间private Date createDate;
// ignore set and get

使用@Validated进行校验

首先了解下：
关于@Valid和@Validated的区别联系
* @Valid: javax.validation， 是javax，也是就是jsr303中定义的规范注解
* @Validated: org.springframework.validation.annotation， 是spring自己封装的注解。参数校验失败抛出 org.springframework.validation.BindException 异常。

@Validated是@Valid的一个变种，扩展了@Valid的功能，支持group分组校验的写法，所以为了校验统一，尽量使用@Validated

在controller自定义一个接口

@PostMapping("/valid")public ResponseEntity<String> valid(@Validated @RequestBody SysUserEntity user, BindingResult result) {if (result.hasErrors()) {return ResponseEntity.status(BAD_REQUEST).body("校验失败");}return ResponseEntity.status(OK).body("校验成功");}

需要注意的有几点：
* 需要校验对象的时候，需要加上 spring 的校验注解 @Validated ，表示我们需要 spring 对它进行校验，而校验的信息会存放到其后的BindingResult中。
* BindingResult 必须和检验对象紧邻，中间不能穿插任何参数，如果有多个校验对象 @Validated @RequestBody SysUserEntity user, BindingResult result, @Validated @RequestBody SysUserEntity user1, BindingResult result1。

我在前端用 Swagger 进行测试下。
我发送一个 body，将 手机号输错：

{"createDate": "","createUserId": 0,"email": "k@wuwii.com","id": 0,"mobile": "12354354","password": "123","username": "12312"
}

后端调试下 BindingResult 的结果，发现结果：
image
只要注意下 errors 属性，它是校验所有不符合规则的，是一个数组。

分组校验

有时候 ，我们在新增和更新的时候校验效果是不一样的。例如上面，我在User新增的时候需要判断密码是不是为空，但是更新的时候我不做校验。这个时候就也要用到分组校验了。

@NotBlank(message = "密码不能为空", groups = {AddGroup.class})
private String password;

将Contoller中的校验修改下。

(@Validated({AddGroup.class}) @RequestBody SysUserEntity user, BindingResult result)

上面的意思是只有分组是AddGroup的校验才生效，其余的校验忽略。

经过我测试，把分组情况分下：

  1. 在controller校验没加分组的时候，只对实体类的没有分组的注解有效。
  2. 在controller校验加分组的时候，只对实体类的当前分组的注解有效，没有注解的也无效。
  3. 当校验有两个分组的时候@Validated({AddGroup.class, UpdateGroup.class})，满足当前两个分组其中任意一个都可以校验，两个注解同时一起出现，也没问题，而且检验不通过的信息不会重复。

自定义校验

有时候系统提供给我们的校验注解，并不够用，我们可以自定义校验，来满足我们的业务需求。

例如：现在我们有一个需求，需要检测一条信息的敏感词汇，如sb ……文明人，举个栗子 ……

自定义校验注解
// 注解可以用在哪些地方
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
@Retention(RUNTIME)
@Documented
// 指定校验规则实现类
@Constraint(validatedBy = {NotHaveSBValidator.class})
public @interface NotHaveSB {//默认错误消息String message() default "不能包含字符sb";//分组Class<?>[] groups() default {};//负载Class<? extends Payload>[] payload() default {};//指定多个时使用@Target({FIELD, METHOD, PARAMETER, ANNOTATION_TYPE})@Retention(RUNTIME)@Documented@interface List {NotHaveSB[] value();}}
规则校验实现类
// 可以指定检验类型，这里选择的是 String
public class NotHaveSBValidator implements ConstraintValidator<NotHaveSB, String> {@Overridepublic void initialize(NotHaveSB notHaveSB) {}/**** @param s 待检验对象* @param constraintValidatorContext 检验上下文，可以设置检验的错误信息* @return false 代表检验失败*/@Overridepublic boolean isValid(String s, ConstraintValidatorContext constraintValidatorContext) {return !StringUtils.isNotBlank(s) || !s.toLowerCase().contains("sb");}
}

所有的验证者都需要实现ConstraintValidator接口，它的接口也很形象，包含一个初始化事件方法，和一个判断是否合法的方法。

测试一下喂

现在我的用户类上，也没什么多余的字段拿出来测试，暂时把 password 字段拿来测试吧。

//@NotBlank(message = "密码不能为空", groups = AddGroup.class)@NotHaveSBprivate String password;

image

手动校验

这个是我最终想要的处理方式。
由于现在都是前后端分离开发的，校验失败的时候，抛出自定义的异常，然后统一处理这些异常，最后将相关的错误提示信息返回给前端处理。

新建一个验证工具类

public class ValidatorUtils {private static Validator validator;static {validator = Validation.buildDefaultValidatorFactory().getValidator();}/*** 手动校验对象** @param object 待校验对象* @param groups 待校验的组* @throws KCException 校验不通过，则抛出 KCException 异常*/public static void validateEntity(Object object, Class<?>... groups)throws KCException {Set<ConstraintViolation<Object>> constraintViolations = validator.validate(object, groups);if (!constraintViolations.isEmpty()) {String msg = constraintViolations.parallelStream().map(ConstraintViolation::getMessage).collect(Collectors.joining("，"));throw new KCException(msg);}}
}

它主要做的事情就是验证我们的待验证对象，验证不同通过的时候，抛出自定义异常，在后台统一处理异常就可以了。

在业务中直接调用就可以了，有分组添加分组就行：

@PostMapping("/valid1")public ResponseEntity<String> customValid(@RequestBody SysUserEntity user) {ValidatorUtils.validateEntity(user);return ResponseEntity.status(OK).body("校验成功");}

最后测试一下，查看返回结果是否符合预期：

image

手动校验的补充

决定还是采用注解的形式进行编码，本来想用处理方法参数的装配进行检验，写好了发现和 @responseBody 不能同时使用，然后发现还是可以使用 @Validated 直接校验，抛出异常， 进行捕捉异常统一处理。

    @PostMapping()@ApiOperation("新增")public ResponseEntity insert(@Validated SysUserAddForm user)

在全局异常处理里面加上 处理绑定参数异常 org.springframework.validation.BindException：

    /*** 参数检验违反约束（数据校验）* @param e BindException* @return error message*/@org.springframework.web.bind.annotation.ExceptionHandler(BindException.class)public ResponseEntity<String> handleConstraintViolationException(BindException e) {LOGGER.debug(e.getMessage(), e);return ResponseEntity.status(BAD_REQUEST).body(e.getBindingResult().getAllErrors().stream().map(DefaultMessageSourceResolvable::getDefaultMessage).collect(Collectors.joining(",")));}

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/556837.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

php 仿高德,仿高德路线规划滑动效果

php 仿高德,仿高德路线规划滑动效果

因为项目有个界面要模仿高德地图路径规划滑动效果&#xff0c;因此写了demo&#xff0c;并简单说下分析过程。高德地图效果演示:仿高德路线规划滑动.gifdemo效果演示:高德地图规划滑动.gif一. 分析首先&#xff0c;我们可以看出这个滚动的视图应该是UIScrollView或者UIScrollVi…
阅读更多...
学习Spring Boot：（十八）Spring Boot 中session共享

学习Spring Boot：（十八）Spring Boot 中session共享

前言 前面我们将 Redis 集成到工程中来了&#xff0c;现在需要用它来做点实事了。这次为了解决分布式系统中的 session 共享的问题&#xff0c;将 session 托管到 Redis。 正文 引入依赖 除了上篇文章中引入 spring-boot-starter-data-redis&#xff0c;还需要 spring-sess…
阅读更多...
学习Spring Boot：（十九）Shiro 中使用缓存

学习Spring Boot：（十九）Shiro 中使用缓存

前言 在 shiro 中每次去拦截请求进行权限认证的时候&#xff0c;都会去数据库查询该用户的所有权限信息&#xff0c; 这个时候就是有一个问题了&#xff0c;因为用户的权限信息在短时间内是不可变的&#xff0c;每次查询出来的数据其实都是重复数据&#xff0c;没必要每次都去…
阅读更多...
学习Spring Boot：（二十五）使用 Redis 实现数据缓存

学习Spring Boot：（二十五）使用 Redis 实现数据缓存

前言 由于 Ehcache 存在于单个 java 程序的进程中&#xff0c;无法满足多个程序分布式的情况&#xff0c;需要将多个服务器的缓存集中起来进行管理&#xff0c;需要一个缓存的寄存器&#xff0c;这里使用的是 Redis。 正文 当应用程序要去缓存中读取数据&#xff0c;但是缓存…
阅读更多...
学习Spring Boot：（二十七）Spring Boot 2.0 中使用 Actuator

学习Spring Boot：（二十七）Spring Boot 2.0 中使用 Actuator

前言 主要是完成微服务的监控&#xff0c;完成监控治理。可以查看微服务间的数据处理和调用&#xff0c;当它们之间出现了异常&#xff0c;就可以快速定位到出现问题的地方。 springboot - version: 2.0 正文 依赖 maven 项目 在 pom.xml 文件中加入 actuator 的依赖&…
阅读更多...
php实现注销功能,laravel 实现用户登录注销并限制功能

php实现注销功能,laravel 实现用户登录注销并限制功能

在项目根目录输入&#xff1a; php artisan make:controller Admin/LoginControllerphp artisan make:model Model/Admin -m运行之后 项目中会新增两个PHP文件新创建了admins用户表&#xff0c;此用户表默认新建中只有主键&#xff0c;创建时间&#xff0c;编辑时间。我们接下来…
阅读更多...
将ipynb文件转为py的简单方法（图文并茂）

将ipynb文件转为py的简单方法（图文并茂）

打开可以使用jupyter命令的命令窗口&#xff08;如果没有jupyter则需要先安装jupyter&#xff09;&#xff0c;cd 命令进入到 ipynb 文件所在的文件夹&#xff0c;执行 jupyter nbconvert --to script xxx.ipynb 即可完成 ipynb 文件到 py 文件的转化&#xff0c;执行 jupyter …
阅读更多...
学习Spring Boot：（二十八）Spring Security 权限认证

学习Spring Boot：（二十八）Spring Security 权限认证

前言 主要实现 Spring Security 的安全认证&#xff0c;结合 RESTful API 的风格&#xff0c;使用无状态的环境。 主要实现是通过请求的 URL &#xff0c;通过过滤器来做不同的授权策略操作&#xff0c;为该请求提供某个认证的方法&#xff0c;然后进行认证&#xff0c;授权成…
阅读更多...
Linux 目录所属组设置,Linux系统用户与组管理命令及配置文件总结

Linux 目录所属组设置,Linux系统用户与组管理命令及配置文件总结

一、Linux系统用户及组分类1、用户类别Linux系统中的用户大致可分为三类&#xff1a;root用户、系统用户、普通用户。每一个用户都拥有一个唯一的身份标识UID。2、组分类与用户信息对应的&#xff0c;Linux系统中的组也可分为三类&#xff1a;root组、系统组、普通组。每一个组…
阅读更多...
实验楼 linux内核原理与分析,《Linux内核原理与分析》第一周作业 20189210

实验楼 linux内核原理与分析,《Linux内核原理与分析》第一周作业 20189210

实验一 Linux系统简介这一节主要学习了Linux的历史&#xff0c;Linux有关的重要人物以及学习Linux的方法&#xff0c;Linux和Windows的区别。其中学到了LInux中的应用程序大都为开源自由的软件&#xff0c;用户可以修改定制再发布&#xff1b;内核是实现多任务运行和硬件管理的…
阅读更多...
MySQL的INSERT INTO··· ON DUPLICATE KEY UPDATE使用的几种情况

MySQL的INSERT INTO··· ON DUPLICATE KEY UPDATE使用的几种情况

保存或更新 在MySQL数据库中&#xff0c;如果在insert语句后面带上ON DUPLICATE KEY UPDATE 子句&#xff0c;而要插入的行与表中现有记录的惟一索引或主键中产生重复值&#xff0c;那么就会发生旧行的更新&#xff1b;如果插入的行数据与现有表中记录的唯一索引或者主键不重复…
阅读更多...
java8 Stream API详解

java8 Stream API详解

文章目录一、Stream流概述二、创建Stream的方式相关API三、Stream的中间操作筛选与切片映射排序四、终止操作第一大类API&#xff08;太过简单&#xff09;第二大类AP归约收集一、Stream流概述 1、java8中有两大最为重要的改变&#xff0c;第一就是Lambda表达式&#xff0c;另…
阅读更多...
linux实验3编写内核模块,实验2.3_内核模块_实验报告

linux实验3编写内核模块,实验2.3_内核模块_实验报告

实验报告题目: 内核模块实验1、实验目的模块是Linux系统的一种特有机制&#xff0c;可用以动态扩展操作系统内核功能。编写实现某些特定功能的模块&#xff0c;将其作为内核的一部分在管态下运行。本实验通过内核模块编程在/porc文件系统中实现系统时钟的读操作接口。2、实验内…
阅读更多...
Java 8 Stream Api 中的 peek、map、foreach区别

Java 8 Stream Api 中的 peek、map、foreach区别

#1. 前言 我在Java8 Stream中讲述了 Java 8 Stream API 的一些内容。今天再看一下peek、map、foreach区别。 2. peek peek 操作接收的是一个 Consumer 函数。顾名思义 peek 操作会按照 Consumer 函数提供的逻辑去消费流中的每一个元素&#xff0c;同时有可能改变元素内部的一…
阅读更多...
wapper打成linux服务,Wrapper配置详解及高级应用（转）

wapper打成linux服务,Wrapper配置详解及高级应用（转）

转自&#xff1a;http://286.iteye.com/blog/1921414将一个简单的程度如HelloWorld 的应用包装秤Wrapper 服务并不复杂&#xff0c;甚至可以认为非常简单。但是实际项目应用过程中我们的程序一般较庞大&#xff0c;运行环境也较复杂。通过Wrapper 配置文件的分析与配置进一步了…
阅读更多...
Java8 Stream 流机制和 Lambda 表达式

Java8 Stream 流机制和 Lambda 表达式

一、Stream 流介绍与使用场景 Stream 流介绍 java8 中的stream 与InputStream和OutputStream是完全不同的概念, stream 是用于对集合迭代器的增强&#xff0c;使之完成能够完成更高效的聚合操作&#xff08;过滤、排序、统计分组&#xff09;或者大批量数据操作。stream 与 L…
阅读更多...
linux guide编译器,GUIDE编译器-GUIDE编程工具-GUIDE编译器下载 v1.0.2官方版-完美下载...

linux guide编译器,GUIDE编译器-GUIDE编程工具-GUIDE编译器下载 v1.0.2官方版-完美下载...

GUIDE编译器是款跨平台的开发环境编程工具&#xff0c;支持C/C 和 Pascal三种语言&#xff0c;具有跨平台、操作简单、跨编程语言和单文件编译调试等特点&#xff0c;为用户提供单文件编译、调试和运行的环境。GUIDE编译器特色1、跨平台&#xff1a; GUIDE 可在 linux 平台和 w…
阅读更多...
MySQL事务隔离级别和实现原理

MySQL事务隔离级别和实现原理

经常提到数据库的事务&#xff0c;那你知道数据库还有事务隔离的说法吗&#xff0c;事务隔离还有隔离级别&#xff0c;那什么是事务隔离&#xff0c;隔离级别又是什么呢&#xff1f;本文就帮大家梳理一下。 MySQL 事务 本文所说的 MySQL 事务都是指在 InnoDB 引擎下&#xff0…
阅读更多...
超级全面的MySQL优化面试解析

超级全面的MySQL优化面试解析

推荐阅读(点击即可跳转阅读) 1. SpringBoot内容聚合 2. 面试题内容聚合 3. 设计模式内容聚合 4. Mybatis内容聚合 5. 多线程内容聚合 超级全面的MySQL优化面试解析 本文概要 概述 为什么要优化 系统的吞吐量瓶颈往往出现在数据库的访问速度上随着应用程序的运行&#…
阅读更多...
mysql linux导入csv主键,MySQL导入csv文件内容到Table及数据库的自增主键设置

mysql linux导入csv主键,MySQL导入csv文件内容到Table及数据库的自增主键设置

写在前面目的是测试将csv文件内容导入到表中, 同时记录一下自增主键的设置.测试采用MySQL8.0.新建表customer_info如下, 未设置主键.修改上表, 添加主键id, 并设置为自增.ALTER TABLE customer_info ADD COLUMN id INT AUTO_INCREMENT NOT NULL PRIMARY KEY;导入步骤1.为了模拟…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023