如何快速集成FreeSql与ASP.NET Core：从零搭建完整ORM项目架构-开发者社区

如何快速集成FreeSql与ASP.NET Core：从零搭建完整ORM项目架构

【免费下载链接】FreeSql.NET aot orm, VB.NET/C# orm, Mysql/PostgreSQL/SqlServer/Oracle orm, Sqlite/Firebird/Clickhouse/DuckDB orm, 达梦/金仓/虚谷/翰高/高斯 orm, 神通 orm, 南大通用 orm, 国产 orm, TDengine orm, QuestDB orm, MsAccess orm.项目地址: https://gitcode.com/gh_mirrors/fr/FreeSql

FreeSql是一款功能强大的.NET ORM框架，支持Mysql、PostgreSQL、SqlServer等多种数据库，能够帮助开发者轻松实现数据访问层的构建。本文将详细介绍如何在ASP.NET Core项目中集成FreeSql，从环境配置到数据操作，带你快速掌握这一高效ORM工具的使用方法。

FreeSql核心架构概览

FreeSql拥有模块化的架构设计，提供了丰富的功能组件和数据库支持。其核心组件包括数据访问接口、代码优先和数据库优先两种开发模式、多种数据库驱动以及扩展工具等。

从架构图中可以看到，IFreeSql作为核心接口，连接了CRUD操作、AOP、读写分离等功能模块，并通过不同的Provider支持多种数据库。这种设计使得FreeSql既灵活又强大，能够满足各种业务场景的需求。

准备工作：环境配置与项目创建

在开始集成FreeSql之前，需要确保你的开发环境满足以下要求：

.NET Core SDK 3.1或更高版本
任意一种受支持的数据库（如MySQL、SQL Server等）
Visual Studio 2019或更高版本

首先，创建一个新的ASP.NET Core项目。可以使用Visual Studio的项目模板，也可以通过命令行创建：

dotnet new webapi -n FreeSqlDemo cd FreeSqlDemo

安装FreeSql相关包

接下来，需要安装FreeSql的核心包以及相应的数据库驱动。以MySQL为例，在项目中安装以下NuGet包：

dotnet add package FreeSql dotnet add package FreeSql.Provider.MySql dotnet add package FreeSql.DbContext

这些包分别提供了FreeSql的核心功能、MySQL数据库支持以及与ASP.NET Core集成的DbContext组件。

配置FreeSql服务

在ASP.NET Core中集成FreeSql的关键步骤是在Startup.cs文件中配置服务。打开Examples/dbcontext_01/Startup.cs文件，可以看到以下配置代码：

services.AddFreeDbContext<SongContext>(options => options.UseFreeSql(Fsql));

这段代码将FreeSql的DbContext注册到依赖注入容器中，使得我们可以在控制器或其他服务中通过构造函数注入使用。

创建数据上下文类

接下来，需要创建一个继承自DbContext的类，作为数据访问的核心。在Examples/dbcontext_01/DbContexts/SongContext.cs中定义如下：

public class SongContext : DbContext { public DbSet<Song> Songs { get; set; } protected override void OnConfiguring(DbContextOptionsBuilder builder) { builder.UseFreeSql(DbContextExtensions.Fsql); } }

这个类定义了数据库中的实体集合（DbSet），并在OnConfiguring方法中配置了FreeSql的使用。

定义实体类

创建与数据库表对应的实体类，例如：

public class Song { public int Id { get; set; } public string Title { get; set; } public string Artist { get; set; } public DateTime ReleaseDate { get; set; } }

FreeSql支持通过特性或Fluent API来配置实体与数据库表之间的映射关系，这部分功能可以在FreeSql.DataAnnotations命名空间中找到相关类。

实现基本CRUD操作

有了数据上下文和实体类后，就可以在控制器中实现基本的CRUD操作了。例如：

[ApiController] [Route("api/[controller]")] public class SongsController : ControllerBase { private readonly SongContext _dbContext; public SongsController(SongContext dbContext) { _dbContext = dbContext; } [HttpGet] public async Task<ActionResult<IEnumerable<Song>>> GetSongs() { return await _dbContext.Songs.ToListAsync(); } // 其他操作方法... }

通过依赖注入获取SongContext实例，就可以轻松实现对数据的增删改查操作。

高级特性：事务与工作单元

FreeSql提供了强大的事务支持，可以通过UnitOfWork来管理事务。在FreeSql.Repository命名空间中，你可以找到UnitOfWorkManager等类，用于实现工作单元模式。

例如：

using (var uow = _unitOfWorkManager.Begin()) { // 执行多个数据库操作 _dbContext.Songs.Add(new Song { Title = "Hello World" }); _dbContext.SaveChanges(); uow.Commit(); }

这种方式可以确保多个操作要么同时成功，要么同时失败，保证数据的一致性。