FluentMigrator 中根据数据库类型自定义列类型的实现方案

背景介绍

在使用 FluentMigrator 进行数据库迁移时，开发者经常会遇到需要根据不同的数据库类型定义不同列类型的情况。例如，在 MySQL 中可能需要指定字符集为 latin1 的 GUID 类型，而在 SQLite 中则只需要普通的字符类型。

问题分析

传统的解决方案是直接在迁移代码中使用 AsCustom 方法硬编码特定数据库的类型定义。这种方法虽然简单，但存在明显的局限性：

1. 代码与特定数据库绑定，缺乏灵活性
2. 当需要支持多种数据库时，维护成本高
3. 迁移代码中混杂了数据库类型判断逻辑

解决方案

FluentMigrator 提供了更优雅的解决方案 - 通过自定义 IColumnsConvention 来实现数据库类型相关的列定义。

实现原理

IColumnsConvention 是 FluentMigrator 的约定机制之一，它允许开发者在迁移执行前对列定义进行统一处理。通过结合 IProcessorAccessor 获取当前数据库类型信息，可以实现基于数据库类型的动态列类型定义。

具体实现

以下是一个完整的实现示例：

public class CustomColumnTypeConvention : IColumnsConvention
{
    private readonly string _databaseType;

    public CustomColumnTypeConvention(IProcessorAccessor processorAccessor)
    {
        _databaseType = processorAccessor.Processor.DatabaseType;
    }

    public IColumnsExpression Apply(IColumnsExpression expression)
    {
        foreach (var column in expression.Columns)
        {
            if (column.CustomType == "MyLatin1Guid")
            {
                column.CustomType = _databaseType == "MySql" 
                    ? "char(36) CHARACTER SET latin1" 
                    : "char(36)";
            }
        }
        return expression;
    }
}

注册自定义约定

有两种方式注册自定义约定：

1. 通过 ConventionSet 访问器注册（推荐）

services.AddScoped<IConventionSet>(sp => 
{
    var conventionSet = sp.GetRequiredService<IConventionSetAccessor>().GetConventionSet();
    conventionSet.ColumnsConventions.Add(new CustomColumnTypeConvention(
        sp.GetRequiredService<IProcessorAccessor>()));
    return conventionSet;
});

2. 创建自定义 ConventionSet

public class CustomConventionSet : DefaultConventionSet
{
    public CustomConventionSet(IProcessorAccessor processorAccessor)
    {
        ColumnsConventions.Add(new CustomColumnTypeConvention(processorAccessor));
    }
}

// 注册服务
services.AddScoped<IConventionSet, CustomConventionSet>();

使用方式

在迁移代码中，可以统一使用自定义类型标识：

Create.Table("user")
    .WithColumn("user_id").AsCustom("MyLatin1Guid").PrimaryKey("pk_user");

优势分析

1. 解耦迁移代码与数据库实现：迁移代码不再需要关心底层数据库差异
2. 集中管理：所有数据库类型相关的逻辑集中在约定类中
3. 易于扩展：支持新的数据库类型只需修改约定类
4. 维护简单：类型定义变更只需修改一处

最佳实践

1. 为每种特殊列类型创建专门的约定类
2. 使用有意义的自定义类型标识符
3. 在约定类中添加详细的注释说明各数据库类型的差异
4. 编写单元测试验证不同数据库下的类型转换

总结

通过 FluentMigrator 的约定机制，开发者可以优雅地解决多数据库支持下的列类型差异问题。这种方法不仅提高了代码的可维护性，还使得迁移脚本更加清晰和数据库无关。对于需要支持多种数据库的项目，这无疑是最佳实践方案。