Java validation 校验常用的正则表达式

2024-06-05后端4 分钟327 次阅读
AI 摘要鱼粮不足,AI 今天先歇着 · 正文在下面

前言

我们在编写接口时,经常需要校验前端提交的表单参数,如果一个一个去判断参数代码冗余又不好看,我们可以使用validation来优雅的进行参数校验。

安装

SpringBoot 项目中引入如下依赖即可。

xml 复制代码
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

里边包含以下依赖
image.png
其中,Hibernate Validator是一个用于 Java Bean 验证的框架,它可以帮助我们在应用程序中实现数据校验和约束。

快速使用

我们在 Controller 下需要校验的接口处,添加@Valid注解即可,如下所示:
image.png
接着在待校验的 Bean 中,加上相应校验注解,如下:
image.png
我们使用接口文档工具测试,可以发现成功校验处理:
image.png
控制台也能看到日志信息
image.png
这里有一个比较重要的点,是我在全局异常处理那捕获了MethodArgumentNotValidException.class异常,代码如下:

java 复制代码
@RestControllerAdvice
@Slf4j
public class GlobalExceptionHandler {

    /**
     * 拦截所有参数校验异常请求
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public BaseResponse<?> methodArgumentNotValidException(MethodArgumentNotValidException e) {
        BindingResult bindingResult = e.getBindingResult();
        log.warn("参数校验异常:{}", bindingResult.getFieldErrors().get(0).getDefaultMessage());
        return ResultUtils.validateFail(bindingResult);
    }
}

这样子才能将异常信息返回给前端,如果不捕获异常进行相应处理的话,则会报如下信息,一大串,不方便查看,并且前端用户也不知道提交参数哪里有问题

sh 复制代码
2024-06-05 01:44:21.709  WARN 98452 --- [nio-5050-exec-1] .w.s.m.s.DefaultHandlerExceptionResolver  [208] : Resolved [org.springframework.web.bind.MethodArgumentNotValidException: Validation failed for argument [0] in public com.salmon.chatService.common.BaseResponse<java.lang.Object> com.salmon.chatService.controller.AccountController.registerByEmail(com.salmon.chatService.model.dto.account.EmailRegister) with 4 errors: [Field error in object 'emailRegister' on field 'nickname': rejected value []; codes [NotBlank.emailRegister.nickname,NotBlank.nickname,NotBlank.java.lang.String,NotBlank]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [emailRegister.nickname,nickname]; arguments []; default message [nickname]]; default message [请填写昵称]] [Field error in object 'emailRegister' on field 'checkCodeKey': rejected value []; codes [NotBlank.emailRegister.checkCodeKey,NotBlank.checkCodeKey,NotBlank.java.lang.String,NotBlank]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [emailRegister.checkCodeKey,checkCodeKey]; arguments []; default message [checkCodeKey]]; default message [验证码标识不能为空]] [Field error in object 'emailRegister' on field 'password': rejected value []; codes [NotBlank.emailRegister.password,NotBlank.password,NotBlank.java.lang.String,NotBlank]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [emailRegister.password,password]; arguments []; default message [password]]; default message [请输入密码]] [Field error in object 'emailRegister' on field 'email': rejected value [1111]; codes [Pattern.emailRegister.email,Pattern.email,Pattern.java.lang.String,Pattern]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [emailRegister.email,email]; arguments []; default message [email],[Ljavax.validation.constraints.Pattern$Flag;@837ac5d,^([A-Za-z0-9_\-\.])+\@([A-Za-z0-9_\-\.])+\.([A-Za-z]{2,4})$]; default message [请输入正确的邮箱]] ]

常用注解

我们需要用什么注解的话可以去 javax.validation.constraints 下查看
image.png

java 复制代码
@Null //被注解的元索必须为空
@NotNull //被注解的元素必须不为空
@NotBlank //用于验证字符串,验证字符串非 null,且trim后长度必须大于0
@NotEmpty //用于集合,验证注解的元素集合不为空,且长度大于0
@Min //被注解的元素必须是数字且必须小于等于指定值
@Max //被注解的元素必须是数字且必须大于等于指定值
@Size //验证对象(Array,Collection,Map,String)长度是否在给定的范围之内
@Past //被注解的元索必须是一个过去的日期
@Future //被注解的元素必须是一个将来的日期
@Pattern //被注解的元素必须符合给定的正则表达式
@AssertTure //被注解的元素必须为 ture
@AssertFalse //被注解的元素必须为 false
@DecimalMin //验证 Number 和 String 对象是否大等于指定的值,小数存在精度
@DecimalMax //验证 Number 和 String 对象是否小等于指定的值,小数存在精度
@Email //验证邮箱
@Digits //验证 Number 和 String 的构成是否合法

使用如下:

java 复制代码
// 以下三个没有设置值时会返回
@NotNull(message = “用户id不能为空”)

// 不会自动去掉字符串前后的空格再判断是否为空
@NotEmpty(message = “用户名不能为空”)

// 自动去掉字符串前后的空格再判断是否为空
@NotBlank(message = “密码不能为空”)

// 以下几个注解可以不设置值返回,因此最好根据业务需求加上以上注解来判断是否有值

// 即数量必须在6到20之间(包含6和20)
@Length(min = 6,max = 20,message = “密码不能少于6位,也不能多于20位”)

// 必须是正确的邮箱格式
@Email(message = “邮箱不正确”)

// 即年龄必须大于或者等于18岁
@Min(value = 18, message = “年龄不能小于18岁”)

// 即年龄必须等于小于60岁
@Max(value = 60, message = “年龄不能大于60岁”)

// 传来的时间只能是过去的时间或者现在的时间,不能是未来时间
@Past(message = “生日只能是过去的时间或者现在的时间”)

// 集合里面的内容不能少于1
@Size(min = 1,message = “不能少于一个好友”)

常用的正则表达式

统一社会信用码

java 复制代码
^([0-9A-HJ-NPQRTUWXY]{2}\d{6}[0-9A-HJ-NPQRTUWXY]{10}|[1-9]\d{14})$

身份证号

java 复制代码
^\d{17}[\d|x|X]|\d{15}$

电话号码或手机号

java 复制代码
^1[3,4,5,6,7,8,9]\d{9}$|^(0\d{2,3}-?|0\d2,3)?[1-9]\d{4,7}(-\d{1,8})?$

手机号

java 复制代码
^1[3,4,5,6,7,8,9]\d{9}$

电话号码

java 复制代码
^\d{3}-\d{8}|\d{4}-\d{7}$

中文

java 复制代码
^[\u4e00-\u9fa5]{0,}$

字母

java 复制代码
^[a-zA-Z]+$

英文和数字

java 复制代码
^[A-Za-z0-9]+$ 或
^[A-Za-z0-9]{4,40}$

中文、英文、数字包括下划线

java 复制代码
^[\u4E00-\u9FA5A-Za-z0-9_]+$

中文、英文、数字但不包括下划线等符号

java 复制代码
^[\u4E00-\u9FA5A-Za-z0-9]+$ 或
^[\u4E00-\u9FA5A-Za-z0-9]{2,20}$

邮箱

java 复制代码
^\w+([-+.]\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$ 或
^([A-Za-z0-9_\-\.])+\@([A-Za-z0-9_\-\.])+\.([A-Za-z]{2,4})$

URL

java 复制代码
[a-zA-z]+://[^\s]*或
^((https?|ftp|file):\/\/)?([\da-z\.-]+)\.([a-z\.]{2,6})([\/\w \.-]*)*\/?$

IPv4

java 复制代码
^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ 或
^((2(5[0-5]|[0-4]\d))|[0-1]?\d{1,2})(\.((2(5[0-5]|[0-4]\d))|[0-1]?\d{1,2})){3}$

中国邮政编码

java 复制代码
^[1-9]\d{5}(?!\d)$

车牌号

java 复制代码
^[京津沪渝冀豫云辽黑湘皖鲁新苏浙赣鄂桂甘晋蒙陕吉闽贵粤青藏川宁琼使领A-Z]{1}[A-Z]{1}[A-Z0-9]{4}[A-Z0-9挂学警港澳]{1}$

密码

java 复制代码
// 必须包含大小写字母和数字的组合,不能使用特殊字符,长度在 8-10 之间
^(?=.*\d)(?=.*[a-z])(?=.*[A-Z])[a-zA-Z0-9]{8,10}$
// 必须包含大小写字母和数字的组合,可以使用特殊字符,长度在8-10之间
^(?=.*\d)(?=.*[a-z])(?=.*[A-Z]).{8,10}$

小数

java 复制代码
^[-\+]?\d+(\.\d+)?$ 或
^(-?\d+)(\.\d+)?$ 或
^-?([1-9]\d*\.\d*|0\.\d*[1-9]\d*|0?\.0+|0)$

整数

java 复制代码
^[0-9]*$ 或
^[-+]?\d*$

正数、负数、和小数

java 复制代码
^(\-|\+)?\d+(\.\d+)?$

非零的正整数

java 复制代码
^[1-9]\d*$ 或
^([1-9][0-9]*){1,3} 或
^\+?[1-9][0-9]*$
觉得有用就点个赞,不用登录也能读

评论

0 条
登录 之后才能评论
—
还没有评论,来说第一句