【亲测免费】 FreeSql 开源项目教程

1. 项目介绍

FreeSql 是一个强大的对象关系映射（O/RM）组件，支持 .NET Core 2.1+、.NET Framework 4.0+、Xamarin 以及 AOT。它提供了丰富的功能，包括 CodeFirst 数据迁移、DbFirst 导入实体类、高级类型映射、表达式函数、导航属性、读写分离、分表/分库、全局过滤、乐观锁和悲观锁等。FreeSql 支持多种数据库，如 MySQL、PostgreSQL、SQL Server、Oracle、SQLite、Firebird 等，还包括国产数据库如达梦、人大金仓、神通、翰高、南大通用、虚谷等。

2. 项目快速启动

安装 FreeSql

首先，通过 NuGet 安装 FreeSql：

dotnet add package FreeSql.Provider.Sqlite

初始化 FreeSql

在项目中初始化 FreeSql 实例：

using FreeSql;

static IFreeSql fsql = new FreeSqlBuilder()
    .UseConnectionString(DataType.Sqlite, @"Data Source=document.db")
    .UseAutoSyncStructure(true) // 自动同步实体结构到数据库
    .Build(); // 确保定义为单例模式

定义实体类

定义一个简单的实体类：

class Song
{
    [Column(IsIdentity = true)]
    public int Id { get; set; }
    public string Title { get; set; }
    public string Url { get; set; }
    public DateTime CreateTime { get; set; }
    public ICollection<Tag> Tags { get; set; }
}

class Tag
{
    [Column(IsIdentity = true)]
    public int Id { get; set; }
    public string Name { get; set; }
    public int Parent_id { get; set; }
    public Tag Parent { get; set; }
    public ICollection<Song> Songs { get; set; }
    public ICollection<Tag> Tags { get; set; }
}

查询数据

使用 FreeSql 进行数据查询：

// 一对一、多对一查询
var tags = fsql.Select<Tag>()
    .Where(a => a.Parent.Parent.Name == "English")
    .ToList();

// 一对多查询
var tagsWithChildren = fsql.Select<Tag>()
    .IncludeMany(a => a.Tags, then => then.Where(sub => sub.Name == "foo"))
    .ToList();

// 多对多查询
var songs = fsql.Select<Song>()
    .IncludeMany(a => a.Tags, then => then.Where(sub => sub.Name == "foo"))
    .Where(s => s.Tags.Any(t => t.Name == "Chinese"))
    .ToList();

3. 应用案例和最佳实践

应用案例

FreeSql 被广泛应用于各种企业级项目中，例如：

• Zhontai.net 管理系统：一个简单的 CMS 实现，基于 .NET8。
• AIBPM 工作流：基于 C#12/.NET9 和 FreeSql 的快速开发框架。
• NetAdmin：一个基于 C#12/.NET9 和 FreeSql 的快速开发框架。

最佳实践

• 使用 Repository 模式：通过 BaseRepository<T> 实现数据访问层的封装。
• 事务管理：使用 TransactionalAttribute 和 UnitOfWorkManager 实现多事务传播。
• 性能优化：FreeSql 提供了高性能的查询和数据操作，可以与 Dapper 等其他 ORM 工具进行性能对比。

4. 典型生态项目

FreeSql 作为 .NET Core 社区的成员项目，与其他开源项目形成了良好的生态系统：

• FreeRedis：一个高性能的 Redis 客户端。
• FreeScheduler：一个定时任务调度器。
• FreeIM：一个即时通讯框架。
• CSRedisCore：另一个 Redis 客户端实现。

这些项目与 FreeSql 结合使用，可以构建出功能强大且高效的 .NET 应用。