跳到主要内容
版本：Next

Dapper集成

引言​

本文档详细描述了在CMS插件架构中Dapper与EF Core集成的技术实现。重点阐述了ICMSPluginDapperRepository接口如何与EF Core共享数据库连接，以及在实际业务场景中如何结合使用两种数据访问技术以达到最佳性能和灵活性。

核心接口定义​

ICMSPluginDapperRepository接口定义了两个核心方法：GetDbConnectionAsync和GetDbTransactionAsync，用于获取与EF Core共享的数据库连接和事务。该接口继承自ITransientDependency，确保每次请求都能获得新的实例。

EF Core连接共享机制​

CMSPluginDapperRepository通过继承DapperRepository<ICMSPluginDbContext>实现了与EF Core的连接共享。构造函数接收IDbContextProvider<ICMSPluginDbContext>作为参数，这是ABP框架提供的上下文提供者，确保Dapper和EF Core操作使用相同的数据库连接。

这种设计模式保证了在同一业务逻辑中，Dapper的原生SQL查询和EF Core的LINQ查询能够共享同一个数据库连接，避免了分布式事务的开销。当EF Core已经开启了一个连接时，Dapper会复用这个连接，从而确保操作的原子性。

事务一致性保障​

通过共享数据库连接，系统能够确保Dapper和EF Core操作在同一个事务中执行。当应用服务方法被[UnitOfWork]特性修饰时，ABP框架会自动管理事务生命周期。

GetDbTransactionAsync方法允许Dapper操作参与由EF Core启动的事务。这种机制对于需要混合使用两种技术的复杂业务场景至关重要，例如在更新实体的同时执行批量操作或复杂查询。

事务的一致性通过以下机制保障：

  1. 使用相同的DbContext实例
  2. 由ABP框架统一管理事务边界
  3. 在单元测试中通过ICMSPluginDbSchemaMigrator确保测试数据的一致性

混合使用场景分析​

IMyEntityNameRepository与EfCoreMyEntityNameRepository​

IMyEntityNameRepository接口定义了针对MyEntityName实体的CRUD操作，而EfCoreMyEntityNameRepository提供了EF Core的具体实现。这种分离使得我们可以根据场景选择最合适的数据访问方式。

图示来源

典型应用场景​

  1. 复杂查询性能优化：对于涉及多表关联、聚合函数或复杂过滤条件的查询，使用Dapper执行原生SQL可以获得更好的性能。

  2. 批量操作：在导入大量数据时，使用Dapper的批量插入功能可以显著提高效率。

  3. 动态查询：当查询条件需要动态构建时，Dapper提供了更灵活的SQL拼接能力。

  4. 报表生成：复杂的报表查询通常需要特定的SQL优化，Dapper更适合此类场景。

异常处理策略​

系统采用分层的异常处理策略，确保数据访问层的异常能够被正确捕获和处理。

  1. 底层异常转换：Dapper和EF Core抛出的底层数据库异常会被转换为领域异常。

  2. 事务回滚：当发生异常时，ABP框架会自动回滚当前事务，确保数据一致性。

  3. 用户友好异常：应用服务层会将技术性异常转换为用户可理解的错误信息。

  4. 日志记录：所有数据访问异常都会被记录到日志中，便于问题排查。

在MyEntityNameAppService中，可以看到对名称重复等业务规则的验证，这些验证通过NameExistAsync方法实现，并在违反规则时抛出UserFriendlyException。

性能优化建议​

异步查询最佳实践​

  1. 始终使用异步方法：所有数据访问操作都应使用异步版本，避免阻塞线程。

  2. 合理使用ConfigureAwait(false)：在库代码中使用ConfigureAwait(false)避免上下文切换开销。

  3. 批量操作：对于大量数据的插入、更新或删除，应使用批量操作而非逐条处理。

  4. 连接复用：通过共享连接减少连接建立和销毁的开销。

查询优化​

  1. 选择性加载：使用IncludeDetails等扩展方法按需加载关联数据。

  2. 分页查询：对于列表查询，始终使用分页避免一次性加载过多数据。

  3. 索引优化：确保常用查询字段有适当的数据库索引。

  4. 缓存策略：对于不经常变化的数据，考虑使用ABP的缓存机制。

安全防护措施​

SQL注入防护​

  1. 参数化查询：Dapper自动使用参数化查询，有效防止SQL注入。

  2. 输入验证：在应用服务层对所有输入进行验证，如Check.NotNullOrWhiteSpace。

  3. 白名单过滤：对于动态表名或列名，使用预定义的白名单进行验证。

  4. 最小权限原则：数据库账户应仅具有完成工作所需的最小权限。

在MyEntityNameAppService中，可以看到对输入参数的严格验证，包括长度检查和空值检查，这些都是防止恶意输入的重要措施。

连接池调优​

连接池配置​

  1. 合理设置最大连接数：根据应用负载和数据库能力设置合适的最大连接数。

  2. 连接超时设置：配置合理的连接超时时间，避免长时间等待。

  3. 空闲连接清理：定期清理长时间未使用的连接。

  4. 监控连接使用情况：通过性能计数器监控连接池的使用情况。

在appsettings.json中配置的连接字符串包含了基本的连接信息，实际部署时应根据生产环境需求进行优化。

结论​

通过ICMSPluginDapperRepository接口与EF Core的集成，系统实现了灵活高效的数据访问能力。这种混合使用模式既保留了EF Core的开发效率和类型安全，又获得了Dapper的性能优势和灵活性。

关键优势包括：

  • 连接和事务的无缝共享
  • 复杂查询的性能优化
  • 批量操作的高效执行
  • 统一的异常处理机制
  • 完善的安全防护

在实际应用中，应根据具体场景选择合适的数据访问技术，充分发挥两种技术的优势，构建高性能、高可靠的应用系统。