FreeSql 使用詳解：從入門到高級

FreeSql 是一個(gè)開源的、輕量級的 ORM 框架，它為 .NET 開發(fā)人員提供了豐富的功能，包括 CRUD 操作、讀寫分離、多租戶、導(dǎo)航屬性支持等。相比于 Entity Framework Core，FreeSql 在性能和特性上有一些獨(dú)特的優(yōu)勢，特別是在復(fù)雜的數(shù)據(jù)庫操作和分布式場景中。本文將詳細(xì)介紹 FreeSql 的各個(gè)功能，從基本的 CRUD 操作開始，逐步深入到讀寫分離和導(dǎo)航屬性等高級特性。

一、FreeSql 入門

1.1 FreeSql 的安裝

首先，您需要在項(xiàng)目中安裝 FreeSql。可以通過 NuGet 來安裝 FreeSql 的包。

Install-Package FreeSql

或者使用 .NET CLI:

dotnet add package FreeSql

1.2 FreeSql 的初始化

初始化 FreeSql 通常需要通過 IFreeSql 接口來操作。最簡單的初始化示例如下：

var fsql = new FreeSqlBuilder().UseConnectionString(DataType.MySql, "連接字符串").Build();

這里我們使用了 MySQL 數(shù)據(jù)庫，你可以根據(jù)實(shí)際需求替換為其他數(shù)據(jù)庫，例如：

• DataType.SqlServer 用于 SQL Server
• DataType.PostgreSQL 用于 PostgreSQL
• DataType.Sqlite 用于 SQLite

1.3 基本的 CRUD 操作

FreeSql 提供了簡潔的 API 來執(zhí)行基本的增刪改查操作。下面是簡單的增刪改查示例：

1.3.1 插入數(shù)據(jù)

var newUser = new User { Name = "張三", Age = 25 };
var insertedId = fsql.Insert(newUser).ExecuteIdentity();

1.3.2 查詢數(shù)據(jù)

var user = fsql.Select<User>().Where(a => a.Id == 1).First();

1.3.3 更新數(shù)據(jù)

fsql.Update<User>().Set(a => a.Age, 26).Where(a => a.Id == 1).ExecuteAffrows();

1.3.4 刪除數(shù)據(jù)

fsql.Delete<User>().Where(a => a.Id == 1).ExecuteAffrows();

二、FreeSql 進(jìn)階功能

2.1 查詢優(yōu)化

FreeSql 提供了豐富的查詢功能和優(yōu)化技巧，比如分頁查詢、多表查詢等。

2.1.1 分頁查詢

分頁查詢在大多數(shù)應(yīng)用中是必不可少的，FreeSql 提供了簡單的 API 來執(zhí)行分頁查詢：

var users = fsql.Select<User>().Page(1, 10).ToList();

2.1.2 多表查詢

多表查詢也是 ORM 框架中的重要特性。FreeSql 支持多種方式進(jìn)行多表查詢。

var query = fsql.Select<User, Order>().LeftJoin((u, o) => u.Id == o.UserId).Where((u, o) => u.Age > 18).ToList((u, o) => new { u.Name, o.OrderId });

2.2 事務(wù)管理

FreeSql 允許您在事務(wù)中執(zhí)行多個(gè)數(shù)據(jù)庫操作，確保數(shù)據(jù)一致性。

using (var transaction = fsql.CreateTransaction())
{try{fsql.Insert(new User { Name = "張三", Age = 30 }).ExecuteAffrows();fsql.Insert(new Order { UserId = 1, Amount = 100 }).ExecuteAffrows();transaction.Commit();}catch{transaction.Rollback();throw;}
}

三、FreeSql 高級特性

3.1 讀寫分離

FreeSql 內(nèi)置了讀寫分離的功能，適用于分布式場景或主從數(shù)據(jù)庫架構(gòu)。你可以通過配置多個(gè)連接字符串來實(shí)現(xiàn)讀寫分離：

var fsql = new FreeSqlBuilder().UseMasterConnectionString("主庫連接字符串").UseSlaveConnectionString("從庫1連接字符串", "從庫2連接字符串").Build();

• UseMasterConnectionString 用于設(shè)置主庫的連接字符串，所有寫操作將會(huì)發(fā)送到主庫。
• UseSlaveConnectionString 用于配置從庫的連接字符串，所有讀操作將會(huì)發(fā)送到從庫。

FreeSql 將自動(dòng)在讀操作和寫操作之間進(jìn)行切換，從而實(shí)現(xiàn)讀寫分離。讀寫分離能夠極大地提高系統(tǒng)的性能，尤其是在讀操作密集型的應(yīng)用場景中。

3.2 導(dǎo)航屬性

FreeSql 支持導(dǎo)航屬性，這使得處理實(shí)體之間的關(guān)聯(lián)關(guān)系變得非常方便。假設(shè)我們有兩個(gè)實(shí)體 User 和 Order，它們之間是一對多的關(guān)系：

public class User
{public int Id { get; set; }public string Name { get; set; }[Navigate("UserId")]public List<Order> Orders { get; set; }
}public class Order
{public int Id { get; set; }public int UserId { get; set; }public decimal Amount { get; set; }[Navigate("UserId")]public User User { get; set; }
}

要查詢帶有導(dǎo)航屬性的對象時(shí)，FreeSql 會(huì)自動(dòng)加載關(guān)聯(lián)的實(shí)體：

var userWithOrders = fsql.Select<User>().IncludeMany(a => a.Orders).Where(a => a.Id == 1).ToOne();

這種方式非常適合處理復(fù)雜的實(shí)體關(guān)系，避免了手動(dòng)編寫復(fù)雜的 SQL 語句。

3.3 緩存機(jī)制

FreeSql 提供了內(nèi)置的緩存機(jī)制，可以將查詢結(jié)果緩存起來，以減少數(shù)據(jù)庫的訪問次數(shù)，提升性能。

var cachedUser = fsql.Select<User>().Where(a => a.Id == 1).Cache(60, "user_cache") // 緩存 60 秒.First();

3.4 數(shù)據(jù)庫審計(jì)

FreeSql 還支持?jǐn)?shù)據(jù)庫審計(jì)功能，可以自動(dòng)跟蹤實(shí)體的創(chuàng)建、更新和刪除時(shí)間。你可以通過配置實(shí)體的審計(jì)屬性來啟用這一功能：

public class User
{public int Id { get; set; }public string Name { get; set; }public DateTime CreatedTime { get; set; }public DateTime UpdatedTime { get; set; }
}

然后在 FreeSql 配置中啟用審計(jì)功能：

fsql.Aop.AuditValue += (s, e) =>
{if (e.Property.Name == "CreatedTime" && e.Value == null)e.Value = DateTime.Now;if (e.Property.Name == "UpdatedTime")e.Value = DateTime.Now;
};

四、FreeSql 的最佳實(shí)踐

1. 合理使用緩存：對于頻繁查詢但數(shù)據(jù)變動(dòng)不大的場景，可以啟用 FreeSql 的緩存功能，減少數(shù)據(jù)庫的壓力。
2. 使用讀寫分離：對于讀多寫少的系統(tǒng)，可以啟用 FreeSql 的讀寫分離特性，提升讀操作的性能。
3. 合理設(shè)計(jì)導(dǎo)航屬性：在處理復(fù)雜的數(shù)據(jù)庫模型時(shí)，導(dǎo)航屬性可以簡化操作，但應(yīng)注意防止循環(huán)依賴，必要時(shí)可進(jìn)行懶加載處理。

五、總結(jié)

FreeSql 提供了強(qiáng)大的 ORM 功能，能夠簡化復(fù)雜的數(shù)據(jù)庫操作，提升開發(fā)效率。本文從基本的 CRUD 操作開始，介紹了 FreeSql 的核心功能，包括讀寫分離、導(dǎo)航屬性、緩存等高級特性。通過合理使用這些特性，您可以構(gòu)建出高性能、可擴(kuò)展的 .NET 應(yīng)用。

希望這篇從入門到進(jìn)階的 FreeSql 指南能為您在開發(fā)中提供幫助。如果你想要進(jìn)一步深入了解 FreeSql，建議查閱官方文檔或社區(qū)資源，深入挖掘其更多高級功能。