SpringBoot Validation

最新推荐文章于 2023-07-17 16:59:06 发布
最新推荐文章于 2023-07-17 16:59:06 发布
阅读量1.5k 收藏 5
点赞数 2
分类专栏： 架构设计 # springboot Java & Spring 文章标签： spring boot java spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/luo15242208310/article/details/120074866
版权

目录

提到输入参数的基本验证（非空、长度、大小、格式…），在以前我们还是通过手写代码，各种if、else、StringUtils.isEmpty、CollectionUtils.isEmpty…，真感觉快要疯了，太繁琐，Low爆了…，其实在Java生态提供了一套标准JSR-380（aka. Bean Validation 2.0，part of Jakarta EE and JavaSE），它已成为对象验证事实上的标准，这套标准可以通过注解的形式（如@NotNull, @Size…）来对bean的属性进行验证。而Hibernate Validator对这套标准进行了实现，SpringBoot Validation无缝集成了Hibernate Validator、自定义验证器、自动验证的功能。下文将对SpringBoot集成Validation进行展开。

注： 完整示例代码可参见GitHub：https://github.com/marqueeluo/spring-boot-validation-demo

constraints分类

JSR-380的支持的constrants注解汇总如下表：

分类注解适用对象null是否验证通过说明
非空@NotNull所有对象No不是null
非空@NotEmptyCharSequence, Collection, Map, ArrayNo不是null、不是""、size>0
非空@NotBlankCharSequenceNo不是null、trim后长度大于0
非空@Null所有对象Yes是null
长度@Size(min=0, max=Integer.MAX_VALUE)CharSequence, Collection, Map, ArrayYes字符串长度、集合size
大小@PositiveBigDecimal, BigInteger, byte, short, int, long, float, doubleYes数字>0
大小@PositiveOrZeroBigDecimal, BigInteger, byte, short, int, long, float, doubleYes数字>=0
大小@NegativeBigDecimal, BigInteger, byte, short, int, long, float, doubleYes数字<0
大小@NegativeOrZeroBigDecimal, BigInteger, byte, short, int, long, float, doubleYes数字<=0
大小@Min(value=0L)BigDecimal, BigInteger, byte, short, int, longYes数字>=min.value
大小@Max(value=0L)BigDecimal, BigInteger, byte, short, int, longYes数字<=max.value
大小@Range(min=0L, max=Long.MAX_VALUE)BigDecimal, BigInteger, byte, short, int, longYesrange.min<=数字<=range.max
大小@DecimalMin(value="")BigDecimal, BigInteger, CharSequence, byte, short, int, longYes数字>=decimalMin.value
大小@DecimalMax(value="")BigDecimal, BigInteger, CharSequence, byte, short, int, longYes数字<=decimalMax.value
日期@Past
  • java.util.Date
  • java.util.Calendar
  • java.time.Instant
  • java.time.LocalDate
  • java.time.LocalDateTime
  • java.time.LocalTime
  • java.time.MonthDay
  • java.time.OffsetDateTime
  • java.time.OffsetTime
  • java.time.Year
  • java.time.YearMonth
  • java.time.ZonedDateTime
  • java.time.chrono.HijrahDate
  • java.time.chrono.JapaneseDate
  • java.time.chrono.MinguoDate
  • java.time.chrono.ThaiBuddhistDate
Yes时间在当前时间之前
日期@PastOrPresent同上Yes时间在当前时间之前 或者等于此时
日期@Future同上Yes时间在当前时间之后
日期@FutureOrPresent同上Yes时间在当前时间之后 或者等于此时
格式@Pattern(regexp="", flags={})CharSequenceYes匹配正则表达式
格式@Email
@Email(regexp=".*", flags={})		CharSequenceYes匹配邮箱格式
格式@Digts(integer=0, fraction=0)BigDecimal, BigInteger, CharSequence, byte, short, int, longYes必须是数字类型，且满足整数位数<=digits.integer, 浮点位数<=digits.fraction
布尔@AssertTruebooleanYes必须是true
布尔@AssertFalsebooleanYes必须是false

注： 后续还需补充Hibernate Validator中实现的constraints注解，如表中@Range。

contraints提示信息

查看contraints源码发现，message属性即验证未通过时的提示信息，
我们自定义contraints注解时可以直接返回字符串，亦可以如源码中使用{propertry.name}的形式指定
在这里插入图片描述
具体的properties定义在如下图中hibernate-validator中
在这里插入图片描述
其中的ValidationMessages.properties为父属性，具体到语言的properties继承该父属性，如ValidationMessage_en.properties内容为空，则完全继承自ValidationMessages.properties，ValidationMessages.properties定义如下：

javax.validation.constraints.AssertFalse.message     = must be false
javax.validation.constraints.AssertTrue.message      = must be true
javax.validation.constraints.DecimalMax.message      = must be less than ${inclusive == true ? 'or equal to ' : ''}{value}
javax.validation.constraints.DecimalMin.message      = must be greater than ${inclusive == true ? 'or equal to ' : ''}{value}
javax.validation.constraints.Digits.message          = numeric value out of bounds (<{integer} digits>.<{fraction} digits> expected)
javax.validation.constraints.Email.message           = must be a well-formed email address
javax.validation.constraints.Future.message          = must be a future date
javax.validation.constraints.FutureOrPresent.message = must be a date in the present or in the future
javax.validation.constraints.Max.message             = must be less than or equal to {value}
javax.validation.constraints.Min.message             = must be greater than or equal to {value}
javax.validation.constraints.Negative.message        = must be less than 0
javax.validation.constraints.NegativeOrZero.message  = must be less than or equal to 0
javax.validation.constraints.NotBlank.message        = must not be blank
javax.validation.constraints.NotEmpty.message        = must not be empty
javax.validation.constraints.NotNull.message         = must not be null
javax.validation.constraints.Null.message            = must be null
javax.validation.constraints.Past.message            = must be a past date
javax.validation.constraints.PastOrPresent.message   = must be a date in the past or in the present
javax.validation.constraints.Pattern.message         = must match "{regexp}"
javax.validation.constraints.Positive.message        = must be greater than 0
javax.validation.constraints.PositiveOrZero.message  = must be greater than or equal to 0
javax.validation.constraints.Size.message            = size must be between {min} and {max}

org.hibernate.validator.constraints.CreditCardNumber.message        = invalid credit card number
org.hibernate.validator.constraints.Currency.message                = invalid currency (must be one of {value})
org.hibernate.validator.constraints.EAN.message                     = invalid {type} barcode
org.hibernate.validator.constraints.Email.message                   = not a well-formed email address
org.hibernate.validator.constraints.ISBN.message                    = invalid ISBN
org.hibernate.validator.constraints.Length.message                  = length must be between {min} and {max}
org.hibernate.validator.constraints.CodePointLength.message         = length must be between {min} and {max}
org.hibernate.validator.constraints.LuhnCheck.message               = the check digit for ${validatedValue} is invalid, Luhn Modulo 10 checksum failed
org.hibernate.validator.constraints.Mod10Check.message              = the check digit for ${validatedValue} is invalid, Modulo 10 checksum failed
org.hibernate.validator.constraints.Mod11Check.message              = the check digit for ${validatedValue} is invalid, Modulo 11 checksum failed
org.hibernate.validator.constraints.ModCheck.message                = the check digit for ${validatedValue} is invalid, {modType} checksum failed
org.hibernate.validator.constraints.Normalized.message              = must be normalized
org.hibernate.validator.constraints.NotBlank.message                = may not be empty
org.hibernate.validator.constraints.NotEmpty.message                = may not be empty
org.hibernate.validator.constraints.ParametersScriptAssert.message  = script expression "{script}" didn't evaluate to true
org.hibernate.validator.constraints.Range.message                   = must be between {min} and {max}
org.hibernate.validator.constraints.ScriptAssert.message            = script expression "{script}" didn't evaluate to true
org.hibernate.validator.constraints.UniqueElements.message          = must only contain unique elements
org.hibernate.validator.constraints.URL.message                     = must be a valid URL

org.hibernate.validator.constraints.br.CNPJ.message                 = invalid Brazilian corporate taxpayer registry number (CNPJ)
org.hibernate.validator.constraints.br.CPF.message                  = invalid Brazilian individual taxpayer registry number (CPF)
org.hibernate.validator.constraints.br.TituloEleitoral.message      = invalid Brazilian Voter ID card number

org.hibernate.validator.constraints.pl.REGON.message                = invalid Polish Taxpayer Identification Number (REGON)
org.hibernate.validator.constraints.pl.NIP.message                  = invalid VAT Identification Number (NIP)
org.hibernate.validator.constraints.pl.PESEL.message                = invalid Polish National Identification Number (PESEL)

org.hibernate.validator.constraints.ru.INN.message                  = invalid Russian taxpayer identification number (INN)

org.hibernate.validator.constraints.time.DurationMax.message        = must be shorter than${inclusive == true ? ' or equal to' : ''}${days == 0 ? '' : days == 1 ? ' 1 day' : ' ' += days += ' days'}${hours == 0 ? '' : hours == 1 ? ' 1 hour' : ' ' += hours += ' hours'}${minutes == 0 ? '' : minutes == 1 ? ' 1 minute' : ' ' += minutes += ' minutes'}${seconds == 0 ? '' : seconds == 1 ? ' 1 second' : ' ' += seconds += ' seconds'}${millis == 0 ? '' : millis == 1 ? ' 1 milli' : ' ' += millis += ' millis'}${nanos == 0 ? '' : nanos == 1 ? ' 1 nano' : ' ' += nanos += ' nanos'}
org.hibernate.validator.constraints.time.DurationMin.message        = must be longer than${inclusive == true ? ' or equal to' : ''}${days == 0 ? '' : days == 1 ? ' 1 day' : ' ' += days += ' days'}${hours == 0 ? '' : hours == 1 ? ' 1 hour' : ' ' += hours += ' hours'}${minutes == 0 ? '' : minutes == 1 ? ' 1 minute' : ' ' += minutes += ' minutes'}${seconds == 0 ? '' : seconds == 1 ? ' 1 second' : ' ' += seconds += ' seconds'}${millis == 0 ? '' : millis == 1 ? ' 1 milli' : ' ' += millis += ' millis'}${nanos == 0 ? '' : nanos == 1 ? ' 1 nano' : ' ' += nanos += ' nanos'}

而中文环境对应的配置ValidationMessage_zh_CN.properties如下：

# 源码为unicode格式，如\u5fc5\u987b\u4e3anull）形式，需将unicode十六进制转换为字符进行查看
javax.validation.constraints.AssertFalse.message     = 只能为false
javax.validation.constraints.AssertTrue.message      = 只能为true
javax.validation.constraints.DecimalMax.message      = 必须小于${inclusive == true ? '或等于' : ''}{value}
javax.validation.constraints.DecimalMin.message      = 必须大于${inclusive == true ? '或等于' : ''}{value}
javax.validation.constraints.Digits.message          = 数字的值超出了允许范围(只允许在{integer}位整数和{fraction}位小数范围内)
javax.validation.constraints.Email.message           = 不是一个合法的电子邮件地址
javax.validation.constraints.Future.message          = 需要是一个将来的时间
javax.validation.constraints.FutureOrPresent.message = 需要是一个将来或现在的时间
javax.validation.constraints.Max.message             = 最大不能超过{value}
javax.validation.constraints.Min.message             = 最小不能小于{value}
javax.validation.constraints.Negative.message        = 必须是负数
javax.validation.constraints.NegativeOrZero.message  = 必须是负数或零
javax.validation.constraints.NotBlank.message        = 不能为空
javax.validation.constraints.NotEmpty.message        = 不能为空
javax.validation.constraints.NotNull.message         = 不能为null
javax.validation.constraints.Null.message            = 必须为null
javax.validation.constraints.Past.message            = 需要是一个过去的时间
javax.validation.constraints.PastOrPresent.message   = 需要是一个过去或现在的时间
javax.validation.constraints.Pattern.message         = 需要匹配正则表达式"{regexp}"
javax.validation.constraints.Positive.message        = 必须是正数
javax.validation.constraints.PositiveOrZero.message  = 必须是正数或零
javax.validation.constraints.Size.message            = 个数必须在{min}和{max}之间

org.hibernate.validator.constraints.CreditCardNumber.message        = 不合法的信用卡号码
org.hibernate.validator.constraints.Currency.message                = 不合法的货币 (必须是{value}其中之一)
org.hibernate.validator.constraints.EAN.message                     = 不合法的{type}条形码
org.hibernate.validator.constraints.Email.message                   = 不是一个合法的电子邮件地址
org.hibernate.validator.constraints.Length.message                  = 长度需要在{min}和{max}之间
org.hibernate.validator.constraints.CodePointLength.message         = 长度需要在{min}和{max}之间
org.hibernate.validator.constraints.LuhnCheck.message               = ${validatedValue}的校验码不合法, Luhn模10校验和不匹配
org.hibernate.validator.constraints.Mod10Check.message              = ${validatedValue}的校验码不合法, 模10校验和不匹配
org.hibernate.validator.constraints.Mod11Check.message              = ${validatedValue}的校验码不合法, 模11校验和不匹配
org.hibernate.validator.constraints.ModCheck.message                = ${validatedValue}的校验码不合法, {modType}校验和不匹配
org.hibernate.validator.constraints.NotBlank.message                = 不能为空
org.hibernate.validator.constraints.NotEmpty.message                = 不能为空
org.hibernate.validator.constraints.ParametersScriptAssert.message  = 执行脚本表达式"{script}"没有返回期望结果
org.hibernate.validator.constraints.Range.message                   = 需要在{min}和{max}之间
org.hibernate.validator.constraints.ScriptAssert.message            = 执行脚本表达式"{script}"没有返回期望结果
org.hibernate.validator.constraints.URL.message                     = 需要是一个合法的URL

org.hibernate.validator.constraints.time.DurationMax.message        = 必须小于${inclusive == true ? '或等于' : ''}${days == 0 ? '' : days += '天'}${hours == 0 ? '' : hours += '小时'}${minutes == 0 ? '' : minutes += '分钟'}${seconds == 0 ? '' : seconds += '秒'}${millis == 0 ? '' : millis += '毫秒'}${nanos == 0 ? '' : nanos += '纳秒'}
org.hibernate.validator.constraints.time.DurationMin.message        = 必须大于${inclusive == true ? '或等于' : ''}${days == 0 ? '' : days += '天'}${hours == 0 ? '' : hours += '小时'}${minutes == 0 ? '' : minutes += '分钟'}${seconds == 0 ? '' : seconds += '秒'}${millis == 0 ? '' : millis += '毫秒'}${nanos == 0 ? '' : nanos += '纳秒'}

对象集成constraints示例

/**
 * 用户 - DTO
 *
 * @author luohq
 * @date 2021-09-04 13:45
 */
public class UserDto {

    @NotNull(groups = Update.class)
    @Positive
    private Long id;

    @NotBlank
    @Size(max = 32)
    private String name;

    @NotNull
    @Range(min = 1, max = 2)
    private Integer sex;

    @NotBlank
    @Pattern(regexp = "^\\d{8,11}$")
    private String phone;

    @NotNull
    @Email
    private String mail;

    @NotNull
    @Pattern(regexp = "^\\d{4}-\\d{2}-\\d{2}$")
    private String birthDateStr;

    @NotNull
    @PastOrPresent
    private LocalDate birthLocalDate;

    @NotNull
    @Past
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime registerLocalDatetime;

    @Valid
    @NotEmpty
    private List<OrgDto> orgs;

	//省略getter、setter、toString方法	
}

/**
 * 组织 - DTO
 *
 * @author luohq
 * @date 2021-09-04 14:10
 */
public class OrgDto {
    @NotNull
    @Positive
    private Long orgId;

    @NotBlank
    @Size(min = 1, max = 32)
    private String orgName;
    
    //省略getter、setter、toString方法	
}

注：

  • 可通过constraints注解的groups指定分组
    即指定constraints仅在指定group生效，默认均为Default分组，
    后续可通过@Validated({MyGroupInterface.class}）形式进行分组的指定
  • 可通过@Valid注解进行级联验证（Cascaded Validation，即嵌套对象验证）
    如上示例中@Valid添加在 List<OrgDto> orgs上，即会对list中的每个OrgDto进行验证

SpringBoot集成自动验证

参考：
https://www.baeldung.com/javax-validation-method-constraints#validation

集成maven依赖

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

验证RequestBody、Form对象参数

在参数前加@Validated
在这里插入图片描述

验证简单参数

在controller类上加@Validated
在这里插入图片描述

验证指定分组

在这里插入图片描述

全局controller验证异常处理

通过@ControllerAdvice、@ExceptionHandler来对SpringBoot Validation验证框架抛出的异常进行统一处理，
并将错误信息拼接后统一返回，具体处理代码如下：

import com.luo.demo.validation.domain.result.CommonResult;
import com.luo.demo.validation.enums.RespCodeEnum;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.http.HttpStatus;
import org.springframework.validation.BindException;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;

import javax.servlet.http.HttpServletRequest;
import javax.validation.ConstraintViolationException;
import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;
import java.util.stream.Stream;

/**
 * controller增强 - 通用异常处理
 *
 * @author luohq
 * @date 2021-09-04 13:43
 */
@ControllerAdvice
public class ControllerAdviceHandler {

    private static final Logger log = LoggerFactory.getLogger(ControllerAdviceHandler.class);

    /**
     * 是否在响应结果中展示验证错误提示信息
     */
    @Value("${spring.validation.msg.enable:true}")
    private Boolean enableValidationMsg;

    /**
     * 符号常量
     */
    private final String DOT = ".";
    private final String SEPARATOR_COMMA = ", ";
    private final String SEPARATOR_COLON = ": ";

    /**
     * 验证异常处理 - 在@RequestBody上添加@Validated处触发
     *
     * @param request
     * @param ex
     * @return
     */
    @ExceptionHandler({MethodArgumentNotValidException.class})
    @ResponseStatus(HttpStatus.OK)
    @ResponseBody
    public CommonResult handleMethodArgumentNotValidException(HttpServletRequest request, MethodArgumentNotValidException ex) {
        log.warn("{} - MethodArgumentNotValidException!", request.getServletPath());
        CommonResult commonResult = CommonResult.respWith(RespCodeEnum.PARAM_INVALID.getCode(), this.convertFiledErrors(ex.getBindingResult().getFieldErrors()));
        log.warn("{} - resp with param invalid: {}", request.getServletPath(), commonResult);
        return commonResult;
    }

    /**
     * 验证异常处理 - form参数（对象参数，没有加@RequestBody）触发
     *
     * @param request
     * @param ex
     * @return
     */
    @ExceptionHandler({BindException.class})
    @ResponseStatus(HttpStatus.OK)
    @ResponseBody
    public CommonResult handleBindException(HttpServletRequest request, BindException ex) {
        log.warn("{} - BindException!", request.getServletPath());
        CommonResult commonResult = CommonResult.respWith(RespCodeEnum.PARAM_INVALID.getCode(), this.convertFiledErrors(ex.getFieldErrors()));
        log.warn("{} - resp with param invalid: {}", request.getServletPath(), commonResult);
        return commonResult;
    }


    /**
     * 验证异常处理 - @Validated加在controller类上，
     * 且在参数列表中直接指定constraints时触发
     *
     * @param request
     * @param ex
     * @return
     */
    @ExceptionHandler({ConstraintViolationException.class})
    @ResponseStatus(HttpStatus.OK)
    @ResponseBody
    public CommonResult handleConstraintViolationException(HttpServletRequest request, ConstraintViolationException ex) {
        log.warn("{} - ConstraintViolationException - {}", request.getServletPath(), ex.getMessage());
        CommonResult commonResult = CommonResult.respWith(RespCodeEnum.PARAM_INVALID.getCode(), this.convertConstraintViolations(ex));
        log.warn("{} - resp with param invalid: {}", request.getServletPath(), commonResult);
        return commonResult;
    }

    /**
     * 全局默认异常处理
     *
     * @param request
     * @param ex
     * @return
     */
    @ExceptionHandler({Throwable.class})
    @ResponseStatus(HttpStatus.OK)
    @ResponseBody
    public CommonResult handleException(HttpServletRequest request, Throwable ex) {
        log.warn("{} - Exception!", request.getServletPath(), ex);
        CommonResult commonResult = CommonResult.failed();
        log.warn("{} - resp failed: {}", request.getServletPath(), commonResult);
        return commonResult;
    }

    /**
     * 转换FieldError列表为错误提示信息
     *
     * @param fieldErrors
     * @return
     */
    private String convertFiledErrors(List<FieldError> fieldErrors) {
        return Optional.ofNullable(fieldErrors)
                .filter(fieldErrorsInner -> this.enableValidationMsg)
                .map(fieldErrorsInner -> fieldErrorsInner.stream()
                        .flatMap(fieldError -> Stream.of(fieldError.getField(), SEPARATOR_COLON, fieldError.getDefaultMessage(), SEPARATOR_COMMA))
                        .collect(Collectors.joining()))
                .map(msg -> msg.substring(0, msg.length() - SEPARATOR_COMMA.length()))
                .orElse(null);
    }

    /**
     * 转换ConstraintViolationException异常为错误提示信息
     *
     * @param constraintViolationException
     * @return
     */
    private String convertConstraintViolations(ConstraintViolationException constraintViolationException) {
        return Optional.ofNullable(constraintViolationException.getConstraintViolations())
                .filter(constraintViolations -> this.enableValidationMsg)
                .map(constraintViolations -> constraintViolations.stream()
                        .flatMap(constraintViolation -> {
                            String path = constraintViolation.getPropertyPath().toString();
                            path = path.substring(path.lastIndexOf(DOT) + 1);
                            String errMsg = constraintViolation.getMessage();
                            return Stream.of(path, SEPARATOR_COLON, errMsg, SEPARATOR_COMMA);
                        }).collect(Collectors.joining())
                ).map(msg -> msg.substring(0, msg.length() - SEPARATOR_COMMA.length()))
                .orElse(null);

    }
}

参数验证未通过返回结果示例：
在这里插入图片描述

注： 其中CommonResult为统一返回结果，可根据自己业务进行调整
在这里插入图片描述

注：
我们实际项目中使用需要区分参数非空、参数格式无效两种类别，对应两种不同响应码，
故可以对验证错误信息进行过滤，如存在非空验证的提示信息，则返回参数为空的响应码，否则返回参数格式无效，
对于获取当前语言环境的验证错误提示信息，可参见如下代码：

import java.io.IOException;
import java.io.InputStream;
import java.util.*;
import java.util.stream.Collectors;

/**
 * Validation提示信息获取工具
 *
 * @author luohq
 * @date 2021-09-14
 */
public class ValidationMessageProps {
    private static Properties curLocalProps;
    private static final String VALIDATION_MESSAGES_PROP_FORMAT = "org/hibernate/validator/ValidationMessages_%s.properties";
    private static final List<String> MESSAGE_EMPTY_KEYS = Arrays.asList(
            "javax.validation.constraints.NotNull.message",
            "javax.validation.constraints.NotEmpty.message",
            "javax.validation.constraints.NotBlank.message"
    );
    private static List<String> MESSAGE_EMPTY;

    static {
        loadLocalProp();
    }

    private ValidationMessageProps() {
    }

    public static String getPropVal(String key) {
        return curLocalProps.getProperty(key);
    }

    public static List<String> getEmptyMsgList() {
        if (null == MESSAGE_EMPTY) {
            MESSAGE_EMPTY = MESSAGE_EMPTY_KEYS.stream()
                    .map(ValidationMessageProps::getPropVal)
                    .collect(Collectors.toList());

        }
        return MESSAGE_EMPTY;
    }

    public static Boolean isEmptyMsg(String msg) {
            return getEmptyMsgList().stream()
                    .anyMatch(emptyMsg -> emptyMsg.equals(msg));
    }

    private static void loadLocalProp() {
        try {
            Locale defaultLocale = Locale.getDefault();
            String propFileName = String.format(VALIDATION_MESSAGES_PROP_FORMAT, defaultLocale.toString());
            curLocalProps = new Properties();
            // 使用ClassLoader加载properties配置文件生成对应的输入流
            InputStream in = ValidationMessageProps.class.getClassLoader().getResourceAsStream(propFileName);
            // 使用properties对象加载输入流
            curLocalProps.load(in);
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }
}

自定义constraints

自定义field constraint注解主要分为以下几步：
（1）定义constraint annotation注解及其属性
（2）通过注解的元注解@Constraint(validatedBy = {})关联的具体的验证器实现
（3）实现验证器逻辑

@DateFormat

具体字符串日期格式constraint @DateFormat定义示例如下：


import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;
import static java.lang.annotation.ElementType.ANNOTATION_TYPE;

/**
 * The annotated {@code CharSequence} must match date format.
 * The default date format is "yyyy-MM-dd".
 * Can override with property "format".
 * see {@link java.time.format.DateTimeFormatter}.
 * <p>
 * Accepts {@code CharSequence}. {@code null} elements are considered valid.
 *
 * @author luo
 * @date 2021-09-05
 */
@Documented
@Constraint(validatedBy = DateFormatValidator.class)
@Target({ElementType.METHOD, ElementType.FIELD, ANNOTATION_TYPE,})
@Retention(RetentionPolicy.RUNTIME)
public @interface DateFormat {
    String message() default "日期格式不正确";

    String format() default "yyyy-MM-dd";

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

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



import org.springframework.util.StringUtils;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.time.format.DateTimeFormatter;

/**
 * Date Format validator
 *
 * @author luohq
 * @date 2021-09-05
 */
public class DateFormatValidator implements ConstraintValidator<DateFormat, String> {

    private String format;

    @Override
    public void initialize(DateFormat dateFormat) {
        this.format = dateFormat.format();
    }

    @Override
    public boolean isValid(String dateStr, ConstraintValidatorContext cxt) {
        if (!StringUtils.hasText(dateStr)) {
            return true;
        }
        try {
            DateTimeFormatter.ofPattern(this.format).parse(dateStr);
            return true;
        } catch (Throwable ex) {
            return false;
        }
    }
}

@PhoneNo

在查看hbernate-validator中URL、Email约束实现时，发现可以通过元注解的形式去复用constraint实现（如@Pattern），故参考如上方式实现@PhoneNo约束

import javax.validation.Constraint;
import javax.validation.OverridesAttribute;
import javax.validation.Payload;
import javax.validation.ReportAsSingleViolation;
import javax.validation.constraints.Pattern;
import java.lang.annotation.Documented;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;


/**
 * The annotated {@code CharSequence} must match phone no format.
 * The regular expression follows the Java regular expression conventions
 * see {@link java.util.regex.Pattern}.
 * <p>
 * Accepts {@code CharSequence}. {@code null} elements are considered valid.
 *
 * @author luo
 * @date 2021-09-05
 */
@Documented
@Constraint(validatedBy = {})
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Repeatable(PhoneNo.List.class)
@ReportAsSingleViolation
@Pattern(regexp = "")
public @interface PhoneNo {
    String message() default "电话号码格式不正确";

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

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

    /**
     * @return an additional regular expression the annotated PhoneNo must match. The default is "^\\d{8,11}$"
     */
    @OverridesAttribute(constraint = Pattern.class, name = "regexp") String regexp() default "^\\d{8,11}$";

    /**
     * @return used in combination with {@link #regexp()} in order to specify a regular expression option
     */
    @OverridesAttribute(constraint = Pattern.class, name = "flags") Pattern.Flag[] flags() default {};

    /**
     * Defines several {@code @URL} annotations on the same element.
     */
    @Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
    @Retention(RUNTIME)
    @Documented
    @interface List {
        PhoneNo[] value();
    }
}

注： 同理可以实现@IdNo约束

使用自定义constraint注解

可将之前的对象集成示例中代码调整为使用自定义验证注解如下：

/**
 * 用户 - DTO
 *
 * @author luohq
 * @date 2021-09-04 13:45
 */
public class UserDto {
    ...
    @NotBlank
    //@Pattern(regexp = "^\\d{8,11}$")
    @PhoneNo
    private String phone;
    
    @NotBlank
    @IdNo
    private String idNo;

    @NotNull
    //@Pattern(regexp = "^\\d{4}-\\d{2}-\\d{2}$")
    @DateFormat
    //@DateTimeFormat
    private String birthDateStr;

    ...
}

同时自定义constraints还支持跨多参数、验证对象里的多个field、验证返回对象等用法，待后续再详细探索。

问题

通过在对象属性、方法参数上标注注解的形式，需要侵入代码，之前有的架构师不喜欢这种风格。
在一方开发时，我们有全部源码且在公司内部，这种方式还是可以的，且集成比较方便，
但是依赖三方Api jar包（参数对象定义在jar包中），我们无法直接去修改参数对象，依旧使用这种侵入代码的注解方式就不适用了，
针对三方包、或者替代注解这种形式，之前公司内部有实现过基于xml配置的形式进行验证，
这种方式不侵入参数对象，且集成也还算方便，
但是用起来还是没有直接在代码里写注解来的顺手（代码有补全、有提示、程序员友好），
所以一方开发时，首选推荐SpringBoot Validation这套体系，无法直接编辑参数对象时再考虑其他方式。

参考：
【自定义validator - field、class level】https://www.baeldung.com/spring-mvc-custom-validator
【Spring boot集成validation、全局异常处理】https://www.baeldung.com/spring-boot-bean-validation
【JSR380、非Spring框架集成validation】https://www.baeldung.com/javax-validation
【方法约束 - Single param、Cross param、Return value自定义constraints、编程调用验证】https://www.baeldung.com/javax-validation-method-constraints
Spring Validation最佳实践及其实现原理，参数校验没那么简单！
https://reflectoring.io/bean-validation-with-spring-boot/

罗小爬EX
关注
  • 2
    点赞
  • 踩
  • 5
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
SpringBoot使用validation-api实现参数校验的示例
09-08
主要介绍了SpringBoot使用validation-api实现参数校验的示例，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
SpringBoot校验参数
拾一二的博客
12-30 2689
SpringBoot框架内置了Bean Validation框架用于参数校验，并提供了多种校验注解和其他技巧用以简化开发者的工作。
Springboot项目javax.validation使用方法详解
08-19
主要介绍了Springboot项目javax.validation使用方法详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020最新-Spring Boot Validation 看这篇就够了.pdf
08-22
2020年最新Spring Boot Validation讲透讲全，别找其他的了。包括了平时用到的所有用法以及代码实例。
Springboot SpringMVC thymeleaf页面提交Validation实现实例.pdf
06-23
Springboot SpringMVC thymeleaf页面提交Validation实现实例.pdfSpringboot SpringMVC thymeleaf页面提交Validation实现实例.pdfSpringboot SpringMVC thymeleaf页面提交Validation实现实例.pdfSpringboot SpringMVC thymeleaf页面提交Validation实现实例.pdfSpringboot SpringMVC thymeleaf页面提交Validation实现实例.pdfSpringboot SpringMVC thymeleaf页面提交Validation实现实例.pdfSpringboot SpringMVC thymeleaf页面提交Validation实现实例.pdfSpringboot SpringMVC thymeleaf页面提交Validation实现实例.pdf
@Digits长度限制与mysql数据库中decimal长度限制不一致问题
最新发布
hades0525的博客
07-17 2400
Digits中的integer代表着整数部分长度，fraction代表着小数部分，也就是integer+fraction代表数字的总长度；注解是 Hibernate Validator 中的一个约束注解，用于验证数字的整数位数和小数位数。如果输入的数字超过了指定的整数位数或小数位数，将会触发验证错误，并返回指定的错误消息。属性用于指定数字的最大整数位数。decimal中的(n,m) 中的n代表的是总长度，m代表小数部分；字段的值必须满足最多三位整数位和两位小数位的限制。数据类型的总位数和小数位数的含义。
约束注解@Digits和@Min同时使用的坑
weixin_43398895的博客
08-31 1万+
@Digits用了之后，属性传入为空时@Min约束规则不生效 项目里面做导入，在实体类中的某个String类型的属性上加了@Min，当时可以限制传入数据的最小值，就算是空也是会被拦截到。但是后面因为要对数位进行限制，使用了@Digits导致@Min无法识别空的传入。 我这边的处理方式是再加上@NotBlank。 ...
BO类中对于金额字段的验证注解@Digits
weixin_44212383的博客
08-11 8084
@Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字 interger指定整数精度，fraction指定小数精度。 例如： @Digits(integer = 10, fraction = 2, message = "moneyAmount") private BigDecimal moneyAmount;
spring 注解
定个小目标的博客
07-11 1万+
@NotNull:注解元素不能为空，为空报异常 @Null:一定为空 @Length(min= ,max= ) :限定注解元素范围 @Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。微框架spring boot: @RestConroller:使用了这个注解接受的http服务默认包含@Res
Java 4种校验注解（值校验、范围校验、长度校验、格式校验）
热门推荐
u012102536的博客
01-26 1万+
1 值校验 1.1 @Null注解 被注解的元素必须为null @Null(message = "必须为null") private String username; 1.2 @NotNull注解 被注解的元素必须不为null @NotNull(message = "必须不为null") private String username; 1.3 @NotBlank注解 验证注解的元素值不为空（不为null、去除首位空格后长度为0） ，并且类型为String。 @NotBlank(message = "
Spring Boot + validation + AOP 请求参数校验
12-20
Spring Boot + validation + AOP 请求参数校验 一、validation 校验注解 通用 @Null 被注释的属性必须为 null @NotNull被注释的属性必须不为 null @AssertTrue 被注释的属性必须为 true @AssertFalse 被注释的属性必须为 false 字符串/数组/集合检查：(字符串本身就是个数组) @Pattern(regexp="reg") 验证字符串满足正则 @Size(max, min) 验证字符串、数组、集合长度范围 @NotEmpty 验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0） @No
springboot使用校验框架validation校验的示例
08-27
主要介绍了springboot使用校验框架validation校验的示例,小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
SpringBoot使用Validation校验参数.xmind
12-13
SpringBoot使用Validation校验参数.xmind
springboot+dubbo+validation 进行rpc参数校验的实现方法
08-25
主要介绍了springboot+dubbo+validation 进行rpc参数校验的实现方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
spring boot validation参数校验实例分析
08-25
主要介绍了spring boot validation参数校验,结合实例形式分析了spring boot validation进行数据有效性验证的相关操作技巧,需要的朋友可以参考下
SpringBoot学习笔记28——使用注解进行参数校验
月月大王的博客
10-31 777
关于springboot使用注解来完成参数校验这部分内容，只是写了一个标题，然后找了点注解就这么贴在了上边，那么现在博主来完成这一篇博客。
SpringMVC进阶-校验框架
赵广陆
12-05 1704
目录1 校验框架入门1.1 表单校验的重要性1.2 表单校验分类1.3 表单校验规则1.4 表单校验框架2 快速使用3 多规则校验4 嵌套校验5 分组校验 1 校验框架入门 1.1 表单校验的重要性 表单校验保障了数据有效性、安全性 数据可以随意输入，导致错误的结果。后端表单校验的重要性。 1.2 表单校验分类 校验位置： 客户端校验 服务端校验 校验内容与对应方式： 格式校验 客户端：使用Js技术，利用正则表达式校验 服务端：使用校验框架 逻辑校验 客户端：使用ajax发送要
springboot常用注解
qq_44345263的博客
12-15 649
springboot 常用注解
springboot validation
06-28
### 回答1： Spring Boot 支持使用 JSR-303 Bean Validation 规范来验证请求参数。可以在 Controller 的方法参数上使用 @Valid 注解来验证对应的请求参数。如果验证失败，会抛出 MethodArgumentNotValidException 异常。 ### 回答2： Spring Boot Validation 是 Spring 框架中的一个注解驱动的类库，它实现了对数据的校验功能。通过使用 Spring Boot Validation 可以很方便地进行表单数据验证，从而减少代码的复杂度和错误率。 Spring Boot Validation 主要依靠注解来进行数据的校验，常用的注解包括： @NotNull：验证值不为 null。 @NotEmpty：验证字符串不为空。 @NotBlank：验证字符串不为空白。 @Min：验证数字大小。 @Max：验证数字大小。 @Size：验证字符串或集合长度。 @Valid：表示需要递归验证。 Spring Boot Validation 支持的校验类型十分丰富，可以对 Java 基本数据类型和常见的容器类型进行校验，同时也能自定义校验器验证数据的正确性。 Spring Boot Validation 的应用场景很广泛，主要适用于前后端交互的表单数据处理，可以有效减少非法输入的发生，优化用户体验。另外，在企业级应用中使用 Spring Boot Validation 还可以提高系统的稳定性和安全性，避免因为数据错误导致的系统崩溃或者数据泄露。 总之，Spring Boot Validation 可以使开发人员更加方便地进行数据校验，减少了开发工作量，同时也可以提高系统的效率和安全性。 ### 回答3： Spring Boot是一个全新的框架，它可以简化Spring应用程序的构建和部署。一个典型的Spring Boot应用程序包括许多表单和输入字段，因此数据验证和处理是非常重要的。Spring Boot框架提供了一个称为Validation的表单验证核心组件，因此我们可以很容易地验证用户输入并检查数据的准确性。 Spring Boot中的Validation可以检查输入以确保其满足应用程序的特定要求，并提供与规则不符合的错误消息。这可以帮助我们提高应用程序的健壮性和安全性，并有效地防止恶意用户提交不正确的数据。Validation的基本原则是检查输入是否有效，然后返回相关的错误消息。Spring Boot提供了许多常见的Validation规则，如非空、整数、正数、电子邮件格式等等，并且还允许我们自定义验证规则。通过使用Spring Boot的Validation，我们可以使表单验证更加简单和方便。 在Spring Boot中使用Validation并不复杂，我们只需要在提交表单的控制器中添加@Valid注解，同时将要验证的表单数据传递给BindingResult对象。如果表单数据不符合验证规则，Validation将会自动生成错误消息和细节，并存储在BindingResult对象中。这使得我们可以轻松地通过将错误消息返回到用户界面来提供错误反馈信息。 总而言之，Spring Boot的Validation可以有效地帮助我们创建健壮、安全、正确的应用程序，并使表单验证更加简单和方便。通过使用验证和自定义规则，我们可以确保用户输入的准确性，并最大限度地降低应用程序错误的可能性。因此，对于任何需要表单处理和验证的Spring Boot应用程序，Validation都是一项非常关键的技术。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

罗小爬EX

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值