docs: 优化各个模块的readme说明

stick-i · Nov 1, 2024 · b3666ac · b3666ac
1 parent 9c0a395
commit b3666ac
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 6 deletions.
diff --git a/spel-validator-constrain/README.md b/spel-validator-constrain/README.md
@@ -3,3 +3,9 @@
 此模块内包含了一些常用的约束校验器，用于校验对象的属性是否符合预期。
 
 同时这些校验器的测试用例也在此模块中。
+
+刚开始这些约束器都是在 `-core` 模块里的。
+但是由于这些约束器的测试工具依赖了 `-core` 模块，然后 `-core` 模块又依赖了 `-test`，这样就形成了循环依赖，导致编译不通过。
+所以将这些约束器单独提取出来，放到一个新的模块中。
+
+至于为什么需要将 `-test` 独立出来，可以看看 `-test` 模块的 [README.md](../spel-validator-test/README.md) 文件。
diff --git a/spel-validator-core/README.md b/spel-validator-core/README.md
@@ -0,0 +1,8 @@
+# 模块说明
+
+此模块为校验器核心模块，提供了校验器的基本功能，包括校验器的注册、执行、结果汇总等。
+
+该模块可以被单独使用，只需要遵循校验器的规范 [SpelConstraint](src/main/java/cn/sticki/spel/validator/core/SpelConstraint.java)，
+并实现自己需要的约束注解即可。
+
+但一般情况下，建议直接使用 `-javax` 或 `-jakarta` 模块，因为这两个模块已经提供了一些常用的约束注解和启动注解。
diff --git a/spel-validator-core/src/main/java/cn/sticki/spel/validator/core/SpelConstraint.java b/spel-validator-core/src/main/java/cn/sticki/spel/validator/core/SpelConstraint.java
@@ -3,7 +3,7 @@
 import java.lang.annotation.*;
 
 /**
- * 将注解标记为由 {@link SpelValid} 进行校验的Bean验证约束。
+ * 将注解标记为由 {@link cn.sticki.spel.validator.javax.SpelValid} 进行校验的Bean验证约束。
  * <p>
  * 该注解的属性 {@link SpelConstraint#validatedBy()} 用于指定校验器的实现类，实现类需要实现 {@link SpelConstraintValidator} 接口。
  * <p>
@@ -15,20 +15,20 @@
  *     当 表达式为空 或 计算结果为true 时，才会对带注解的元素进行校验。
  *     </li>
  *     <li>{@code String[] group() default {};} 用于指定约束开启的分组条件，必须为合法的SpEL表达式。
- *     当分组信息不为空时，只有当 {@link SpelValid#spelGroups()} 中的分组信息与此处的分组信息有交集时，才会对带注解的元素进行校验。
+ *     当分组信息不为空时，只有当 {@link cn.sticki.spel.validator.javax.SpelValid#spelGroups()} 中的分组信息与此处的分组信息有交集时，才会对带注解的元素进行校验。
  *     其计算结果可以是任何类型，但只有两个计算结果完全相等时，才被认为是相等的。
  *     </li>
  * </ul>
  * <p>
  * 这里有一些定义约束的例子，可以参考：
  * <ul>
- *     <li>{@link cn.sticki.spel.validator.core.constrain.SpelAssert}</li>
- *     <li>{@link cn.sticki.spel.validator.core.constrain.SpelNotNull}</li>
+ *     <li>{@link cn.sticki.spel.validator.constrain.SpelAssert}</li>
+ *     <li>{@link cn.sticki.spel.validator.constrain.SpelNotNull}</li>
  * </ul>
  *
  * @author 阿杆
  * @version 1.0
- * @see SpelValid
+ * @see cn.sticki.spel.validator.javax.SpelValid
  * @see SpelConstraintValidator
  * @since 2024/4/11
  */

diff --git a/spel-validator-jakarta/README.md b/spel-validator-jakarta/README.md
@@ -0,0 +1,5 @@
+# 模块说明
+
+此模块是可以直接使用的，基于 `jakarta.validation-api` 的参数校验工具模块。
+
+内包含启动注解和一些常用的约束注解，可以直接使用。
diff --git a/spel-validator-javax/README.md b/spel-validator-javax/README.md
@@ -0,0 +1,5 @@
+# 模块说明
+
+此模块是可以直接使用的，基于 `javax.validation-api` 的参数校验工具模块。
+
+内包含启动注解和一些常用的约束注解，可以直接使用。
diff --git a/spel-validator-test/README.md b/spel-validator-test/README.md
@@ -1,4 +1,6 @@
-# 此模板内包含一些测试使用的工具
+# 模块说明
+
+此模板内包含一些测试使用的工具，其他模块引入此模块时都需要以 `<scope>test</scope>` 的方式引入。
 
 刚开始只有一个 `spel-validator`，里面包含了所有的代码。