详解SpringBoot中的参数校验（项⽬实战）
Java后端发⼯作中经常会对前端传递过来的参数做⼀些校验，在业务中还要抛出异常或者不断的返回异常时的校验信息，充满
了if-else这种校验代码，在代码中相当冗长。例如说，⽤户注册时，会校验⼿机格式的正确性，⽤户名的长度等等。虽说前端也可以做参数校验，但是为了保证我们API接⼝的可靠性，以保证最终数据⼊库的正确性，后端进⾏参数校验不可忽视。Hibernate Validator提供了⼀种统⼀⽅便的⽅式，让我们快速的实现参数校验。
Hibernate Validator使⽤注解，实现声明式校验。⽽在实现原理上，也是基于 Spring AOP 拦截，实现校验相关的操作。straints包下，定义了⼀系列的约束( constraint )注解。⽂末会贴上⼀些常⽤的注解。如果项⽬的框架是 spring boot 的话，在spring-boot-starter-web中已经包含了Hibernate-validator的依赖（版本<2.3 ）。2.3以后的版本中spring-boot-starter-web
已经去除了这个依赖，需要⼿动引⼊Hibernate-validator依赖，并且有⼀些变化，因此 2.3.x 的版本暂不研究。本⽂使⽤的版本是2.2.8。
实战
1、创建实体类
se.pojo;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.straints.Length;
import straints.*;
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class User {
/**
* ⽤户ID
*/
@NotNull(message = "⽤户id不能为空")
private Long userId;
/**
* ⽤户名
*/
@NotBlank(message = "⽤户名不能为空")
@Length(max = 20, message = "⽤户名不能超过10个字符")
@Pattern(regexp = "^[\\u4E00-\\u9FA5A-Za-z0-9\\*]*$", message = "⽤户名限制：最多10字符，包含⽂字、字母和数字")
private String username;
/**
* 密码
*/
@NotBlank(message = "密码不能为空")
private String password;
/**
* ⼿机号
*/
@NotBlank(message = "⼿机号不能为空")
@Pattern(regexp = "^[1][3,4,5,6,7,8,9][0-9]{9}$", message = "⼿机号格式有误")
private String mobile;
/**
* 性别
*/
@NotNull(message = "性别不能为空")
private Integer sex;
/**
* 年龄
*/
@NotNull(message = "年龄不能为空")
@Min(value = 1, message = "年龄最⼩为1岁")
@Max(value = 120, message = "年龄最⼤为120岁")
private Integer age;
/**
* 邮箱
*/
@NotBlank(message = "邮箱不能为空")
@Email(message = "邮箱格式错误")
private String email;
}
validation框架2、创建controller
se.controller;
se.pojo.User;
slf4j.Slf4j;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
@RestController
@Slf4j
public class UserController {
/
**
* controller⽅法的⼊参⾥⾯在实体类前⾯加上@Validated
*/
@PostMapping("/user")
public void add(@RequestBody @Validated User user) {
log.info("user====={}", user);
}
}
3、创建全局异常处理器
se.config;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import javax.validation.ConstraintViolationException;
import java.util.HashMap;
import java.util.Map;
import java.util.StringJoiner;
/**
* 全局异常处理器
*/
@RestControllerAdvice
public class GlobalExceptionHandler {
/
**
* post⽅式提交json数据，参数校验失败后，会抛出⼀个MethodArgumentNotValidException
*/
@ExceptionHandler(MethodArgumentNotValidException.class)
public Map<String, Object> handleMethodArgumentNotValidException(MethodArgumentNotValidException e) { // 获取所有的错误
// List<FieldError> fieldErrors = e.getBindingResult().getFieldErrors();
// 获取错误提⽰
// System.out.(0).getDefaultMessage());
// 获取错误字段
// System.out.(0).getField());
// 将所有的错误提⽰使⽤";"拼接起来并返回
StringJoiner sj = new StringJoiner(";");
// 此处通常定义⼀个全局相应对象返回
Map<String, Object> map = new HashMap<>();
// 此处状态码可以通过枚举或者常量定义
map.put("code", 1001);
map.put("msg", sj.toString());
return map;
}
/**
* get⽅式提交参数，参数校验失败后，会抛出⼀个ConstraintViolationException
*/
@ExceptionHandler(ConstraintViolationException.class)
public Map<String, Object> handleConstraintViolationException(ConstraintViolationException e) {
StringJoiner sj = new StringJoiner(";");
Map<String, Object> map = new HashMap<>();
map.put("code", 1001);
map.put("msg", sj.toString());
return map;
}
}
4、测试
效果符合预期！
@Valid和@Validated
绝⼤多数场景下，我们使⽤ @Validated 注解即可。
⽽在有嵌套校验的场景，我们使⽤ @Valid 注解添加到成员属性上。
附常⽤注解
straints 包下
注解验证的数据类型说明
@Null任意类型验证注解的元素值必须是null
@NotNull任意类型验证注解的元素值不是null
@NotBlank字符串验证注解的元素值不为空（不为null、去除⾸位空格后长度⼤
于0）
@NotEmpty CharSequence⼦类型、Collection、
Map、数组
验证注解的元素值不为null且不为空（字符串长度不为0、集
合⼤⼩不为0）
@Min(value=值)数值类型验证注解的元素值⼤于等于@Min指定的value值
@Max（value=值）和@Min要求⼀样验证注解的元素值⼩于等于@Max指定的value值
@DecimalMin(value=
值)
和@Min要求⼀样验证注解的元素值⼤于等于@ DecimalMin指定的value值
@DecimalMax(value=
值)
和@Min要求⼀样验证注解的元素值⼩于等于@ DecimalMax指定的value值@Digits(integer=整数
位数, fraction=⼩数位
数)
和@Min要求⼀样验证注解的元素值的整数位数和⼩数位数上限
@Size(min=下限，验证注解的元素值的在min和max（包含）指定区间之内，如
max=上限)字符串、Collection、Map、数组等字符长度、集合⼤⼩
@Positive判断正数
@PositiveOrZero判断正数或 0 。
@Negative判断负数。
@NegativeOrZero判断负数或 0 。
@Past⽇期类型验证注解的元素值（⽇期类型）⽐当前时间早@Future与@Past要求⼀样验证注解的元素值（⽇期类型）⽐当前时间晚@AssertFalse Boolean验证注解的元素值是false
@AssertTrue Boolean验证注解的元素值是true
@Range(min=最⼩值, max=最⼤值)BigDecimal,BigInteger,CharSequence,
byte, short, int, long等原⼦类型和包装
类型
验证注解的元素值在最⼩值和最⼤值之间
@Email字符串验证注解的元素值是Email，也可以通过regexp和flag指定⾃
定义的email格式
@Pattern(regexp=正
则表达式,flag=标志的
模式)
字符串验证注解的元素值与指定的正则表达式匹配
@Valid任何⾮原⼦类型指定递归验证关联的对象如⽤户对象中有个地址对象属性，如果想在验证⽤户对象时⼀起验证地址对象的话，在地址对象上加@Valid注解即可级联验证
注解验证的数据类型说明
org.straints 包下，定义了⼀系列的约束( constraint )注解。如下：
@Range(min=, max=) ：被注释的元素必须在合适的范围内。
@Length(min=, max=)：被注释的字符串的⼤⼩必须在指定的范围内。
@URL(protocol=,host=,port=,regexp=,flags=) ：被注释的字符串必须是⼀个有效的 URL 。
@SafeHtml ：判断提交的 HTML 是否安全。例如说，不能包含 javascript 脚本等等。
到此这篇关于详解SpringBoot中的参数校验(项⽬实战)的⽂章就介绍到这了，更多相关SpringBoot 参数校验内容请搜索以前的⽂章或继续浏览下⾯的相关⽂章希望⼤家以后多多⽀持！
版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。
发表评论