NestJS中Sequelize添加hooks报模型未初始化错误如何解决

错误触发的核心是钩子挂载代码的执行时机早于Sequelize模型初始化完成的时间。
在NestJS + @nestjs/sequelize的技术栈中，被@Table装饰器标记的User类本质只是一个普通类定义，不会自动绑定到Sequelize实例。只有当NestJS启动流程走到SequelizeModule初始化阶段、完成数据库连接、扫描并注册所有配置的模型之后，User类才会成为具备完整Sequelize Model能力的可用对象，此时才能调用afterCreate、beforeCreate这类模型静态方法挂载钩子。
如果直接把User.afterCreate()的调用代码写在模型文件顶层、或者任意早于SequelizeModule初始化的位置，代码执行时User模型还未完成注册，就会抛出该未初始化错误。

方式1：装饰器声明式注册（推荐） #

底层依赖的sequelize-typescript原生提供了钩子装饰器，直接在模型类内部定义钩子即可，框架会在模型初始化阶段自动完成注册，不存在时序问题：

import { Table, Column, Model, DataType, AfterCreate } from 'sequelize-typescript';

@Table({
  tableName: 'users',
})
export class User extends Model<User> {
  @Column({
    type: DataType.STRING,
    allowNull: false,
  })
  first_name: string;

  @Column({
    type: DataType.STRING,
    allowNull: false,
  })
  email: string;

  // 钩子方法需定义为类静态方法
  @AfterCreate
  static logNewUser(user: User, options: any) {
    console.log('New User created:');
    console.log(user.first_name);
    console.log(user.email);
  }
}

除示例中的@AfterCreate外，框架还提供@BeforeCreate、@BeforeUpdate、@AfterUpdate、@BeforeDelete、@AfterDelete等装饰器，覆盖Sequelize所有原生钩子节点。

方式2：通过自定义提供者在初始化完成后挂载 #

如果需要把钩子逻辑抽离到模型类外部，或者钩子逻辑中需要注入其他NestJS托管的服务，可以通过自定义提供者，等待Sequelize实例初始化完成后再执行钩子挂载：

1. 首先确保User模型已正确在SequelizeModule中注册：

// 对应模块文件
@Module({
  imports: [
    SequelizeModule.forRoot({
      dialect: 'mysql',
      host: 'localhost',
      port: 3306,
      username: 'root',
      password: '',
      database: 'test',
      models: [User],
    }),
    SequelizeModule.forFeature([User]),
  ],
})
export class AppModule {}

2. 添加自定义提供者，注入Sequelize实例，在工厂函数中挂载钩子：

import { SEQUELIZE } from '@nestjs/sequelize';
import { Sequelize } from 'sequelize-typescript';

@Module({
  imports: [/* 上述SequelizeModule相关引入 */],
  providers: [
    {
      provide: 'USER_MODEL_HOOKS',
      useFactory: (sequelize: Sequelize) => {
        // 此处执行时所有模型已完成注册，可安全调用模型静态方法
        User.afterCreate(async (user, options) => {
          console.log('New User created:');
          console.log(user.first_name);
          console.log(user.email);
        });
      },
      inject: [SEQUELIZE],
    }
  ]
})
export class AppModule {}

该方式下工厂函数只会在Sequelize连接建立、所有模型注册完成后执行，不会触发未初始化错误，同时支持注入其他NestJS提供者（比如日志服务、业务服务）供钩子逻辑调用。

禁止在以下位置直接调用模型静态方法挂载钩子：

• 模型文件的顶层作用域
• 未注入Sequelize实例依赖的类构造函数
• 其他无法保证执行时机晚于SequelizeModule初始化的位置
  上述位置的代码执行时模型尚未完成注册，必然触发同类报错。

内容的提问来源于stack exchange，提问作者halil baydar