Kysely项目中自定义MigrationProvider的实现问题解析

问题背景

在使用Kysely ORM框架进行数据库迁移时，开发者可能会遇到自定义MigrationProvider实现的问题。当尝试通过依赖注入系统传递迁移类实例时，迁移操作会失败并抛出"migration.up is not a function"的错误。

问题本质

这个问题的根源在于Kysely的Migrator内部实现方式。当使用自定义MigrationProvider时，Migrator内部使用了扩展运算符(...)来处理迁移对象，这会导致类实例的方法(如up方法)在扩展过程中丢失。

技术分析

在Kysely的迁移机制中，Migration接口要求每个迁移必须实现up方法，用于执行迁移操作。当开发者使用类实例来实现迁移时，如：

class MyMigration implements Migration {
  async up(db: Kysely<DB>): Promise<void> {
    // 迁移逻辑
  }
}

并通过自定义MigrationProvider传递这些实例时，Migrator内部的扩展操作会破坏类实例的原型链，导致方法不可访问。

解决方案

目前有两种可行的解决方案：

1. 包装方案（临时解决方案）

async getMigrations(): Promise<Record<string, Migration>> {
  return this.migrations.reduce((prev, curr) => {
    const migration: Migration = {
      up: async (db: Kysely<DB>) => await curr.up(db),
      // 可选地添加down方法
      ...(curr.down && { 
        down: async (db: Kysely<DB>) => await curr.down(db) 
      })
    };
    prev[curr.name] = migration;
    return prev;
  }, {} as Record<string, Migration>);
}

这种方法通过显式地重新定义迁移方法，确保它们在扩展操作后仍然可用。

2. 直接使用对象字面量（推荐方案）

更简洁的方式是避免使用类实例，直接使用对象字面量定义迁移：

const migrations = {
  '001-initial': {
    async up(db: Kysely<DB>) {
      // 迁移逻辑
    },
    async down(db: Kysely<DB>) {
      // 回滚逻辑
    }
  }
  // 其他迁移...
};

这种方式完全避免了类实例和原型链的问题，是更可靠的实现方式。

最佳实践建议

1. 避免在迁移中使用类实例：直接使用对象字面量可以避免原型链相关的问题。

2. 保持迁移简单：迁移文件应该只包含必要的数据库模式变更逻辑，避免复杂的业务逻辑。

3. 考虑迁移的幂等性：确保迁移可以安全地多次执行而不会产生副作用。

4. 明确命名迁移：使用有意义的名称和时间戳来命名迁移文件，便于管理和追踪。

总结

Kysely的迁移系统设计上更倾向于使用简单的对象字面量而非类实例来实现迁移。虽然通过包装方案可以临时解决类实例的问题，但从长期维护和稳定性考虑，直接使用对象字面量是更推荐的做法。理解这一设计决策有助于开发者更高效地使用Kysely的迁移功能。