Rabbit组件使用手册

### Rabbit组件使用手册知识点概述 本手册旨在详细介绍Rabbit框架中的关键组件，包括Data、Bus、Caching、FileSystems、Logging、Localization等。本文将重点介绍Data组件的使用方法及其实现细节，帮助开发者更好地理解和应用这些功能。 #### 数据组件（Data Component） **一、数据组件简介** 数据组件是Rabbit框架的核心组成部分之一，它提供了强大且灵活的数据访问能力。无论是在处理简单的查询操作还是复杂的事务管理方面，Data组件都能满足开发需求。 **二、基于Entity Framework的数据组件使用** 1. **安装数据组件** - 在宿主项目中通过NuGet安装`Rabbit.Components.Data.EntityFramework`包。 - NuGet会自动安装依赖包`Rabbit.Components.Data`。 2. **启用数据组件** - 在初始化KernelBuilder时添加如下代码来启用日志记录功能： ```csharp kernelBuilder.UseLogging(c => c.UseNLog()); ``` **三、数据库配置** 数据库配置信息存储在租户的`Setting.txt`文件中，主要包括以下两个配置项： 1. **DataProvider**：指定数据提供程序，默认仅支持SQL Server。 2. **DataConnectionString**：指定数据库连接字符串，例如： ``` DataProvider: SqlServer DataConnectionString: DataSource=.;InitialCatalog=RabbitDemo_Tenant1;PersistSecurityInfo=True;UserID=sa;Password=123;MultipleActiveResultSets=true ``` **四、基础使用示例** 1. **创建模块** - 新建一个名为`Web.Modules.Data`的模块。 - 通过NuGet从ChunSun源安装`Rabbit.Components.Data`组件。 2. **定义实体** - 在`Models`文件夹下创建一个`StudentRecord`类并实现`IEntity`接口。 - 定义`Name`（类型为`string`）和`Age`（类型为`short`）两个属性。 3. **创建控制器** - 创建一个`HomeController`并注入`IRepository<StudentRecord>`仓储。 4. **添加操作** - 添加`CreateAction`用于添加新学生记录。 - 添加`IndexAction`用于展示所有学生记录。 **五、数据库验证与映射** 1. **数据库验证问题** - 示例中存在数据验证不足的问题，例如年龄被设置为不合理的值200。 2. **映射方式** - **数据注释（Data Annotations）**：是一种轻量级的映射方式，易于使用且便于维护。 - **流利API（Fluent API）**：提供更高级别的定制选项，但使用起来相对复杂。 **六、使用数据注释进行映射** 数据注释通常与约定一起使用，以便更轻松地控制数据模型的映射规则。常见的数据注释包括： 1. **[Required]**：确保字段不能为空。 2. **[StringLength]（最大长度）**：限制字符串字段的最大长度。 3. **[Range]（数值范围）**：限定数值类型的取值范围。 4. **[NotMapped]**：指示某个字段不参与数据库映射。 5. **[ForeignKey]**：定义外键关系。 **七、使用流利API进行映射** 尽管数据注释已经非常强大，但在某些情况下，可能需要更精细的控制。此时可以使用流利API进行映射。首先需要： 1. **安装组件** - 通过NuGet安装`Rabbit.Components.Data.EntityFramework`。 2. **创建映射类** - 创建一个继承自`Rabbit.Components.Data.EntityFramework.MappingBase<T>`的类，其中`T`为模型类型。 3. **执行映射** - 在映射类中实现具体的映射逻辑。 **八、示例优化** 对于`StudentRecord`类，可以通过应用数据注释来进行优化，以解决之前提到的数据验证问题。 以上是Rabbit框架中Data组件的主要使用要点及注意事项，开发者可以根据实际项目需求灵活选择合适的映射方式。通过掌握这些知识，开发者能够更高效地进行数据访问操作，提升应用程序的性能与可靠性。