C#.NET 数据库迁移利器：FluentMigrator 从入门到精通

在软件开发过程中，数据库结构的变更几乎是不可避免的。手动编写和维护 SQL 脚本来执行这些变更既繁琐又容易出错，尤其是在多人协作或者需要频繁迭代的项目中。回滚错误的脚本更是噩梦。FluentMigrator 正是为了解决这些痛点而生的。它是一个 C#.NET 的数据库迁移框架，允许你使用 C# 代码来定义和管理数据库模式的变更，从而实现自动化、可重复和版本控制的数据库迁移。

FluentMigrator 的优势在于其代码化的迁移方式，使得数据库变更可以像其他代码一样进行版本控制，方便团队协作和部署。同时，它支持多种数据库类型，包括 MySQL、SQL Server、PostgreSQL 等，具有良好的可移植性。与传统的 SQL 脚本方式相比，FluentMigrator 显著提升了开发效率，降低了出错率。

FluentMigrator 底层原理深度剖析

FluentMigrator 的核心在于 Migration 类，每个 Migration 类代表一次数据库变更。在执行迁移时，FluentMigrator 会按照指定的版本顺序执行这些 Migration 类中的 Up 方法，回滚时则执行 Down 方法。框架内部通过读取程序集中的 Migration 类，并根据 Migration 类的版本号进行排序，最终执行相应的 Up 或 Down 方法。

Metadata 表

FluentMigrator 依赖于一个名为 VersionInfo (默认名，可配置) 的 Metadata 表来跟踪已执行的迁移版本。每次成功执行一个 Migration 类后，FluentMigrator 就会将该 Migration 类的版本号记录到 Metadata 表中。在下一次执行迁移时，FluentMigrator 会比较 Metadata 表中的版本号和程序集中 Migration 类的版本号，只执行尚未执行的 Migration 类。

MigrationRunner

MigrationRunner 是 FluentMigrator 的核心执行器，负责加载 Migration 类，解析依赖关系，并按照正确的顺序执行迁移。它会读取连接字符串、数据库类型等配置信息，并根据这些信息创建相应的数据库连接，执行 Up 或 Down 方法。

FluentMigrator 的使用方法详解

1. 安装 FluentMigrator NuGet 包

首先，需要在项目中安装 FluentMigrator 和对应的数据库驱动 NuGet 包。例如，如果使用 SQL Server，需要安装 FluentMigrator.Runner 和 FluentMigrator.Runner.SqlServer。

// 安装 FluentMigrator 和 SQL Server 驱动
Install-Package FluentMigrator.Runner
Install-Package FluentMigrator.Runner.SqlServer

2. 创建 Migration 类

创建一个类，继承自 Migration 类，并使用 MigrationAttribute 指定版本号。在 Up 方法中定义数据库变更操作，在 Down 方法中定义回滚操作。

using FluentMigrator;

[Migration(202310271000)] // 版本号，必须唯一
public class CreateUsersTable : Migration
{
    public override void Up()
    {
        Create.Table("Users")
            .WithColumn("Id").AsInt32().PrimaryKey().Identity()
            .WithColumn("Name").AsString(255).NotNullable()
            .WithColumn("Email").AsString(255).Unique()
            .WithColumn("CreatedAt").AsDateTime().WithDefaultValue(SystemMethods.CurrentDateTime);
    }

    public override void Down()
    {
        Delete.Table("Users"); // 回滚操作，删除表
    }
}

3. 配置 FluentMigrator

可以通过命令行工具或者 C# 代码来配置和执行 FluentMigrator。以下是一个使用 C# 代码配置 FluentMigrator 的示例：

using FluentMigrator.Runner;
using Microsoft.Extensions.DependencyInjection;

// 配置服务
var serviceProvider = new ServiceCollection()
    // Add common FluentMigrator services
    .AddFluentMigratorCore()
    .ConfigureRunner(rb => rb
        // Add SQLite support to FluentMigrator
        .AddSqlServer2016()
        // Set the connection string
        .WithGlobalConnectionString("Data Source=YourDatabase.db;Integrated Security=true;")
        // Define the assembly containing the migrations
        .ScanIn(typeof(CreateUsersTable).Assembly).For.Migrations())
    // Enable logging to console in the FluentMigrator way
    .AddLogging(lb => lb.AddFluentMigratorConsole())
    // Build the service provider
    .BuildServiceProvider(false);

// Instantiate the runner
using (var scope = serviceProvider.CreateScope())
{
    var runner = scope.ServiceProvider.GetRequiredService<IMigrationRunner>();

    // Execute the migrations
    runner.MigrateUp(); // 执行所有未执行的迁移
    //runner.MigrateDown(); //回滚最后一次迁移
}

4. 执行迁移

运行配置好的 C# 代码，FluentMigrator 就会自动执行所有未执行的 Migration 类，并将版本号记录到 Metadata 表中。

实战避坑经验总结

1. 版本号冲突：确保每个 Migration 类的版本号都是唯一的，否则会导致迁移失败。建议使用日期时间作为版本号，例如 202310271000。
2. 事务处理：FluentMigrator 默认情况下会使用事务来执行迁移。如果迁移过程中发生错误，事务会自动回滚，保证数据库的一致性。但是，有些数据库操作（例如创建全文索引）不支持在事务中执行，需要手动关闭事务。
3. 数据迁移：FluentMigrator 主要用于管理数据库结构，不适合用于大量的数据迁移。如果需要迁移大量的数据，建议使用其他工具，例如 SQLBulkCopy。
4. 连接字符串安全：不要将连接字符串硬编码到代码中，建议使用配置文件或者环境变量来管理连接字符串，并对连接字符串进行加密处理，防止泄露。
5. 回滚测试：在生产环境中执行迁移之前，务必在测试环境中进行充分的测试，包括正向迁移和回滚操作，确保迁移过程的正确性和安全性。
6. 数据库权限：确保执行迁移的用户具有足够的数据库权限，例如创建表、修改表、删除表等。避免出现权限不足导致的迁移失败。

FluentMigrator 与 DevOps 的结合

FluentMigrator 可以很好地与 DevOps 流程结合，实现数据库变更的自动化部署。可以将 FluentMigrator 集成到 CI/CD 流程中，在每次代码发布时自动执行数据库迁移。这样可以保证数据库结构与代码版本的同步，减少手动操作带来的风险。

例如，可以利用 Jenkins、GitLab CI 等工具，在代码合并到主分支后，自动触发 FluentMigrator 的执行，将数据库变更部署到测试环境或者生产环境。