perf: 优化测试工具，支持对未使用@SpelValid注解的类进行验证

stick-i · stick-i · commit e939d6f67fb7 · 2024-10-30T19:01:41.000+08:00
diff --git a/spel-validator-core/src/main/java/cn/sticki/spel/validator/core/result/FieldError.java b/spel-validator-core/src/main/java/cn/sticki/spel/validator/core/result/FieldError.java
@@ -29,4 +29,7 @@ public FieldError(String fieldName, String errorMessage) {
         this.errorMessage = errorMessage;
     }
 
+    public static FieldError of(String fieldName, String errorMessage) {
+        return new FieldError(fieldName, errorMessage);
+    }
 }
diff --git a/spel-validator-core/src/main/java/cn/sticki/spel/validator/core/result/ObjectValidResult.java b/spel-validator-core/src/main/java/cn/sticki/spel/validator/core/result/ObjectValidResult.java
@@ -15,6 +15,8 @@ public class ObjectValidResult {
 
     private final List<FieldError> errors = new ArrayList<>();
 
+    public static final ObjectValidResult EMPTY = new ObjectValidResult();
+
     public boolean hasError() {
         return !errors.isEmpty();
     }
@@ -56,4 +58,10 @@ public void addFieldResult(FieldValidResult result) {
             errors.add(new FieldError(result.getFieldName(), result.getMessage()));
         }
     }
+
+    public void addFieldError(List<FieldError> fieldErrorList) {
+        if (fieldErrorList != null && !fieldErrorList.isEmpty()) {
+            errors.addAll(fieldErrorList);
+        }
+    }
 }
diff --git a/spel-validator-javax/src/test/java/cn/sticki/spel/validator/javax/util/ConstraintViolationSet.java b/spel-validator-javax/src/test/java/cn/sticki/spel/validator/javax/util/ConstraintViolationSet.java
@@ -1,6 +1,7 @@
 package cn.sticki.spel.validator.javax.util;
 
-import javax.validation.ConstraintViolation;
+import cn.sticki.spel.validator.core.result.FieldError;
+
 import java.util.*;
 import java.util.stream.Collectors;
 
@@ -14,33 +15,19 @@
  */
 public class ConstraintViolationSet {
 
-    private static final ConstraintViolationSet EMPTY = new ConstraintViolationSet(Collections.emptyList());
-
-    private final Map<String, List<VerifyFailedField>> verifyMap;
+    private final Map<String, List<FieldError>> verifyMap;
 
-    public ConstraintViolationSet(Collection<VerifyFailedField> failedFields) {
-        if (failedFields == null || failedFields.isEmpty()) {
+    public ConstraintViolationSet(Collection<FieldError> fieldErrors) {
+        if (fieldErrors == null || fieldErrors.isEmpty()) {
             verifyMap = Collections.emptyMap();
             return;
         }
 
-        this.verifyMap = failedFields.stream().collect(Collectors.groupingBy(VerifyFailedField::getName));
-    }
-
-    public static ConstraintViolationSet of(Set<ConstraintViolation<Object>> validate) {
-        if (validate == null || validate.isEmpty()) {
-            return EMPTY;
-        }
-        List<VerifyFailedField> list = validate.stream().map(ConstraintViolationSet::convert).collect(Collectors.toList());
-        return new ConstraintViolationSet(list);
-    }
-
-    public static ConstraintViolationSet of(List<VerifyFailedField> validate) {
-        return new ConstraintViolationSet(validate);
+        this.verifyMap = fieldErrors.stream().collect(Collectors.groupingBy(FieldError::getFieldName));
     }
 
-    private static VerifyFailedField convert(ConstraintViolation<Object> violation) {
-        return VerifyFailedField.of(violation.getPropertyPath().toString(), violation.getMessage());
+    public static ConstraintViolationSet of(List<FieldError> fieldErrors) {
+        return new ConstraintViolationSet(fieldErrors);
     }
 
     /**
@@ -50,20 +37,20 @@ private static VerifyFailedField convert(ConstraintViolation<Object> violation)
      * @param expectMessage 期望的错误信息
      * @return 字段约束结果，当 expectMessage 不为null时，会优先匹配具有相同message的数据
      */
-    public VerifyFailedField getAndRemove(String fieldName, String expectMessage) {
-        List<VerifyFailedField> violationList = verifyMap.get(fieldName);
+    public FieldError getAndRemove(String fieldName, String expectMessage) {
+        List<FieldError> violationList = verifyMap.get(fieldName);
         if (violationList == null || violationList.isEmpty()) {
             return null;
         }
         if (violationList.size() == 1 || expectMessage == null) {
-            VerifyFailedField violation = violationList.get(0);
+            FieldError violation = violationList.get(0);
             verifyMap.remove(fieldName);
             return violation;
         }
         // 当存在多个约束时，优先匹配具有相同message的数据。
         // 否则当一个字段有多个约束条件时，无法匹配到期望的约束。
-        for (VerifyFailedField violation : violationList) {
-            if (expectMessage.equals(violation.getMessage())) {
+        for (FieldError violation : violationList) {
+            if (expectMessage.equals(violation.getErrorMessage())) {
                 violationList.remove(violation);
                 return violation;
             }
@@ -75,7 +62,7 @@ public VerifyFailedField getAndRemove(String fieldName, String expectMessage) {
     /**
      * 获取所有的约束违反字段
      */
-    public Set<VerifyFailedField> getAll() {
+    public Set<FieldError> getAll() {
         return verifyMap.values().stream().flatMap(List::stream).collect(Collectors.toSet());
     }
 
diff --git a/spel-validator-javax/src/test/java/cn/sticki/spel/validator/javax/util/ValidateUtil.java b/spel-validator-javax/src/test/java/cn/sticki/spel/validator/javax/util/ValidateUtil.java
@@ -1,5 +1,9 @@
 package cn.sticki.spel.validator.javax.util;
 
+import cn.sticki.spel.validator.core.SpelValidExecutor;
+import cn.sticki.spel.validator.core.result.FieldError;
+import cn.sticki.spel.validator.core.result.ObjectValidResult;
+import cn.sticki.spel.validator.javax.SpelValid;
 import lombok.extern.slf4j.Slf4j;
 
 import javax.validation.ConstraintViolation;
@@ -8,6 +12,7 @@
 import java.util.Collection;
 import java.util.List;
 import java.util.Set;
+import java.util.stream.Collectors;
 
 /**
  * 测试验证工具类
@@ -25,12 +30,30 @@ public class ValidateUtil {
     /**
      * 参数校验
      * <p>
-     * 调用此方法会触发 javax.validation.constraints.* 的校验，类似于使用 @Valid 注解
+     * 调用此方法会触发约束校验
      *
-     * @return 校验结果，如果校验通过则返回空列表
+     * @return 校验结果
      */
-    public static <T> Set<ConstraintViolation<T>> validate(T obj) {
-        return validator.validate(obj);
+    public static ObjectValidResult validate(Object obj) {
+        // 如果对象没有使用 SpelValid 注解，则直接调用验证执行器进行验证
+        // 这种情况下，只会验证本框架提供的约束注解
+        if (!obj.getClass().isAnnotationPresent(SpelValid.class)) {
+            return SpelValidExecutor.validateObject(obj);
+        }
+
+        // 通过 @Valid 的方式进行验证
+        Set<ConstraintViolation<Object>> validate = validator.validate(obj);
+        if (validate == null || validate.isEmpty()) {
+            return ObjectValidResult.EMPTY;
+        }
+        ObjectValidResult validResult = new ObjectValidResult();
+        List<FieldError> list = validate.stream().map(ValidateUtil::convert).collect(Collectors.toList());
+        validResult.addFieldError(list);
+        return validResult;
+    }
+
+    private static FieldError convert(ConstraintViolation<Object> violation) {
+        return FieldError.of(violation.getPropertyPath().toString(), violation.getMessage());
     }
 
     /**
@@ -61,8 +84,8 @@ public static boolean checkConstraintResult(VerifyObject verifyObject) {
         int failCount = 0;
         try {
             // 执行约束校验
-            Set<ConstraintViolation<Object>> validate = ValidateUtil.validate(object);
-            failCount += processVerifyResult(verifyFailedFields, ConstraintViolationSet.of(validate));
+            ObjectValidResult validResult = ValidateUtil.validate(object);
+            failCount += processVerifyResult(verifyFailedFields, ConstraintViolationSet.of(validResult.getErrors()));
         } catch (Exception e) {
             if (expectException) {
                 log.info("Passed, Capture exception {}, message: {}", e.getClass(), e.getMessage());
@@ -109,13 +132,13 @@ private static int processVerifyResult(Collection<VerifyFailedField> verifyFaile
 
             boolean fieldMatch = false, find = false;
 
-            VerifyFailedField violation = violationSet.getAndRemove(fieldName, message);
-            if (violation != null) {
+            FieldError fieldError = violationSet.getAndRemove(fieldName, message);
+            if (fieldError != null) {
                 find = true;
-                log.info("Real exception information: {}", violation.getMessage());
+                log.info("Real exception information: {}", fieldError.getErrorMessage());
 
                 // 异常信息不同时验证失败（没填写异常信息则不校验异常信息）
-                if (message != null && !message.equals(violation.getMessage())) {
+                if (message != null && !message.equals(fieldError.getErrorMessage())) {
                     log.error("Failed");
                 } else {
                     fieldMatch = true;
@@ -134,8 +157,8 @@ private static int processVerifyResult(Collection<VerifyFailedField> verifyFaile
 
         LogContext.remove(fieldNameLogKey);
         // 被忽略的字段
-        for (VerifyFailedField violation : violationSet.getAll()) {
-            log.error("Field [{}] is ignored", violation.getName());
+        for (FieldError violation : violationSet.getAll()) {
+            log.error("Field [{}] is ignored", violation.getFieldName());
             failCount++;
         }
         return failCount;

Original file line number	Diff line number	Diff line change
`@@ -29,4 +29,7 @@ public FieldError(String fieldName, String errorMessage) {`
`29`	`29`	`this.errorMessage = errorMessage;`
`30`	`30`	`}`
`31`	`31`
	`32`	`+ public static FieldError of(String fieldName, String errorMessage) {`
	`33`	`+ return new FieldError(fieldName, errorMessage);`
	`34`	`+ }`
`32`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,8 @@ public class ObjectValidResult {`
`15`	`15`
`16`	`16`	`private final List<FieldError> errors = new ArrayList<>();`
`17`	`17`
	`18`	`+ public static final ObjectValidResult EMPTY = new ObjectValidResult();`
	`19`	`+`
`18`	`20`	`public boolean hasError() {`
`19`	`21`	`return !errors.isEmpty();`
`20`	`22`	`}`
`@@ -56,4 +58,10 @@ public void addFieldResult(FieldValidResult result) {`
`56`	`58`	`errors.add(new FieldError(result.getFieldName(), result.getMessage()));`
`57`	`59`	`}`
`58`	`60`	`}`
	`61`	`+`
	`62`	`+ public void addFieldError(List<FieldError> fieldErrorList) {`
	`63`	`+ if (fieldErrorList != null && !fieldErrorList.isEmpty()) {`
	`64`	`+ errors.addAll(fieldErrorList);`
	`65`	`+ }`
	`66`	`+ }`
`59`	`67`	`}`