TypeORM OneToMany 导致“ReferenceError：在初始化之前无法访问‘<Entity>’”

Question

我有两个实体：User和Habit。一个用户可以创建多个习惯，因此我在用户上使用OneToMany关系（分别在习惯上使用ManyToOne）。

用户实体

import {Entity, PrimaryGeneratedColumn, Column, CreateDateColumn, UpdateDateColumn, BeforeInsert, BeforeUpdate, OneToMany} from "typeorm";
import * as bcrypt from "bcryptjs";
import { Habit } from "../habits/habits.entity";

@Entity()
export class User {
    @PrimaryGeneratedColumn("uuid")
    id: string;

    @Column()
    name: string;

    @Column()
    email: string;

    @Column()
    password: string;

    @OneToMany(type => Habit, habit => habit.author)
    habits: Habit[];

    @CreateDateColumn()
    dateCreated: Date;

    @UpdateDateColumn()
    dateUpdated: Date;

    @BeforeInsert()
    @BeforeUpdate()
    async hashPassword(): Promise<void> {
        this.password = await bcrypt.hash(this.password,10);
    }

    async comparePassword(password: string): Promise<boolean> {
        return bcrypt.compare(password, this.password);
    }

    constructor(props: any) {
        Object.assign(this, props);
    }
}

习惯实体

import {Column, CreateDateColumn, Entity, PrimaryGeneratedColumn, UpdateDateColumn, ManyToOne} from "typeorm";
import { User } from "../users/users.entity";

@Entity()
export class Habit {
    @PrimaryGeneratedColumn("uuid")
    id: string;

    @Column()
    name: string;

    @Column({ nullable: true})
    description?: string;

    @ManyToOne(type => User, user => user.habits)
    author: User;

    @CreateDateColumn()
    dateCreated: Date;

    @UpdateDateColumn()
    dateUpdated: Date;

    constructor(props: Partial<Habit>) {
        Object.assign(this, props);
    }
}

问题

设置上述关系时，我收到以下错误

WARNING in Circular dependency detected:
apps\api\src\habits\habits.entity.ts -> apps\api\src\users\users.entity.ts -> apps\api\src\habits\habits.entity.ts

WARNING in Circular dependency detected:
apps\api\src\users\users.entity.ts -> apps\api\src\habits\habits.entity.ts -> apps\api\src\users\users.entity.ts


/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "User", function() { return User; });
                                                                                               ^
ReferenceError: Cannot access 'User' before initialization
    at Module.User (...\dist\apps\api\main.js:1782:96)
    at Module../apps/api/src/habits/habits.entity.ts (...\dist\apps\api\webpack:\apps\api\src\habits\habits.entity.ts:42:13)
    at __webpack_require__ (...\dist\apps\api\webpack:\webpack\bootstrap:19:1)
    at Module../apps/api/src/users/users.entity.ts (...\dist\apps\api\main.js:1790:79)
    at __webpack_require__ (...\dist\apps\api\webpack:\webpack\bootstrap:19:1)
    at Module../apps/api/src/config/db-config.service.ts (...\dist\apps\api\main.js:1038:77)
    at __webpack_require__ (...\dist\apps\api\webpack:\webpack\bootstrap:19:1)
    at Module../apps/api/src/config/config.module.ts (...\dist\apps\api\main.js:978:76)
    at __webpack_require__ (...\dist\apps\api\webpack:\webpack\bootstrap:19:1)
    at Module../apps/api/src/app/app.module.ts (...\dist\apps\api\main.js:147:79)

笔记

我使用Nx并创建了一个NestJS应用程序。TypeOrm 版本是“^0.2.22”，@nestjs/typeorm 版本是“^6.2.0”

我的tsconfig如下：

{
  "compileOnSave": false,
  "compilerOptions": {
    "rootDir": ".",
    "sourceMap": true,
    "declaration": false,
    "moduleResolution": "node",
    "emitDecoratorMetadata": true,
    "experimentalDecorators": true,
    "importHelpers": true,
    "target": "es2015",
    "module": "esnext",
    "typeRoots": ["node_modules/@types"],
    "lib": ["es2018", "dom"],
    "skipLibCheck": true,
    "skipDefaultLibCheck": true,
    "baseUrl": ".",
    "paths": {
      "@awhile/contracts": ["libs/contracts/src/index.ts"],
      "@awhile/ui": ["libs/ui/src/index.ts"]
    }
  },
  "exclude": ["node_modules", "tmp"]
}

我尝试使用ManyToMany关系并且它起作用了。此外，在单独的 NestJS 应用程序（没有 Nx）上，我无法重现此参考错误。在tsconfig.json 中更改 ECMAScript目标版本也不起作用。

这两个实体仅在其服务中使用，不会在其他任何地方实例化。

我很感激任何帮助。先感谢您。

Answer 1

使用Relation类型包装器可以避免循环依赖问题，如此处所述。

例如：

import {Entity, OneToMany, Relation} from "typeorm";
import {Habit} from "../habits/habits.entity";

@Entity()
export class User {
    ...

    @OneToMany(type => Habit, habit => habit.author)
    habits: Relation<Habit>[];

    ...
}

Answer 2

在 tsconfig 中，将目标设置为“esnext”并将模块设置为“commonjs”为我解决了这个问题

{
  "extends": "../../tsconfig.json",
  "compilerOptions": {
    "types": ["node", "jest"],
    "emitDecoratorMetadata": true,
    "experimentalDecorators": true,
    "module": "commonjs",
    "target": "esnext"
  },
  "include": ["**/*.ts"]
}

Answer 3

我通过在将 TypeORM 配置加载到 NestJS 时使用 autoLoadEntities: true 解决了这个问题。请注意，这是 NestJS 的额外功能，因此如果您使用 ormconfig.json，则不会应用此属性。

autoLoadEntities 文档位于：https://docs.nestjs.com/techniques/database#auto-load-entities

更新 04/10/2020

我在人际关系方面一直遇到同样的问题。我发现的另一个解决方案是将所有实体添加到一个文件中，即使它违反了一些标准。将它们导出到那里并在需要的地方导入它们。

请记住，声明类的顺序很重要。

Answer 4

您可以通过使用桶文件来完成与@jdruper相同的事情。如果 tsconfig.json 中没有 paths 属性，请在下面添加一个，compilerOptions如下所示：

"paths": {
   "@entities":["app/src/entities/index.ts"]
}

将所有实体类放入Entity文件夹中，创建index.ts文件并在index.ts文件中添加导出语句：

export * from './user.entity';
export * from './habit.entity';

确保导出语句按要求的顺序出现。您的导入将如下所示。

import { User, Habit } from '@entities';

您可以搜索打字稿桶文件以获取有关如何使用桶文件的更多信息。

如果您使用 NX，您可以创建一个实体库并完成同样的事情。

这可能意味着必须将所有实体文件移动到一起并更新模块和服务中的导入。也许并不完全理想，但我更喜欢将它们全部放在一个文件中。