将TypeORM实体独立为npm仓库引入项目后，启动报Entity metadata未找到错误

常见原因及修复方案 #

1. 实体关联引用路径错误 #

如果Account实体中通过@OneToMany或@ManyToOne关联Campaign，确保引用的是实体包的导出路径，而非相对路径。比如：

// 错误写法（相对路径在主项目中会指向本地文件）
import { Campaign } from './Campaign';

// 正确写法（使用npm包的导出路径）
import { Campaign } from '@your-entity-package/entities';

2. 实体包的编译与导出配置问题 #

• 检查实体包的tsconfig.json，确保开启装饰器相关配置：

  {
    "compilerOptions": {
      "experimentalDecorators": true,
      "emitDecoratorMetadata": true,
      "outDir": "./dist",
      "declaration": true
    }
  }
  

• 在实体包的package.json中配置正确的导出规则，确保主项目能正确导入实体：

  {
    "main": "./dist/index.js",
    "exports": {
      "./entities": "./dist/entities/index.js"
    },
    "types": "./dist/index.d.ts"
  }
  

  同时确保所有实体类都被导出到dist/entities/index.js中。

3. 修改TypeORM连接的entities配置 #

不要直接导入实体类，改用文件路径匹配的方式让TypeORM扫描实体元数据，避免因模块解析问题导致元数据丢失：

export async function getConnection(): Promise<DataSource> {
  if (!connection) {
    const AppDataSource = new DataSource({
      type: 'mysql',
      host: process.env.MYSQL_HOSTNAME,
      port: +process.env.MYSQL_PORT,
      username: process.env.MYSQL_USERNAME,
      password: process.env.MYSQL_ROOT_PASSWORD,
      database: process.env.MYSQL_DATABASE,
      // 改用路径匹配实体包的编译后文件
      entities: [
        'node_modules/@your-entity-package/dist/entities/**/*.js'
      ],
      extra: {
        connectionLimit: 5,
      },
    });

    connection = await AppDataSource.initialize()
      .then(_con => {
        console.log("Data Source has been initialized!")
        return _con;
      })
    return connection;
  }
  return connection;
}

如果使用ts-node运行项目，路径改为ts文件路径：'node_modules/@your-entity-package/src/entities/**/*.ts'

4. 确保TypeORM版本一致性 #

• 将实体包中的TypeORM设为peerDependency，避免主项目和实体包安装多个TypeORM实例：

  {
    "peerDependencies": {
      "typeorm": "^0.3.x"
    }
  }
  

• 主项目和实体包使用完全相同的TypeORM版本，版本不兼容会导致元数据解析失败。

内容的提问来源于stack exchange，提问作者Zaven Petrosyan