NestjsProjectDemo 项目教程

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

NestjsProjectDemo/
├── src/
│   ├── app.module.ts
│   ├── main.ts
│   ├── config/
│   │   ├── config.module.ts
│   │   ├── config.service.ts
│   ├── modules/
│   │   ├── user/
│   │   │   ├── user.module.ts
│   │   │   ├── user.service.ts
│   │   │   ├── user.controller.ts
│   ├── entities/
│   │   ├── user.entity.ts
├── test/
├── .env.example
├── .gitignore
├── package.json
├── tsconfig.json
├── nest-cli.json
├── README.md

目录结构介绍

• src/：项目的源代码目录。
  • app.module.ts：应用程序的根模块。
  • main.ts：应用程序的入口文件。
  • config/：配置相关的文件。
    • config.module.ts：配置模块。
    • config.service.ts：配置服务。
  • modules/：业务模块目录。
    • user/：用户模块。
      • user.module.ts：用户模块定义。
      • user.service.ts：用户服务。
      • user.controller.ts：用户控制器。
  • entities/：实体类目录。
    • user.entity.ts：用户实体类。
• test/：测试文件目录。
• .env.example：环境变量示例文件。
• .gitignore：Git忽略文件配置。
• package.json：项目依赖和脚本配置。
• tsconfig.json：TypeScript配置文件。
• nest-cli.json：Nest CLI配置文件。
• README.md：项目说明文档。

2. 项目的启动文件介绍

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();

• main.ts 是 NestJS 应用程序的入口文件。
• 使用 NestFactory.create 方法创建应用程序实例。
• 调用 app.listen 方法启动服务器，监听端口 3000。

3. 项目的配置文件介绍

.env.example

DB_HOST=localhost
DB_PORT=3306
DB_USERNAME=root
DB_PASSWORD=password
DB_DATABASE=nestjs_project_demo

• .env.example 是环境变量示例文件，用于配置数据库连接等信息。

config.module.ts

import { Module } from '@nestjs/common';
import { ConfigService } from './config.service';

@Module({
  providers: [ConfigService],
  exports: [ConfigService],
})
export class ConfigModule {}

• config.module.ts 定义了配置模块，提供 ConfigService。

config.service.ts

import { Injectable } from '@nestjs/common';
import * as dotenv from 'dotenv';

@Injectable()
export class ConfigService {
  private readonly envConfig: { [key: string]: string };

  constructor() {
    const result = dotenv.config();
    if (result.error) {
      this.envConfig = process.env;
    } else {
      this.envConfig = result.parsed;
    }
  }

  get(key: string): string {
    return this.envConfig[key];
  }
}

• config.service.ts 提供了读取环境变量的服务。
• 使用 dotenv 库加载 .env 文件中的配置。
• 提供 get 方法获取配置项。

以上是 NestjsProjectDemo 项目的基本教程，涵盖了项目的目录结构、启动文件和配置文件