在C#项目开发中,数据库结构的迭代调整是常态,手动修改数据库表结构、同步不同环境的数据库版本不仅耗时还容易出错。FluentMigrator是一款基于.NET的数据库迁移框架,它允许开发者用C#代码定义数据库变更逻辑,自动完成版本管理和迁移执行,让数据库变更过程可控可追溯。

FluentMigrator核心概念
FluentMigrator的核心设计围绕迁移版本展开,几个关键概念需要提前了解:
- 迁移类:每个迁移类对应一次数据库变更操作,需要继承
Migration基类,并重写Up和Down方法,分别定义升级和回滚的逻辑。 - 版本号:每个迁移类通过特性标注唯一的版本号,框架会按照版本号顺序执行迁移,避免重复执行已完成的迁移。
- 迁移运行器:负责扫描项目中的迁移类,对比数据库中的版本记录,执行未应用的迁移操作。
环境准备与配置
首先需要在C#项目中安装FluentMigrator相关的NuGet包,根据使用的数据库类型选择对应的驱动包,以SQL Server为例,需要安装以下两个包:
// 安装命令,可在NuGet包管理器控制台执行 // Install-Package FluentMigrator // Install-Package FluentMigrator.Runner.SqlServer
安装完成后,需要配置迁移运行器,通常在项目的启动逻辑中添加配置代码:
using FluentMigrator.Runner;
using Microsoft.Extensions.DependencyInjection;
using System;
public class MigrationConfig
{
public static void ConfigureMigration(IServiceCollection services)
{
// 配置迁移运行器,指定数据库连接字符串和数据库类型
services.AddFluentMigratorCore()
.ConfigureRunner(rb => rb
// 使用SQL Server数据库
.AddSqlServer()
// 指定数据库连接字符串,这里替换为实际的数据库连接
.WithGlobalConnectionString("Server=127.0.0.1;Database=TestDB;Trusted_Connection=True;")
// 扫描当前程序集中所有的迁移类
.ScanIn(typeof(MigrationConfig).Assembly).For.Migrations())
// 添加日志服务
.AddLogging(lb => lb.AddFluentMigratorConsole());
}
}
编写第一个迁移脚本
接下来我们编写一个创建用户表的迁移类,版本号设置为202401001,类名建议包含版本号方便识别:
using FluentMigrator;
// 标注迁移版本号,格式可以自定义,只要保证唯一且有序即可
[Migration(202401001)]
public class AddUserTable : Migration
{
public override void Up()
{
// 创建用户表
Create.Table("Users")
.WithColumn("Id").AsInt32().PrimaryKey().Identity() // 主键自增Id
.WithColumn("UserName").AsString(50).NotNullable() // 用户名,非空,长度50
.WithColumn("Email").AsString(100).Nullable() // 邮箱,可为空
.WithColumn("CreateTime").AsDateTime().NotNullable().WithDefault(SystemMethods.CurrentDateTime); // 创建时间,默认当前时间
}
public override void Down()
{
// 回滚操作,删除用户表
Delete.Table("Users");
}
}
在Up方法中定义了升级时的操作,这里创建了Users表并添加四个字段;Down方法定义了回滚时的操作,当执行迁移回滚时会删除该表。
执行迁移操作
配置和迁移类编写完成后,就可以执行迁移操作了,在控制台程序的入口处添加执行逻辑:
using Microsoft.Extensions.DependencyInjection;
using System;
class Program
{
static void Main(string[] args)
{
var serviceProvider = new ServiceCollection()
.AddLogging(lb => lb.AddConsole())
.BuildServiceProvider();
// 调用之前配置的方法
MigrationConfig.ConfigureMigration(serviceProvider.GetRequiredService<IServiceCollection>());
// 获取迁移运行器并执行迁移
using (var scope = serviceProvider.CreateScope())
{
var runner = scope.ServiceProvider.GetRequiredService<IMigrationRunner>();
// 执行所有未应用的迁移
runner.MigrateUp();
// 如果需要回滚到指定版本,可以调用 runner.MigrateDown(目标版本号);
}
Console.WriteLine("数据库迁移执行完成");
}
}
运行程序后,FluentMigrator会自动在目标数据库中创建名为VersionInfo的表,用于记录已执行的迁移版本,然后执行我们编写的AddUserTable迁移,创建Users表。
常用迁移操作示例
添加表字段
如果后续需要给用户表添加手机号字段,可以新建一个迁移类:
using FluentMigrator;
[Migration(202401002)]
public class AddPhoneColumnToUser : Migration
{
public override void Up()
{
// 给Users表添加Phone字段
Alter.Table("Users")
.AddColumn("Phone").AsString(20).Nullable();
}
public override void Down()
{
// 回滚时删除Phone字段
Delete.Column("Phone").FromTable("Users");
}
}
创建索引
为了提升用户名的查询效率,可以给UserName字段创建唯一索引:
using FluentMigrator;
[Migration(202401003)]
public class AddUserIndex : Migration
{
public override void Up()
{
// 创建唯一索引
Create.Index("IX_Users_UserName")
.OnTable("Users")
.OnColumn("UserName").Ascending()
.WithOptions().Unique();
}
public override void Down()
{
// 删除索引
Delete.Index("IX_Users_UserName").OnTable("Users");
}
}
注意事项
- 迁移类的版本号必须唯一,建议采用时间戳或者递增数字的方式命名,避免版本冲突。
Down方法的逻辑要和Up方法对应,确保回滚操作可以正确还原数据库状态。- 生产环境执行迁移前,建议先在测试环境验证迁移脚本的正确性,避免误操作导致数据丢失。
- 如果迁移过程中出现异常,FluentMigrator会停止执行,需要修复问题后重新运行迁移。
C#FluentMigrator数据库迁移数据迁移修改时间:2026-07-20 07:30:30