Springboot校驗工具類詳細代碼示例

更新時間：2024年02月02日 11:32:24 作者：憨憨小江

這篇文章主要給大家介紹了關于Springboot校驗工具類的相關資料,工具類里面主要是封裝了一些常用字段驗證方法,文中通過代碼介紹的非常詳細,需要的朋友可以參考下

校驗工具類

這個實現(xiàn)邏輯很簡單,就是調(diào)用string的正則表達式

我這里的代碼要導入糊涂工具包

<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-all</artifactId>
    <version>5.7.17</version>
</dependency>

import cn.hutool.core.util.StrUtil;

public class RegexUtils {
    /**
     * 是否是無效手機格式
     * @param phone 要校驗的手機號
     * @return true:符合，false：不符合
     */
    public static boolean isPhoneInvalid(String phone){
        return mismatch(phone, RegexPatterns.PHONE_REGEX);
    }
    /**
     * 是否是無效郵箱格式
     * @param email 要校驗的郵箱
     * @return true:符合，false：不符合
     */
    public static boolean isEmailInvalid(String email){
        return mismatch(email, RegexPatterns.EMAIL_REGEX);
    }

    /**
     * 是否是無效驗證碼格式
     * @param code 要校驗的驗證碼
     * @return true:符合，false：不符合
     */
    public static boolean isCodeInvalid(String code){
        return mismatch(code, RegexPatterns.VERIFY_CODE_REGEX);
    }

    // 校驗是否不符合正則格式
    private static boolean mismatch(String str, String regex){
        if (StrUtil.isBlank(str)) {
            return true;
        }
        return !str.matches(regex);
    }
}

正則表達式常量類

public abstract class RegexPatterns {
    /**
     * 手機號正則
     */
    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位的字母、數(shù)字、下劃線
     */
    public static final String PASSWORD_REGEX = "^\\w{4,32}$";
    /**
     * 驗證碼正則, 6位數(shù)字或字母
     */
    public static final String VERIFY_CODE_REGEX = "^[a-zA-Z\\d]{6}$";

}

附：自定義注解工具類

還有一些情況，如果業(yè)務邏輯實在比較復雜，前端傳遞來的是字符串，在service層才轉換成對象的時候，就只能自定義校驗工具類了。

我寫了個demo，還是很好用的，不過需要手動調(diào)用校驗方法

import com.alibaba.fastjson.JSON;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.apache.commons.collections.CollectionUtils;
import org.springframework.http.HttpStatus;

import javax.validation.*;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import java.util.Set;

/**
 * @Author : wangbin
 * @Date : 2023/2/16 14:49
 * @Description:
 */
public class ValidationUtils {
    public static void validate(@Valid Object user,Class<?> ... clazz) {
        try (ValidatorFactory factory = Validation.buildDefaultValidatorFactory()) {
            Validator validator = factory.getValidator();
            if(clazz==null){
                clazz=new Class[0];
            }
            Set<ConstraintViolation<@Valid Object>> validateSet = validator.validate(user,clazz );
            if (!CollectionUtils.isEmpty(validateSet)) {
                String messages = validateSet.stream()
                        .map(ConstraintViolation::getMessage)
                        .reduce((m1, m2) -> m1 + "；" + m2)
                        .orElse("參數(shù)輸入有誤！");
                throw DataImportException.httpError(HttpStatus.BAD_REQUEST,messages);
            }
        }


    }

    @Data
    @NoArgsConstructor
    @AllArgsConstructor
    static class User {
        @NotNull(message = "姓名不能為空",groups = ProcessInfoUpdateGroup.class)
        private String name;



        @Max(value = 200, message = "age不能超200")
        @Min(value = 0, message = "age不能小于0",groups = ProcessInfoCreateGroup.class)
        private Integer age;
    }

    public static void main(String[] args) {
        User wb = new User(null, 201);

        String s = com.alibaba.fastjson.JSON.toJSONString(wb);

        User user = JSON.parseObject(s, User.class);
        validate(user);
    }
}