自定义注解实现参数校验

个人博客地址：
http://xiaohe-blog.top/

文章目录

• 1. 为什么要进行参数校验
• 2. 如何实现参数校验
• 3. 注解实现参数校验
• 4. 自定义注解实现参数校验

1. 为什么要进行参数校验

在后端进行工作时，需要接收前端传来的数据去数据库查询，但是如果有些数据过于离谱，我们就可以直接把它pass掉，不让这种垃圾数据接触数据库，减小数据库的压力。

有时候会有不安分的人通过一些垃圾数据攻击咱们的程序，让咱们的服务器或数据库崩溃，这种攻击虽然低级但不得不防，就像QQ进行登录请求时，它们向后端发送 账号=123，密码=123 的数据，一秒钟还发1w次，这很明显就是找事的好吧，什么人类的手速能达到1秒1万次？

解决方法是：一方面我们可以通过Redis记录ip/账号的方式拒绝一部分请求，例如1s中同一个ip/账号最多请求100次。另一方面就是进行数据校验pass一部分数据，这100里又多少次是垃圾数据。这样就可以尽量减小服务器数据库的压力。

2. 如何实现参数校验

实现参数校验说实话方式还挺多，个人使用过直接在Controller代码里面写、AOP+自定义注解、ConstraintValidator。本篇博客讲的是ConstraintValidator实现。

直接在Controller代码里面写，说实话，写起来是简单，但是臃肿，耦合性高，最主要是，不够优雅。

AOP实现有难度，代码繁琐，显得逻辑杂乱。

所以我建议使用ConstraintValidator。

在这里先提供一个工具类进行参数校验，提供了对于手机号、邮箱、验证码、密码、身份证号的验证方法，可以直接copy来用。等下进行参数校验时我使用的就是这个类里的校验方法。

/**
 * @description : 验证手机号、身份证号、密码、验证码、邮箱的工具类
 * @author : 小何
 */
public class VerifyUtils {
    /**
     * 手机号正则
     */
    public static final String PHONE_REGEX = "^1([38][0-9]|4[579]|5[0-3,5-9]|6[6]|7[0135678]|9[89])\\d{8}$";

    /**
     * 邮箱正则
     */
    public static final String EMAIL_REGEX = "^[a-zA-Z0-9_-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$";

    /**
     * 密码正则。4~32位的字母、数字、下划线
     */
    public static final String PASSWORD_REGEX = "^\\w{4,32}$";

    /**
     * 验证码正则, 6位数字或字母
     */
    public static final String VERIFY_CODE_REGEX = "^[a-zA-Z\\d]{6}$";

    /**
     * 身份证号正则
     */
    public static final String ID_CARD_NUMBER_REGEX_18 = "^[1-9]\\d{5}(18|19|([23]\\d))\\d{2}((0[1-9])|(10|11|12))(([0-2][1-9])|10|20|30|31)\\d{3}[0-9Xx]$";
    public static final String ID_CARD_NUMBER_REGEX_15 = "^[1-9]\\d{5}\\d{2}((0[1-9])|(10|11|12))(([0-2][1-9])|10|20|30|31)\\d{2}$";


    /**
     * 手机号是否合法
     * @param phone 要校验的手机号
     * @return true:符合，false：不符合
     */
    public static boolean isPhoneLegal(String phone){
        return match(phone, PHONE_REGEX);
    }
    /**
     * 是否是无效邮箱格式
     * @param email 要校验的邮箱
     * @return true:符合，false：不符合
     */
    public static boolean isEmailLegal(String email){
        return match(email, EMAIL_REGEX);
    }

    /**
     * 是否是无效验证码格式
     * @param code 要校验的验证码
     * @return true:符合，false：不符合
     */
    public static boolean isCodeLegal(String code){
        return match(code, VERIFY_CODE_REGEX);
    }

    // 校验是否不符合正则格式
    private static boolean match(String str, String regex){
        if (str == null || "".equals(str)) {
            return false;
        }
        return str.matches(regex);
    }

    /**
     * 验证身份证号是否合法
     * @param idCard 身份证号
     * @return true: 合法；    false:不合法
     */
    public static boolean isIdCardLegal(String idCard) {
        if (idCard.length() == 18) {
            return match(idCard, ID_CARD_NUMBER_REGEX_18);
        } else {
            return match(idCard, ID_CARD_NUMBER_REGEX_15);
        }
    }
}

使用案例：

public static void main(String[] args) {
    String phone = "15039469595";
    boolean phoneLegal = VerifyUtils.isPhoneLegal(phone);
    System.out.println(phoneLegal);
}

3. 注解实现参数校验

首先导入依赖：

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

导入依赖后可以尝试使用一下它自带的参数校验注解：@NotNull 非空校验

先来说一下注解实现参数校验的使用步骤。

在平时写的demo中，本人比较喜欢对接口另外定义vo来接收数据，例如前端传的数据是user对象里的username和password，我们的user里有很多字段，如果单纯使用user就太浪费了，而且如果直接在实体类上进行自定义注解会对实体类造成代码污染。所以个人认为定义vo类是很有必要的。

以下是我的登录接口：

@PostMapping("/login")
public String login(@RequestBody @Validated LoginVo user) {

    return "user:" + user.toString();
}

以下是我登录接口的vo类：

@Data
public class LoginVo {
    // 邮箱
    @NotNull(message = "邮箱不能为空")
    private String email;
    // 密码
    private String password;
}

大家可能注意到我多写了两个注解：@Validated、@NotNull(message = “邮箱不能为空”)

对，使用注解进行参数校验就分为两步：

1. 在需要进行校验的字段上加对应校验方式，如@NotNull
2. 在需要进行校验的接口参数前加@Validated，告诉Spring，这个类你给我看一下，里面有的字段加了校验注解，符合要求就放行，不符合要求就报错。

如图所示：

使用postman发起请求，故意使得邮箱为空：

会发现报错：

Resolved [org.springframework.web.bind.MethodArgumentNotValidException: 
Validation failed for argument [0] in public java.lang.String com.example.demo.controller.UserController.login(com.example.demo.domain.vo.LoginVo): 
[Field error in object 'loginVo' on field 'email': rejected value [null]; codes [NotNull.loginVo.email,NotNull.email,NotNull.java.lang.String,NotNull]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [loginVo.email,email]; arguments []; 
default message [email]]; 
default message [邮箱不能为空]] ]

出现这个异常：MethodArgumentNotValidException，我们就可以在全局异常处理器中捕获它，返回一个较为规范的信息。

4. 自定义注解实现参数校验

学习了如何使用注解进行参数校验，我们就可以进行接下来的工作：自定义注解。

由于需求的复杂，我们现在需要完成注册接口，注册时需要身份证号、电话号码、邮箱、密码，这些字段的注解校验Spring并没有帮我们实现，此时就需要DIY注解满足需求。

如何实现自定义注解？我们先模仿，先来看看@NotNull注解里面有什么：

@Target、@Retention、@Repeatable、@Documented这些常用的注解就不再解释，

@Constraint：表示此注解是一个参数校验的注解，validateBy指定校验规则实现类，这里需要填实现类.class。

各个字段的含义：

message ：数据不符合校验规则后的报错信息。可以是字符串也可以是文件，如果校验字段较多，建议实现文件形式。

groups ：指定注解使用场景，例如新增、删除

payload ：往往对Bean使用

以上这三个字段都是必须的，每一个使用ConstraintValidator完成参数校验都要有这三个字段。

后面的那个List是NotNull专属的，所以不必关心。

那么我们大可以模仿@NotNull来实现自定义注解。

第一步：实现校验类：

需要实现一个接口：ConstraintValidator<?, ?>

# ConstraintValidator<?, ?>
第一个参数是自定义注解
第二个参数是需要进行校验的数据的数据类型
例如想对手机号校验,第一个参数是Phone，第二个参数是String

这个接口提供了一个方法：

boolean isValid(T value, ConstraintValidatorContext context);

第一个参数就是前端传来的数据。我们可以对这个数据进行判断，返回一个布尔值

public class VerifyPhone implements ConstraintValidator<Phone, String> {

    @Override
    public boolean isValid(String s, ConstraintValidatorContext constraintValidatorContext) {
       // 判断手机号是否合法
        return VerifyUtils.isPhoneLegal(s);
    }
}

第二步：实现注解，这个注解的名称需要与ConstraintValidator的第一个参数保持一致。

特别注意的是，@Constraint注解里面的validatedBy的值是第一步的Class实例。

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(
        validatedBy = {VerifyPhone.class}
)
public @interface Phone {
    boolean isRequired() default false;

    String message() default "手机号格式错误";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

}

第三步：在字段上加上相应注解。

@Data
public class RegisterVo {
    private String name;
    // 身份证号
    private String id;
    // 电话号码
    @Phone
    private String phone;
    // 邮箱
    private String email;
    // 密码
    private String password;
}

第四步：在参数前加上@Validated。

@PutMapping("/register")
public String register(@RequestBody @Validated RegisterVo user) {
    return "user: " + user.toString();
}

这样一来，就优雅的实现了参数校验。别以为我们搞这么多类很麻烦，除非你想每一个controller里都这样写：

@PutMapping("/register")
public String register(@RequestBody @Validated RegisterVo user) {
    if (VerifyUtils.isPhoneLegal("xxx")) {
        return "手机号格式错误";
    }
    if (VerifyUtils.isCodeLegal("xxx")) {
        return "验证码格式错误";
    }
    if (VerifyUtils.isIdCardLegal("xxx")) {
        return "身份证格式错误";
    }
    if (VerifyUtils.isEmailLegal("xxx")) {
        return "邮箱格式错误";
    }
    return "user: " + user.toString();
}

真的很low很麻烦好吗。

可能步骤有点繁琐，不过也就4步，画张图加强一下记忆：