Skip to content

Commit 4449173

Browse files
committed
update docs
1 parent 2ccf8ff commit 4449173

File tree

2 files changed

+27
-6
lines changed

2 files changed

+27
-6
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,15 +48,26 @@ Summer is a minimized AOP (Aspect-Oriented Programming) and IoC (Inversion of Co
4848

4949
### Validation Module
5050

51-
+ Rich Validation Rules: The validation module offers a wide range of validation rules, including length checks, regular expression matching, and
51+
+ **Rich Validation Rules**: The validation module offers a wide range of validation rules, including length checks, regular expression matching, and
5252
collection size validations. For example, you can easily validate strings for minimum and maximum lengths, and collections for size ranges.
5353

54-
+ Annotation-Based Validation: Supports annotation-based validation. You can use custom annotations to mark fields in classes and perform
54+
+ **Annotation-Based Validation**: Supports annotation-based validation. You can use custom annotations to mark fields in classes and perform
5555
validation operations on objects. For instance, use the @NotNull and @Pattern annotations to validate user-defined objects.
5656

57-
+ +Collection Validation: Provides specific validation capabilities for collections. You can set validation rules for the entire collection as well
57+
+ **Collection Validation**: Provides specific validation capabilities for collections. You can set validation rules for the entire collection as
58+
well
5859
as for each element in the collection.
5960

61+
62+
### Batch Task Processing Module
63+
64+
+ **Main and Sub-Task Management**: Includes entities such as MainTask and SubTask, and corresponding data access objects (MainTaskDao). It can
65+
manage
66+
the status, progress, and related information of main and sub-tasks.
67+
68+
+ **Task Monitoring and Recovery**: The TaskWatchdog class periodically checks for stuck tasks and attempts to recover them, ensuring the reliability
69+
of task processing.
70+
6071
## Getting Started
6172

6273
### Prerequisites

README_cn.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,19 @@
4444
Summer 是一个最小化的 AOP(面向切面编程)和 IoC(控制反转)内核工具库。它提供了一系列的验证器和相关工具类,用于简化对象和集合的验证逻辑,同时也包含了一些批量任务处理的功能。
4545

4646
### 验证模块 | Validation Module
47-
+ 丰富的验证规则:验证模块提供了广泛的验证规则,包括长度检查、正则表达式匹配和集合大小验证。例如,您可以轻松验证字符串的最小和最大长度,以及集合的大小范围。
48-
+ 基于注解的验证:支持基于注解的验证。您可以使用自定义注解标记类中的字段,并对对象执行验证操作。例如,使用 @NotNull@Pattern 注解来验证用户定义的对象。
49-
+ 集合验证:为集合提供特定的验证功能。您可以为整个集合以及集合中的每个元素设置验证规则。
47+
48+
+ **丰富的验证规则**:验证模块提供了广泛的验证规则,包括长度检查、正则表达式匹配和集合大小验证。例如,您可以轻松验证字符串的最小和最大长度,以及集合的大小范围。
49+
50+
+ **基于注解的验证**:支持基于注解的验证。您可以使用自定义注解标记类中的字段,并对对象执行验证操作。例如,使用 @NotNull@Pattern 注解来验证用户定义的对象。
51+
52+
+ **集合验证**:为集合提供特定的验证功能。您可以为整个集合以及集合中的每个元素设置验证规则。
53+
54+
55+
### 批量任务处理模块 | Batch Task Processing Module
56+
57+
+ **主任务和子任务管理**:包括 MainTask 和 SubTask 等实体,以及相应的数据访问对象 (MainTaskDao)。它可以管理主任务和子任务的状态、进度和相关信息。
58+
59+
+ **任务监控和恢复**:TaskWatchdog 类会定期检查卡住的任务并尝试恢复它们,确保任务处理的可靠性。
5060

5161
## 入门指南
5262

0 commit comments

Comments
 (0)