AdonisJS 6中使用UUID作为主键的迁移实践

在AdonisJS 6框架中，使用UUID作为数据库表的主键是一种常见的需求，特别是在分布式系统中。本文将详细介绍如何在AdonisJS 6中正确配置UUID主键，并解决迁移过程中可能遇到的问题。

UUID主键的基本配置

在AdonisJS 6中，我们可以通过迁移文件来创建使用UUID作为主键的表。基本的迁移代码如下：

import { BaseSchema } from '@adonisjs/lucid/schema'

export default class extends BaseSchema {
  protected tableName = 'groups'

  async up() {
    this.schema.createTable(this.tableName, (table) => {
      table.uuid('id').primary().defaultTo(this.db.rawQuery('gen_random_uuid()').knexQuery)
      table.string('name', 255).notNullable()
      table.string('suffix', 255).notNullable()
      table.timestamp('created_at')
      table.timestamp('updated_at')
    })
  }
}

这里我们使用了PostgreSQL内置的gen_random_uuid()函数来生成UUID值。

使用自定义Schema

如果你的数据库表需要放在特定的schema中（如示例中的xp schema），需要使用withSchema方法：

async up() {
  this.schema.withSchema('xp').createTable(this.tableName, (table) => {
    table.uuid('id').primary().defaultTo(this.db.rawQuery('uuid_generate_v4()').knexQuery)
    // 其他字段...
  })
}

安装UUID扩展

PostgreSQL需要安装uuid-ossp扩展才能使用uuid_generate_v4()函数。我们可以创建一个专门的迁移文件来安装这个扩展：

import { BaseSchema } from '@adonisjs/lucid/schema'

export default class SetupExtensions extends BaseSchema {
  async up() {
    this.schema.raw('CREATE EXTENSION IF NOT EXISTS "uuid-ossp"')
  }

  async down() {
    this.schema.raw('DROP EXTENSION IF EXISTS "uuid-ossp"')
  }
}

关联表的使用

当使用UUID作为外键时，需要确保关联表也使用相同类型的UUID主键：

table
  .uuid('user_id')
  .notNullable()
  .references('id')
  .inTable('users')
  .onDelete('CASCADE')

最佳实践建议

1. 在PostgreSQL 13及以上版本中，优先使用gen_random_uuid()函数，它是PostgreSQL内置的标准函数
2. 对于旧版本PostgreSQL，使用uuid_generate_v4()函数，但需要先安装uuid-ossp扩展
3. 确保在创建表之前已经运行了安装扩展的迁移
4. 对于多schema环境，始终使用withSchema方法明确指定schema名称
5. 在模型定义中，使用@column({ isPrimary: true })装饰器标记UUID主键字段

通过遵循这些实践，你可以在AdonisJS 6项目中顺利使用UUID作为主键，构建出更适合分布式系统的数据模型。