Spring Boot 实战:基于 Validation 注解实现分层数据校验与校验异常拦截器统一返回处理

embedded/2024/11/26 16:21:11/

1. 概述

        本文介绍了在spring boot框架下,使用validation数据校验注解,针对不同请求链接的前端传参数据,进行分层视图对象的校验,并通过配置全局异常处理器捕获传参校验失败异常,自动返回校验出错的异常数据。

2. 依赖包导入

        导入校验注解,本文使用的是spring boot框架下的validation校验包,首先将如下代码配置到pom.xml中并更新maven

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

3. 校验规则注解

        在java Bean中针对需要校验的属性字段编写对应的校验注解

3.1 视图对象分层的意义

        对同一个数据库中同一张表进行不同操作,前端传入的入参校验法则是不一样的,甚至相互之间还有冲突,因此针对同一个javaBean使用同一套入参数据校验是不可行的。

举个例子,比如对如下java Bean数据进行新增操作和更新操作,其ID字段的校验规则就完全冲突,新增时,要求前端不传入,因为这个字段是数据库自增字段。而在更新操作时,ID字段是必传字段,因为是通过这个字段定位到具体要修改的那条数据。因此需要根据不同的入参需求建立分层视图对象,进行分别校验。

java">@Data
public class Employee {private Long id;private String name;private Integer age;private  String email;private String gender;private String address;private BigDecimal salary;
}

3.2 分层对象的设计模式

设计模式:单一职责 (新建和修改用到的校验规则不一致)
JavaBean也要分层,各种xxO:
Pojo:普通java
Dao:Database Access Object : 专门用来访问数据库的对象
DTO:Data Transfer Object: 专门用来传输数据的对象;
TO:transfer Object: 专门用来传输数据的对象;
BO:Business Object: 业务对象(Service),专门用来封装业务逻辑的对象;
VO:View/Value Object: 值对象,视图对象(专门用来封装前端数据的对象)

3.3 视图对象最佳实践举例

根据如上设计模式,本文分别针对新增和更新操作建立两个视图对象,如下所示:

新增视图对象,仅供新增接口使用的入参接收对象

java">@Data
public class EmployeeAddVo {@NotBlank(message = "姓名不能为空")private String name;@NotNull(message = "年龄不能为空")@Max(value = 150, message = "年龄不能超过150岁")@Min(value = 0, message = "年龄不能小于0岁")private Integer age;@Email(message = "邮箱格式不正确")private String email;@Pattern(regexp = "^男|女$",message = "性别只能为男或者女")private String gender;private String address;private BigDecimal salary;
}

更新视图对象,仅供更新接口使用的入参接收对象 

java">@Data
public class EmployeeUpdateVo {@NotNull(message = "id不能为空")private Long id;private String name;@Max(value = 150, message = "年龄不能超过150岁")@Min(value = 0, message = "年龄不能小于0岁")private Integer age;@Email(message = "邮箱格式不正确")private String email;@Pattern(regexp = "^男|女$",message = "性别只能为男或者女")private String gender;private String address;private BigDecimal salary;
}

3.4 非空校验注解混淆区分         

上述注解中运用到了非空校验注解,@NotNull、@NotEmpty、@NotBlank 都是用于在数据校验中检查字段值是否为空的注解,但是它们的用法和校验规则有所不同。
        @NotNull  (包装类型不为null) : @NotNull 注解是 JSR 303 规范中定义的注解,当被标注的字段值为 null 时,会认为校验失败而抛出异常。该注解不能用于字符串类型的校验,若要对字符串进行校验,应该使用 @NotBlank 或 @NotEmpty 注解。

        @NotEmpty (集合类型长度大于0) :@NotEmpty 注解同样是 JSR 303 规范中定义的注解,对于 CharSequence、Collection、Map 或者数组对象类型的属性进行校验,校验时会检查该属性是否为 Null 或者 size()==0,如果是的话就会校验失败。但是对于其他类型的属性,该注解无效。需要注意的是只校验空格前后的字符串,如果该字符串中间只有空格,不会被认为是空字符串,校验不会失败。

        @NotBlank (字符串,不为null,切不为"  "字符串): @NotBlank 注解是 Hibernate Validator 附加的注解,对于字符串类型的属性进行校验,校验 时会检查该属性是否为 Null 或 “” 或者只包含空格,如果是的话就会校验失败。需要注意的是,@NotBlank 注解只能用于字符串类型的校验。  

4. 校验生效注解

        在controller层使用 @Valid 告诉 SpringMVC 进行校验,通过在入参中作用@Valid注解,让视图对象中各个属性的数据校验生效,见如下代码:

java">@RestController
@CrossOrigin
@RequestMapping("api/v1")
public class EmployeeRestController {@Autowiredprivate EmployeeService employeeService;/*** 新增员工;* 要求:前端发送请求把员工的json放在请求体中* @param employee* @return*/@PostMapping("/employee")public R add(@RequestBody @Valid EmployeeAddVo vo){//把vo转为do;Employee employee = new Employee();//属性对拷BeanUtils.copyProperties(vo,employee);employeeService.saveEmp(employee);return R.ok();}/*** 修改员工* 要求:前端发送请求把员工的json放在请求体中; 必须携带id* @param vo* @return*/@PutMapping("/employee")public R update(@RequestBody @Valid EmployeeUpdateVo vo){Employee employee = new Employee();BeanUtils.copyProperties(vo,employee);employeeService.updateEmp(employee);return R.ok();}}

同时还需要配合使用BeanUtils.copyProperties方法,将视图对象对拷贝到数据库对象中,完成数据库的操作。

5. 失败返回处理

        编写全局异常处理器,统一返回校验失败提示信息。根据上述@Valid注解作用于入参后,如果数据校验不通过,controller层会自动抛出校验不通过异常:MethodArgumentNotValidException,因此只需要使用全局拦截器捕获这个异常进行统一处理即可。

java">@RestControllerAdvice // @ControllerAdvice + @ResponseBody
public class GlobalExceptionHandler {@ExceptionHandler(value = MethodArgumentNotValidException.class)public R handleMethodArgumentNotValidException(MethodArgumentNotValidException e){BindingResult result = e.getBindingResult();Map<String,String> errorsMap = new HashMap<>();for (FieldError fieldError : result.getFieldErrors()) {// 1. 获取到属性名String field = fieldError.getField();// 2. 获取到错误信息String defaultMessage = fieldError.getDefaultMessage();errorsMap.put(field,defaultMessage);}return R.error(500,"校验失败",errorsMap);}
}

6. 最终效果展示

通过如上操作后,当进行新增和更新访问请求数据校验不通过时,就会出发数据校验失败异常,通过全局拦截器给前端返回需要的提示的内容:

新增数据校验示例:

更新数据校验示例:


http://www.ppmy.cn/embedded/140657.html

相关文章

RLC串联谐振,品质因数的影响

串联谐振 电路谐振是正弦稳态电路的一种特定的工作状态&#xff0c;通常发生在电感L&#xff0c;电容C和电阻R构成的电路。当高频信号通过电感或者电容的时候会产生感抗或者容抗&#xff0c;电感的感抗随着频率的增加而增加&#xff0c;电容的容抗随着频率的增加而降低。 对于串…

path.resolve、path.join

文章目录 一、path.resolve二、path.join node中的path 模块&#xff1a;用于处理文件和目录的路径的实用工具&#xff1b;经常在一些打包配置中出现 一、path.resolve __dirname属于常量&#xff0c;案例中为D:\2024\webpack\webpack-demo\src__dirname只能写在最前面&#xf…

AI写小说

从前有一个小女孩叫莉莉&#xff0c;她是个天真活泼的孩子&#xff0c;生活在一个美丽的村庄里。 莉莉的家人都非常喜欢她&#xff0c;因为她总是给人带来欢乐和笑声。她喜欢和小伙伴们一起玩耍&#xff0c;最喜欢的游戏就是躲猫猫。 一天&#xff0c;当莉莉正在和小伙伴们玩…

《Qt Creator:人工智能时代的跨平台开发利器》

《Qt Creator&#xff1a;人工智能时代的跨平台开发利器》 一、Qt Creator 简介&#xff08;一&#xff09;功能和优势&#xff08;二&#xff09;快捷键与效率提升&#xff08;三&#xff09;跨平台支持&#xff08;四&#xff09;工具介绍与使用主要特性&#xff1a;使用步骤…

GoF设计模式——结构型设计模式分析与应用

文章目录 UML图的结构主要表现为&#xff1a;继承&#xff08;抽象&#xff09;、关联 、组合或聚合 的三种关系。1. 继承&#xff08;抽象&#xff0c;泛化关系&#xff09;2. 关联3. 组合/聚合各种可能的配合&#xff1a;1. 关联后抽象2. 关联的集合3. 组合接口4. 递归聚合接…

设计模式之 模板方法模式

模板方法模式是行为型设计模式的一种。它定义了一个算法的骨架&#xff0c;并将某些步骤的实现延迟到子类中。模板方法模式允许子类在不改变算法结构的情况下重新定义算法的某些特定步骤。 模板方法模式的核心在于&#xff1a; 封装算法的骨架&#xff1a;通过父类中的模板方…

STM32串口——5个串口的使用方法

参考文档 STM32串口——5个串口的使用方法_51CTO博客_stm32串口通信的接收与发送 串口是我们常用的一个数据传输接口&#xff0c;STM32F103系列单片机共有5个串口&#xff0c;其中1-3是通用同步/异步串行接口USART(Universal Synchronous/Asynchronous Receiver/Transmitter)…

人工智能学习框架实例解析

人工智能学习框架在机器学习、深度学习和其他AI任务中发挥着关键作用。 一、TensorFlow TensorFlow是由Google开发的开源机器学习框架&#xff0c;广泛应用于学术界和工业界。它支持多种编程语言&#xff0c;包括Python、C和Java&#xff0c;并具有强大的社区支持和丰富的文档…