TypeORM Seeding 项目常见问题解决方案-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00758/article/details/145295544

TypeORM Seeding 项目常见问题解决方案

typeorm-seeding 🌱 A delightful way to seed test data into your database. 项目地址: https://gitcode.com/gh_mirrors/ty/typeorm-seeding

TypeORM Seeding 是一个用于为 TypeORM 数据库生成测试数据的工具，它通过工厂模式创建实体对象，并填充随机或预定义的数据，以便在开发或测试过程中使用。该项目主要使用 TypeScript 编程语言。

新手常见问题及解决步骤

问题一：如何安装 TypeORM Seeding

问题描述： 新手可能不清楚如何将 TypeORM Seeding 集成到他们的项目中。

解决步骤：

确保你的项目已经安装了 Node.js 和 npm。
在项目根目录下运行以下命令安装 TypeORM Seeding：
```
npm install --save typeorm-seeding
```
在你的项目中创建一个新的种子文件，例如 seed.ts。

问题二：如何定义实体和工厂

问题描述： 初学者可能不知道如何定义实体以及如何创建相应的工厂。

解决步骤：

首先，定义你的 TypeORM 实体。例如，创建一个 User.ts 文件并定义用户实体：

import { Entity, PrimaryGeneratedColumn, Column, OneToMany, BeforeInsert } from 'typeorm';
import { bcrypt } from 'bcrypt';

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

    @Column()
    name: string;

    @Column()
    password: string;

    @OneToMany(() => Pet, (pet) => pet.user)
    pets: Pet[];

    @BeforeInsert()
    async setPassword(password: string) {
        const salt = await bcrypt.genSalt();
        this.password = await bcrypt.hash(password || this.password, salt);
    }
}

然后，创建一个工厂来生成该实体的测试数据。例如，创建一个 UserFactory.ts 文件：

import { define } from 'typeorm-seeding';
import { Faker } from 'faker';

define(User, (faker: typeof Faker) => {
    const firstName = faker.name.firstName();
    const lastName = faker.name.lastName();
    const user = new User();
    user.name = `${firstName} ${lastName}`;
    user.password = faker.random.word();
    return user;
});

问题三：如何运行种子脚本

问题描述： 用户可能不清楚如何执行种子脚本来填充数据库。

解决步骤：

在项目根目录下创建一个种子运行脚本，例如 seed-run.ts，并引入 TypeORM Seeding 的运行器：

import { SeedRun } from 'typeorm-seeding';

new SeedRun().run().then(() => {
    console.log('Seeding complete.');
}).catch((error) => {
    console.error('Error occurred:', error);
});