NestJS 与 TypeORM 集成教程

1. 项目的目录结构及介绍

NestJS 与 TypeORM 集成的项目通常包含以下目录结构：

my-nestjs-app/
├── src/
│   ├── app.module.ts
│   ├── main.ts
│   ├── entities/
│   │   └── user.entity.ts
│   ├── repositories/
│   │   └── user.repository.ts
│   ├── migrations/
│   │   └── 1609459200000-CreateUser.ts
│   ├── config/
│   │   └── ormconfig.ts
├── test/
├── package.json
├── tsconfig.json
└── ormconfig.json

目录介绍：

• src/：包含应用程序的源代码。
  • app.module.ts：应用程序的根模块。
  • main.ts：应用程序的入口文件。
  • entities/：存放数据库实体类。
  • repositories/：存放自定义的存储库类。
  • migrations/：存放数据库迁移文件。
  • config/：存放配置文件，如 ormconfig.ts。
• test/：包含测试文件。
• package.json：项目的依赖和脚本配置。
• tsconfig.json：TypeScript 编译配置。
• ormconfig.json：TypeORM 配置文件。

2. 项目的启动文件介绍

main.ts

main.ts 是 NestJS 应用程序的入口文件，负责启动应用程序。以下是一个典型的 main.ts 文件内容：

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  await app.listen(3000);
}
bootstrap();

代码解释：

• NestFactory.create(AppModule)：创建一个 Nest 应用程序实例，传入根模块 AppModule。
• app.listen(3000)：启动 HTTP 服务器，监听端口 3000。

3. 项目的配置文件介绍

ormconfig.json

ormconfig.json 是 TypeORM 的配置文件，用于配置数据库连接和其他 TypeORM 选项。以下是一个典型的 ormconfig.json 文件内容：

{
  "type": "mysql",
  "host": "localhost",
  "port": 3306,
  "username": "root",
  "password": "password",
  "database": "test",
  "entities": ["dist/entities/**/*.entity{.ts,.js}"],
  "migrations": ["dist/migrations/**/*{.ts,.js}"],
  "synchronize": true
}

配置项解释：

• type：数据库类型，如 mysql、postgres 等。
• host：数据库主机地址。
• port：数据库端口号。
• username：数据库用户名。
• password：数据库密码。
• database：数据库名称。
• entities：实体类文件路径。
• migrations：迁移文件路径。
• synchronize：是否自动同步数据库结构。

通过以上配置，TypeORM 可以正确连接到数据库，并加载实体和迁移文件。

---

以上是 NestJS 与 TypeORM 集成项目的目录结构、启动文件和配置文件的详细介绍。希望这份文档能帮助你更好地理解和使用 NestJS 与 TypeORM。