ABP VNext默认用EFCore不爽？手把手教你集成SqlSugar和FreeSql（.NET 8实战）

ABP VNext实战：用SqlSugar和FreeSql替换EFCore的优雅方案

最近在技术社区看到不少.NET开发者讨论ABP框架默认集成EFCore带来的"水土不服"问题。作为一个长期使用ABP框架的开发者，我完全理解这种感受——EFCore虽然功能强大，但在国内开发场景下，SqlSugar和FreeSql这类国产ORM往往能提供更符合我们习惯的API设计和性能表现。今天我就来分享如何在.NET 8环境下，为ABP VNext项目平滑集成这两种备受欢迎的国产ORM。

1. 为什么需要替换ABP默认的EFCore？

ABP框架默认使用EFCore作为ORM解决方案，这本身没有问题。EFCore是微软官方维护的ORM框架，功能全面、文档完善，在国际社区有广泛支持。但在国内实际开发中，我们发现几个典型痛点：

• 学习曲线陡峭：EFCore的LINQ语法和变更追踪机制对新手不够友好
• 复杂查询性能：多表关联查询时容易生成低效SQL
• 国产数据库支持：对达梦、金仓等国产数据库适配度有限
• 开发效率瓶颈：需要频繁处理DbContext生命周期和迁移脚本

相比之下，SqlSugar和FreeSql提供了更符合国内开发者习惯的特性：

2. 项目准备与环境配置

开始集成前，我们需要准备一个基础的ABP VNext项目。如果你已有现成项目，可以直接跳到下一节。

# 使用ABP CLI创建新项目 abp new MyProject -t app -u mvc --mobile none --database-provider none

创建完成后，修改appsettings.json配置数据库连接：

{ "ConnectionStrings": { "Default": "Server=localhost;Port=3306;Database=MyProjectDb;Uid=root;Pwd=123456;" } }

添加必要的NuGet包引用：

<!-- 根据选择的ORM添加对应包 --> <PackageReference Include="SqlSugarCore" Version="5.0.4.9" /> <!-- 或 --> <PackageReference Include="FreeSql.All" Version="3.2.805" />

3. SqlSugar集成详解

3.1 创建SqlSugar模块

在ABP中，模块化是核心设计理念。我们首先创建一个专门用于配置SqlSugar的模块：

[DependsOn(typeof(AbpDddModule))] public class MyProjectSqlSugarModule : AbpModule { public override void ConfigureServices(ServiceConfigurationContext context) { var configuration = context.Services.GetConfiguration(); var connectionString = configuration.GetConnectionString("Default"); context.Services.AddSingleton<ISqlSugarClient>(serviceProvider => { var sqlSugar = new SqlSugarScope(new ConnectionConfig() { ConnectionString = connectionString, DbType = DbType.MySql, IsAutoCloseConnection = true, ConfigureExternalServices = new ConfigureExternalServices() { EntityService = (property, column) => { // 处理实体特性映射 var attributes = property.GetCustomAttributes(true); if (attributes.Any(it => it is KeyAttribute)) { column.IsPrimarykey = true; } } } }, db => { // 配置AOP db.Aop.OnLogExecuting = (sql, pars) => { Logger.LogInformation(sql); }; }); return sqlSugar; }); } }

3.2 实现自定义仓储基类

ABP的仓储模式是其核心优势之一，我们需要创建一个继承自DomainService的基类来封装SqlSugar操作：

public abstract class SqlSugarRepository : DomainService { protected ISqlSugarClient Db => LazyServiceProvider.LazyGetRequiredService<ISqlSugarClient>(); protected virtual ISugarQueryable<T> Queryable<T>() where T : class, new() { return Db.Queryable<T>(); } protected virtual async Task<T> GetAsync<T>(object id) where T : class, new() { return await Db.Queryable<T>().InSingleAsync(id); } // 其他常用方法封装... }

3.3 业务层使用示例

在应用服务中，我们可以这样使用自定义仓储：

public class ProductAppService : ApplicationService, IProductAppService { private readonly SqlSugarRepository _repository; public ProductAppService(SqlSugarRepository repository) { _repository = repository; } public async Task<ProductDto> GetAsync(Guid id) { var product = await _repository.GetAsync<Product>(id); return ObjectMapper.Map<Product, ProductDto>(product); } }

4. FreeSql集成方案

4.1 配置FreeSql模块

FreeSql的集成方式与SqlSugar类似，但配置上有些差异：

[DependsOn(typeof(AbpDddModule))] public class MyProjectFreeSqlModule : AbpModule { public override void ConfigureServices(ServiceConfigurationContext context) { var configuration = context.Services.GetConfiguration(); var connectionString = configuration.GetConnectionString("Default"); var freeSql = new FreeSqlBuilder() .UseConnectionString(DataType.MySql, connectionString) .UseAutoSyncStructure(true) // 自动同步实体结构 .UseMonitorCommand(cmd => { Logger.LogInformation(cmd.CommandText); }) .Build(); context.Services.AddSingleton<IFreeSql>(freeSql); } }

4.2 FreeSql仓储实现

FreeSql的仓储基类实现需要考虑其特有的工作单元模式：

public abstract class FreeSqlRepository : DomainService { protected IFreeSql Db => LazyServiceProvider.LazyGetRequiredService<IFreeSql>(); protected virtual ISelect<T> Select<T>() where T : class { return Db.Select<T>(); } protected virtual async Task<T> FindAsync<T>(object id) where T : class { return await Db.Select<T>().WhereDynamic(id).FirstAsync(); } // 事务处理示例 protected virtual async Task UseTransactionAsync(Func<Task> action) { using var uow = Db.CreateUnitOfWork(); try { await action(); uow.Commit(); } catch { uow.Rollback(); throw; } } }

5. 关键问题与解决方案

在实际集成过程中，有几个关键点需要特别注意：

5.1 实体特性兼容性处理

两种ORM对实体特性的支持略有不同。例如，处理主键标识：

// SqlSugar中的实体类 public class Product { [SugarColumn(IsPrimaryKey = true)] public Guid Id { get; set; } public string Name { get; set; } } // FreeSql中的实体类 public class Product { [Column(IsPrimary = true)] public Guid Id { get; set; } public string Name { get; set; } }

5.2 多数据库支持配置

如果需要支持多种数据库，可以这样配置：

// SqlSugar多库配置 var sqlSugar = new SqlSugarScope(new List<ConnectionConfig> { new ConnectionConfig(){ ConfigId="MainDb", DbType=DbType.MySql, ConnectionString=mainConn }, new ConnectionConfig(){ ConfigId="LogDb", DbType=DbType.SqlServer, ConnectionString=logConn } }); // FreeSql多库配置 var freeSql = new FreeSqlBuilder() .UseConnectionString(DataType.MySql, mainConn) .UseConnectionString(DataType.SqlServer, logConn, "LogDb") .Build();

5.3 性能优化建议

• SqlSugar：

  • 使用SqlSugarScope替代SqlSugarClient以获得更好的线程安全
  • 合理配置AOP日志，避免生产环境记录过多SQL

• FreeSql：

  • 对于只读操作使用NoTracking模式
  • 批量操作时使用Insert/Update/Delete的批量方法

// FreeSql批量插入优化 await Db.Insert(list).ExecuteAffrowsAsync(); // SqlSugar批量更新优化 await Db.Updateable(list).ExecuteCommandAsync();

6. 迁移策略与最佳实践

如果你正在将一个使用EFCore的现有ABP项目迁移到SqlSugar或FreeSql，建议采用渐进式策略：

1. 并行运行阶段：新功能使用新ORM，旧功能保持原状
2. 数据访问层重构：逐步替换仓储实现
3. 最终切换：移除EFCore依赖，全面使用新ORM

在实际项目中，我发现这些实践特别有价值：

• 统一抽象层：保持仓储接口不变，仅替换实现
• 性能监控：集成后使用APM工具监控SQL性能
• 团队培训：组织内部分享会讲解新ORM的特有概念

// 统一抽象示例 public interface IProductRepository { Task<Product> GetAsync(Guid id); // 其他方法... } // SqlSugar实现 public class ProductSqlSugarRepository : SqlSugarRepository, IProductRepository { public async Task<Product> GetAsync(Guid id) { return await Queryable<Product>().InSingleAsync(id); } } // FreeSql实现 public class ProductFreeSqlRepository : FreeSqlRepository, IProductRepository { public async Task<Product> GetAsync(Guid id) { return await Select<Product>().Where(p => p.Id == id).FirstAsync(); } }

经过多个项目的实践验证，这种集成方式既保留了ABP框架的架构优势，又能充分利用国产ORM的特性，特别是在需要快速迭代的中小型企业项目中，开发效率提升明显。