JSR303自定义注解实现对于计算公式的校验

JSR303自定义注解实现对于计算公式的校验

前言: 在使用JSR303做参数校验的时候我们会出现一些, JSR自带的注解在大多情况下是无法满足业务上参数校验的需求的

所以我们需要对其进行扩展我们需要用到javax.validation.ConstraintValidator接口以及对注解有一些了解

PS: 这里主要是拿来即用的一篇文章如果对于底层代码需要了解的话请自行进行debug

1.首先, 我们校验的是计算公式是否合法, 如果只需要校验计算公式的代码请自取

继承javax.validation.ConstraintValidator接口之后会有三个方法是要被实现的

package org.cdsk.cost.common.jsr_group;

import cn.hutool.core.util.ObjectUtil;
import cn.hutool.core.util.StrUtil;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.Stack;
import java.util.regex.Pattern;

public class ComputingFormulaVaildator implements ConstraintValidator<ComputingFormula, String> {
  @Override
  public void initialize(ComputingFormula constraintAnnotation) {
      ConstraintValidator.super.initialize(constraintAnnotation);
  }

  @Override
  public boolean isValid(String str, ConstraintValidatorContext constraintValidatorContext) {
      String validate = validate(str);
      if (ObjectUtil.isNull(validate)) {
          return true;
      }
		  constraintValidatorContext.disableDefaultConstraintViolation();
      // 自定义提示语（当然你也可以不自定义，那就使用注解里的message字段的值）
      constraintValidatorContext.buildConstraintViolationWithTemplate(validate).addConstraintViolation();
      return false;
  }

  /**
   * 使用正则来校验数学公式
   *
   * @param expression 数学公式，包含变量
   */
  private String validate(String expression) {
      expression = expression.replaceAll(" ", "");
      // 连续运算符处理
      if (expression.split("[\\+\\-\\×\\÷]{2,}").length > 1) {
          return "公式不合法，包含连续运算符";
      }
      if (StrUtil.contains(expression, "()")) {
          return "公式不合法，包含空括号";
      }
      expression = expression.replaceAll("\\)\\(", "\\)×\\(");
      expression = expression.replaceAll("\\(\\-", "\\(0-");
      expression = expression.replaceAll("\\(\\+", "\\(0+");
      // 校验变量
      String[] splits = expression.split("\\+|\\-|\\×|\\÷|\\(|\\)");
      for (String split : splits) {
          if (StrUtil.isBlank(split) || Pattern.matches("-?(0|([1-9]\\d*))(\\.\\d+)?", split)) {
          } else {
              return "公式不合法，包含非法变量或字符";
          }
      }
      // 校验括号
      Character preChar = null;
      Stack<Character> stack = new Stack<>();
      for (int i = 0; i < expression.length(); i++) {
          char currChar = expression.charAt(i);
          if (i == 0) {
              if (Pattern.matches("\\×|\\÷", String.valueOf(currChar))) {
                  return "公式不合法，以错误运算符开头";
              }
          }
          if ('(' == currChar) {
              stack.push('(');
          } else if (')' == currChar) {
              if (stack.size() > 0) {
                  stack.pop();
              } else {
                  return "公式不合法，括号不配对";
              }
          }
          if (preChar != null && preChar == '(' && Pattern.matches("[\\+\\-\\×\\÷]+", String.valueOf(currChar))) {
              return "公式不合法，左括号后是运算符";
          }
          if (preChar != null && preChar == ')' && !Pattern.matches("[\\+\\-\\×\\÷]+", String.valueOf(currChar))) {
              return "公式不合法，右括号后面不是运算符";
          }
          if (i == expression.length() - 1) {
              if (Pattern.matches("\\+|\\-|\\×|\\÷", String.valueOf(currChar))) {
                  return "公式不合法，以运算符结尾";
              }
          }
          preChar = currChar;
      }
      if (stack.size() > 0) {
          return "公式不合法，括号不配对";
      }
      return null;
  }
}

2. 接下来是注解的代码

package org.cdsk.cost.common.jsr_group;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

/**
* @author 405
*/
//可以被标注到那个地方
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
//这里指向的是我们自定义的校验规则，可以配置多个不同校验器，适配不同的情况
@Constraint(validatedBy = {ComputingFormulaVaildator.class})
public @interface ComputingFormula {
  String message() default "{javax.validation.constraints.NotBlank.message}";
  Class<?>[] groups() default {};
  Class<? extends Payload>[] payload() default {};
}