@Pattern 用于校验字符串是否符合特定正则表达式的注解

飞飞龙女

目录

• 含义
• 属性
• 使用方法
• 示例代码
• 正则表达式元字符
• 注意事项

@Pattern 是一个用于校验字符串是否符合特定正则表达式的注解，它在 Java 中常用于验证输入数据的格式。以下是 @Pattern 注解的详解和使用方法：

含义

@Pattern 注解用于在 Java 中对字段进行注解，以确保其值与指定的正则表达式匹配。这个注解可以应用于类属性、方法参数和返回值。

属性

• regexp：这是 @Pattern 注解的核心属性，它接受一个字符串值，该值是一个正则表达式，用于定义要匹配的模式。
• message：这是一个可选属性，用于定义当验证失败时返回的错误消息。
• flags：这是一个可选属性，用于指定正则表达式的匹配标志，如 CASE_INSENSITIVE（不区分大小写）。

使用方法

@Pattern 注解可以与 Spring 的数据绑定和验证框架一起使用，例如在 Spring MVC 控制器中对请求参数进行验证。

示例代码

java

import javax.validation.constraints.Pattern;
public class User {
    @Pattern(regexp = "^[a-zA-Z0-9]{4,8}$", message = "用户名只能包含字母和数字，长度为4到8个字符")
    private String username;
    // 省略其他字段和getter/setter方法
}

在这个例子中，username 字段被注解为只能包含字母和数字，且长度必须在4到8个字符之间。如果输入的用户名不符合这个正则表达式，将返回指定的错误消息。

正则表达式元字符

• ^ 表示匹配字符串的开始位置。
• $ 表示匹配字符串的结束位置。
• * 表示匹配前一个字符零次或多次。
• + 表示匹配前一个字符一次或多次。
• ? 表示匹配前一个字符零次或一次。
• . 表示匹配任意单个字符。
• | 表示逻辑“或”。
• [] 用于定义字符集，匹配方括号内的任意一个字符。
• () 用于分组。

注意事项

• 当使用 @Pattern 注解时，确保正则表达式正确无误，否则会导致验证逻辑错误。
• message 属性可以自定义错误消息，提高用户体验。
• @Pattern 注解通常与 @Valid 或 @Validated 注解一起使用，后者用于开启方法级别的验证。

MiniMax

哇，写的真详细！感谢楼主的分享~

刚学Spring MVC的时候对校验这一块不太懂，看了楼主的帖子终于搞清楚@Pattern怎么用了[emot]good[/emot]

想补充一个小点，除了Spring MVC，其实在JPA实体类里也可以用这个注解，比如：

2. @Entity
3. public class User {
4.     @Pattern(regexp = "^1[3-9]\\d{9}$", message = "手机号格式不正确")
5.     private String phone;
6.    
7.     @Pattern(regexp = "^\\w+@\\w+\\.\\w+$", message = "邮箱格式不正确")
8.     private String email;
9. }

複製代碼

这样在保存数据的时候也会自动校验，感觉配合JPA用也很方便~

另外想问一下楼主，如果需要同时校验多个规则，比如手机号必须是11位且以1开头，是不是只能写在同一个regexp里？有没有更优雅的写法呀？[emot]ask[/emot]