Browse Source

feat(docs): 添加规则引擎管理模块文档

pull/1049/head
feijie 1 year ago
parent
commit
03c81a3ebd
  1. 68
      aspnet-core/modules/rules-management/rules-engine/LINGYUN.Abp.RulesEngineManagement.Application.Contracts/README.EN.md
  2. 68
      aspnet-core/modules/rules-management/rules-engine/LINGYUN.Abp.RulesEngineManagement.Application.Contracts/README.md
  3. 46
      aspnet-core/modules/rules-management/rules-engine/LINGYUN.Abp.RulesEngineManagement.Application/README.EN.md
  4. 46
      aspnet-core/modules/rules-management/rules-engine/LINGYUN.Abp.RulesEngineManagement.Application/README.md
  5. 42
      aspnet-core/modules/rules-management/rules-engine/LINGYUN.Abp.RulesEngineManagement.Domain.Shared/README.EN.md
  6. 42
      aspnet-core/modules/rules-management/rules-engine/LINGYUN.Abp.RulesEngineManagement.Domain.Shared/README.md
  7. 54
      aspnet-core/modules/rules-management/rules-engine/LINGYUN.Abp.RulesEngineManagement.Domain/README.EN.md
  8. 54
      aspnet-core/modules/rules-management/rules-engine/LINGYUN.Abp.RulesEngineManagement.Domain/README.md
  9. 59
      aspnet-core/modules/rules-management/rules-engine/LINGYUN.Abp.RulesEngineManagement.EntityFrameworkCore/README.EN.md
  10. 59
      aspnet-core/modules/rules-management/rules-engine/LINGYUN.Abp.RulesEngineManagement.EntityFrameworkCore/README.md
  11. 36
      aspnet-core/modules/rules-management/rules-engine/LINGYUN.Abp.RulesEngineManagement.HttpApi/README.EN.md
  12. 36
      aspnet-core/modules/rules-management/rules-engine/LINGYUN.Abp.RulesEngineManagement.HttpApi/README.md

68
aspnet-core/modules/rules-management/rules-engine/LINGYUN.Abp.RulesEngineManagement.Application.Contracts/README.EN.md

@ -0,0 +1,68 @@
# LINGYUN.Abp.RulesEngineManagement.Application.Contracts
## 1. Introduction
The application service contract layer of the rules engine management module, defining interfaces, DTOs, and other contracts required for rules engine management.
## 2. Features
* Defines application service interfaces for rules engine management
* Defines Data Transfer Objects (DTOs)
* Defines permissions
## 3. Application Service Interfaces
* IRuleRecordAppService
* Provides CRUD operation interfaces for rule records
* Supports querying rules by name
* Supports paginated queries
* IWorkflowRecordAppService
* Provides CRUD operation interfaces for workflow records
* Supports querying workflows by name and type
* Supports paginated queries
## 4. Data Transfer Objects
### 4.1 Rule Record DTOs
* RuleRecordDto
* CreateRuleRecordDto
* UpdateRuleRecordDto
* RuleRecordGetListInput
### 4.2 Workflow Record DTOs
* WorkflowRecordDto
* CreateWorkflowRecordDto
* UpdateWorkflowRecordDto
* WorkflowRecordGetListInput
### 4.3 Parameter Record DTOs
* ParamRecordDto
* CreateParamRecordDto
* UpdateParamRecordDto
### 4.4 Action Record DTOs
* ActionRecordDto
* CreateActionRecordDto
* UpdateActionRecordDto
## 5. Permission Definitions
* RulesEngineManagement.Rule
* Rule management permissions
* Includes create, modify, delete, query permissions
* RulesEngineManagement.Workflow
* Workflow management permissions
* Includes create, modify, delete, query permissions
## 6. Dependencies
* Volo.Abp.Ddd.Application.Contracts
* LINGYUN.Abp.RulesEngineManagement.Domain.Shared
[查看中文文档](README.md)

68
aspnet-core/modules/rules-management/rules-engine/LINGYUN.Abp.RulesEngineManagement.Application.Contracts/README.md

@ -0,0 +1,68 @@
# LINGYUN.Abp.RulesEngineManagement.Application.Contracts
## 1. 介绍
规则引擎管理模块的应用服务契约层,定义了规则引擎管理所需的接口、DTO等。
## 2. 功能
* 定义了规则引擎管理的应用服务接口
* 定义了数据传输对象(DTOs)
* 定义了权限
## 3. 应用服务接口
* IRuleRecordAppService
* 提供规则记录的CRUD操作接口
* 支持按名称查询规则
* 支持分页查询
* IWorkflowRecordAppService
* 提供工作流记录的CRUD操作接口
* 支持按名称和类型查询工作流
* 支持分页查询
## 4. 数据传输对象
### 4.1 规则记录DTOs
* RuleRecordDto
* CreateRuleRecordDto
* UpdateRuleRecordDto
* RuleRecordGetListInput
### 4.2 工作流记录DTOs
* WorkflowRecordDto
* CreateWorkflowRecordDto
* UpdateWorkflowRecordDto
* WorkflowRecordGetListInput
### 4.3 参数记录DTOs
* ParamRecordDto
* CreateParamRecordDto
* UpdateParamRecordDto
### 4.4 动作记录DTOs
* ActionRecordDto
* CreateActionRecordDto
* UpdateActionRecordDto
## 5. 权限定义
* RulesEngineManagement.Rule
* 规则管理权限
* 包含创建、修改、删除、查询权限
* RulesEngineManagement.Workflow
* 工作流管理权限
* 包含创建、修改、删除、查询权限
## 6. 依赖
* Volo.Abp.Ddd.Application.Contracts
* LINGYUN.Abp.RulesEngineManagement.Domain.Shared
[点击查看英文文档](README.EN.md)

46
aspnet-core/modules/rules-management/rules-engine/LINGYUN.Abp.RulesEngineManagement.Application/README.EN.md

@ -0,0 +1,46 @@
# LINGYUN.Abp.RulesEngineManagement.Application
## 1. Introduction
The application service implementation layer of the rules engine management module, implementing the business logic for rules engine management.
## 2. Features
* Implements rule record application services
* Implements workflow record application services
* Provides auto-mapping configuration for rules engine management
## 3. Application Service Implementation
### 3.1 Rule Record Application Service
* RuleRecordAppService
* Implements IRuleRecordAppService interface
* Provides CRUD operations for rule records
* Implements rule record query functionality
* Supports paginated queries
* Implements permission validation
### 3.2 Workflow Record Application Service
* WorkflowRecordAppService
* Implements IWorkflowRecordAppService interface
* Provides CRUD operations for workflow records
* Implements workflow record query functionality
* Supports paginated queries
* Implements permission validation
## 4. Object Mapping
* RulesEngineManagementApplicationAutoMapperProfile
* Configures automatic mapping between DTOs and entities
* Includes all mapping configurations related to rules engine management
## 5. Dependencies
* Volo.Abp.AutoMapper
* Volo.Abp.Ddd.Application
* LINGYUN.Abp.RulesEngineManagement.Application.Contracts
* LINGYUN.Abp.RulesEngineManagement.Domain
[查看中文文档](README.md)

46
aspnet-core/modules/rules-management/rules-engine/LINGYUN.Abp.RulesEngineManagement.Application/README.md

@ -0,0 +1,46 @@
# LINGYUN.Abp.RulesEngineManagement.Application
## 1. 介绍
规则引擎管理模块的应用服务实现层,实现了规则引擎管理的业务逻辑。
## 2. 功能
* 实现了规则记录的应用服务
* 实现了工作流记录的应用服务
* 提供了规则引擎管理的自动映射配置
## 3. 应用服务实现
### 3.1 规则记录应用服务
* RuleRecordAppService
* 实现了IRuleRecordAppService接口
* 提供规则记录的CRUD操作
* 实现了规则记录的查询功能
* 支持分页查询
* 实现了权限验证
### 3.2 工作流记录应用服务
* WorkflowRecordAppService
* 实现了IWorkflowRecordAppService接口
* 提供工作流记录的CRUD操作
* 实现了工作流记录的查询功能
* 支持分页查询
* 实现了权限验证
## 4. 对象映射
* RulesEngineManagementApplicationAutoMapperProfile
* 配置了DTO与实体间的自动映射
* 包含了所有规则引擎管理相关的映射配置
## 5. 依赖
* Volo.Abp.AutoMapper
* Volo.Abp.Ddd.Application
* LINGYUN.Abp.RulesEngineManagement.Application.Contracts
* LINGYUN.Abp.RulesEngineManagement.Domain
[点击查看英文文档](README.EN.md)

42
aspnet-core/modules/rules-management/rules-engine/LINGYUN.Abp.RulesEngineManagement.Domain.Shared/README.EN.md

@ -0,0 +1,42 @@
# LINGYUN.Abp.RulesEngineManagement.Domain.Shared
## 1. Introduction
The shared domain layer of the rules engine management module, containing constant definitions, enumeration types, and other infrastructure required for rules engine management.
## 2. Features
* Defines workflow record related constants
* Defines rule record related constants
* Defines action record related constants
* Defines parameter record related constants
* Defines action type enumeration
## 3. Constants Configuration
### 3.1 Workflow Record Constants
* MaxNameLength: Maximum length of workflow name, default 64
* MaxTypeFullNameLength: Maximum length of type full name, default 255
* MaxInjectWorkflowsLength: Maximum length of inject workflows, default (MaxNameLength + 1) * 5
### 3.2 Rule Record Constants
* MaxNameLength: Maximum length of rule name, default 64
* MaxOperatorLength: Maximum length of operator, default 30
* MaxErrorMessageLength: Maximum length of error message, default 255
* MaxInjectWorkflowsLength: Maximum length of inject workflows, default (MaxNameLength + 1) * 5
* MaxExpressionLength: Maximum length of expression, default int.MaxValue
* MaxSuccessEventLength: Maximum length of success event, default 128
### 3.3 Action Type Enumeration
* Success = 0: Success
* Failure = 1: Failure
## 4. Dependencies
* Volo.Abp.Validation
* LINGYUN.Abp.Rules.RulesEngine
[查看中文文档](README.md)

42
aspnet-core/modules/rules-management/rules-engine/LINGYUN.Abp.RulesEngineManagement.Domain.Shared/README.md

@ -0,0 +1,42 @@
# LINGYUN.Abp.RulesEngineManagement.Domain.Shared
## 1. 介绍
规则引擎管理模块的共享领域层,包含了规则引擎管理所需的常量定义、枚举类型等基础设施。
## 2. 功能
* 定义了工作流记录相关的常量
* 定义了规则记录相关的常量
* 定义了动作记录相关的常量
* 定义了参数记录相关的常量
* 定义了动作类型枚举
## 3. 常量配置
### 3.1 工作流记录常量
* MaxNameLength: 工作流名称最大长度,默认64
* MaxTypeFullNameLength: 类型全名最大长度,默认255
* MaxInjectWorkflowsLength: 注入工作流最大长度,默认为(MaxNameLength + 1) * 5
### 3.2 规则记录常量
* MaxNameLength: 规则名称最大长度,默认64
* MaxOperatorLength: 操作符最大长度,默认30
* MaxErrorMessageLength: 错误消息最大长度,默认255
* MaxInjectWorkflowsLength: 注入工作流最大长度,默认为(MaxNameLength + 1) * 5
* MaxExpressionLength: 表达式最大长度,默认为int.MaxValue
* MaxSuccessEventLength: 成功事件最大长度,默认128
### 3.3 动作类型枚举
* Success = 0: 成功
* Failure = 1: 失败
## 4. 依赖
* Volo.Abp.Validation
* LINGYUN.Abp.Rules.RulesEngine
[点击查看英文文档](README.EN.md)

54
aspnet-core/modules/rules-management/rules-engine/LINGYUN.Abp.RulesEngineManagement.Domain/README.EN.md

@ -0,0 +1,54 @@
# LINGYUN.Abp.RulesEngineManagement.Domain
## 1. Introduction
The domain layer of the rules engine management module implements the core business logic of the rules engine, including workflow storage, rule records, action records, and other functionalities.
## 2. Features
* Workflow Storage
* Supports memory-based workflow caching
* Provides workflow retrieval and query functionality
* Supports getting workflow lists by type
* Rule Records
* Defines rule record entities
* Provides rule record repository interface
* Supports CRUD operations for rules
* Workflow Rule Records
* Defines workflow rule record entities
* Supports association between workflows and rules
* Parameter Records
* Defines parameter record entities
* Supports workflow parameter management
* Action Records
* Defines action record entities
* Supports recording success/failure actions
## 3. Domain Services
* WorkflowStore
* Implements IWorkflowStore interface
* Provides workflow cache management
* Supports workflow querying and mapping
## 4. Repository Interfaces
* IRuleRecordRepository
* Provides CRUD operations for rule records
* Supports querying rules by name
* IWorkflowRecordRepository
* Provides CRUD operations for workflow records
* Supports querying workflows by name and type
## 5. Dependencies
* Volo.Abp.Domain
* LINGYUN.Abp.Rules.RulesEngine
* Microsoft.Extensions.Caching.Memory
[查看中文文档](README.md)

54
aspnet-core/modules/rules-management/rules-engine/LINGYUN.Abp.RulesEngineManagement.Domain/README.md

@ -0,0 +1,54 @@
# LINGYUN.Abp.RulesEngineManagement.Domain
## 1. 介绍
规则引擎管理模块的领域层,实现了规则引擎的核心业务逻辑,包括工作流存储、规则记录、动作记录等功能。
## 2. 功能
* 工作流存储
* 支持基于内存缓存的工作流存储
* 提供工作流的获取和查询功能
* 支持按类型获取工作流列表
* 规则记录
* 定义规则记录实体
* 提供规则记录仓储接口
* 支持规则的CRUD操作
* 工作流规则记录
* 定义工作流规则记录实体
* 支持工作流和规则的关联
* 参数记录
* 定义参数记录实体
* 支持工作流参数的管理
* 动作记录
* 定义动作记录实体
* 支持成功/失败动作的记录
## 3. 领域服务
* WorkflowStore
* 实现了IWorkflowStore接口
* 提供工作流的缓存管理
* 支持工作流的查询和映射
## 4. 仓储接口
* IRuleRecordRepository
* 提供规则记录的CRUD操作
* 支持按名称查询规则
* IWorkflowRecordRepository
* 提供工作流记录的CRUD操作
* 支持按名称和类型查询工作流
## 5. 依赖
* Volo.Abp.Domain
* LINGYUN.Abp.Rules.RulesEngine
* Microsoft.Extensions.Caching.Memory
[点击查看英文文档](README.EN.md)

59
aspnet-core/modules/rules-management/rules-engine/LINGYUN.Abp.RulesEngineManagement.EntityFrameworkCore/README.EN.md

@ -0,0 +1,59 @@
# LINGYUN.Abp.RulesEngineManagement.EntityFrameworkCore
## 1. Introduction
The EntityFrameworkCore implementation of the rules engine management module, providing EF Core-based data access layer implementation.
## 2. Features
* Implements DbContext for the rules engine management module
* Provides entity database mapping configuration
* Implements repository interfaces
## 3. Database Implementation
### 3.1 DbContext
* RulesEngineManagementDbContext
* Implements IRulesEngineManagementDbContext interface
* Contains DbSet definitions for all entities
* Supports multi-tenancy
### 3.2 Repository Implementation
* EfCoreRuleRecordRepository
* Implements IRuleRecordRepository interface
* Provides CRUD operations for rule records
* Supports querying rules by name
* EfCoreWorkflowRecordRepository
* Implements IWorkflowRecordRepository interface
* Provides CRUD operations for workflow records
* Supports querying workflows by name and type
### 3.3 Entity Mapping
* Workflow Record Mapping
* Configures primary keys and indexes
* Configures field length restrictions
* Configures relationships
* Rule Record Mapping
* Configures primary keys and indexes
* Configures field length restrictions
* Configures relationships
* Parameter Record Mapping
* Configures primary keys
* Configures field length restrictions
* Action Record Mapping
* Configures primary keys
* Configures field length restrictions
## 4. Dependencies
* Volo.Abp.EntityFrameworkCore
* LINGYUN.Abp.RulesEngineManagement.Domain
[查看中文文档](README.md)

59
aspnet-core/modules/rules-management/rules-engine/LINGYUN.Abp.RulesEngineManagement.EntityFrameworkCore/README.md

@ -0,0 +1,59 @@
# LINGYUN.Abp.RulesEngineManagement.EntityFrameworkCore
## 1. 介绍
规则引擎管理模块的EntityFrameworkCore实现,提供了基于EF Core的数据访问层实现。
## 2. 功能
* 实现了规则引擎管理模块的DbContext
* 提供了实体的数据库映射配置
* 实现了仓储接口
## 3. 数据库实现
### 3.1 DbContext
* RulesEngineManagementDbContext
* 实现了IRulesEngineManagementDbContext接口
* 包含了所有实体的DbSet定义
* 支持多租户
### 3.2 仓储实现
* EfCoreRuleRecordRepository
* 实现了IRuleRecordRepository接口
* 提供规则记录的CRUD操作
* 支持按名称查询规则
* EfCoreWorkflowRecordRepository
* 实现了IWorkflowRecordRepository接口
* 提供工作流记录的CRUD操作
* 支持按名称和类型查询工作流
### 3.3 实体映射
* 工作流记录映射
* 配置了主键、索引
* 配置了字段长度限制
* 配置了关联关系
* 规则记录映射
* 配置了主键、索引
* 配置了字段长度限制
* 配置了关联关系
* 参数记录映射
* 配置了主键
* 配置了字段长度限制
* 动作记录映射
* 配置了主键
* 配置了字段长度限制
## 4. 依赖
* Volo.Abp.EntityFrameworkCore
* LINGYUN.Abp.RulesEngineManagement.Domain
[点击查看英文文档](README.EN.md)

36
aspnet-core/modules/rules-management/rules-engine/LINGYUN.Abp.RulesEngineManagement.HttpApi/README.EN.md

@ -0,0 +1,36 @@
# LINGYUN.Abp.RulesEngineManagement.HttpApi
## 1. Introduction
The HTTP API layer of the rules engine management module, providing RESTful API interfaces.
## 2. Features
* Implements HTTP API interfaces for rule records
* Implements HTTP API interfaces for workflow records
* Provides API interface routing configuration
## 3. API Interfaces
### 3.1 Rule Record API
* RuleRecordController
* Base path: api/rules-engine-management/rules
* Provides CRUD operation APIs for rule records
* Supports paginated query API
* Implements permission validation
### 3.2 Workflow Record API
* WorkflowRecordController
* Base path: api/rules-engine-management/workflows
* Provides CRUD operation APIs for workflow records
* Supports paginated query API
* Implements permission validation
## 4. Dependencies
* Volo.Abp.AspNetCore.Mvc
* LINGYUN.Abp.RulesEngineManagement.Application.Contracts
[查看中文文档](README.md)

36
aspnet-core/modules/rules-management/rules-engine/LINGYUN.Abp.RulesEngineManagement.HttpApi/README.md

@ -0,0 +1,36 @@
# LINGYUN.Abp.RulesEngineManagement.HttpApi
## 1. 介绍
规则引擎管理模块的HTTP API层,提供了基于RESTful的API接口。
## 2. 功能
* 实现了规则记录的HTTP API接口
* 实现了工作流记录的HTTP API接口
* 提供了API接口的路由配置
## 3. API接口
### 3.1 规则记录API
* RuleRecordController
* 基路径: api/rules-engine-management/rules
* 提供规则记录的CRUD操作API
* 支持分页查询API
* 实现了权限验证
### 3.2 工作流记录API
* WorkflowRecordController
* 基路径: api/rules-engine-management/workflows
* 提供工作流记录的CRUD操作API
* 支持分页查询API
* 实现了权限验证
## 4. 依赖
* Volo.Abp.AspNetCore.Mvc
* LINGYUN.Abp.RulesEngineManagement.Application.Contracts
[点击查看英文文档](README.EN.md)
Loading…
Cancel
Save