NestJS项目结构解析 #

hello-nest/
├── node_modules/          # 依赖包
├── src/                   # 源代码目录
│   ├── app.controller.spec.ts  # 控制器单元测试
│   ├── app.controller.ts       # 根控制器
│   ├── app.module.ts           # 根模块
│   ├── app.service.ts          # 根服务
│   └── main.ts                 # 应用入口
├── test/                  # E2E测试目录
│   ├── app.e2e-spec.ts    # E2E测试文件
│   └── jest-e2e.json      # Jest E2E配置
├── .eslintrc.js           # ESLint配置
├── .gitignore             # Git忽略文件
├── .prettierrc            # Prettier配置
├── nest-cli.json          # Nest CLI配置
├── package.json           # 项目配置
├── tsconfig.build.json    # TypeScript构建配置
└── tsconfig.json          # TypeScript配置

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

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

import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';

@Module({
  imports: [],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

import { Controller, Get } from '@nestjs/common';
import { AppService } from './app.service';

@Controller()
export class AppController {
  constructor(private readonly appService: AppService) {}

  @Get()
  getHello(): string {
    return this.appService.getHello();
  }
}

import { Injectable } from '@nestjs/common';

@Injectable()
export class AppService {
  getHello(): string {
    return 'Hello World!';
  }
}

src/
├── main.ts                    # 应用入口
├── app.module.ts              # 根模块
│
├── common/                    # 公共模块
│   ├── decorators/            # 自定义装饰器
│   │   └── current-user.decorator.ts
│   ├── filters/               # 异常过滤器
│   │   └── http-exception.filter.ts
│   ├── guards/                # 守卫
│   │   └── jwt-auth.guard.ts
│   ├── interceptors/          # 拦截器
│   │   └── logging.interceptor.ts
│   ├── interfaces/            # 公共接口
│   │   └── response.interface.ts
│   ├── middleware/            # 中间件
│   │   └── logger.middleware.ts
│   ├── pipes/                 # 管道
│   │   └── validation.pipe.ts
│   └── common.module.ts       # 公共模块
│
├── config/                    # 配置文件
│   ├── database.config.ts
│   ├── jwt.config.ts
│   └── configuration.ts
│
├── modules/                   # 功能模块
│   ├── auth/                  # 认证模块
│   │   ├── auth.controller.ts
│   │   ├── auth.module.ts
│   │   ├── auth.service.ts
│   │   ├── dto/
│   │   │   ├── login.dto.ts
│   │   │   └── register.dto.ts
│   │   ├── strategies/
│   │   │   └── jwt.strategy.ts
│   │   └── interfaces/
│   │       └── jwt-payload.interface.ts
│   │
│   ├── users/                 # 用户模块
│   │   ├── users.controller.ts
│   │   ├── users.module.ts
│   │   ├── users.service.ts
│   │   ├── entities/
│   │   │   └── user.entity.ts
│   │   ├── dto/
│   │   │   ├── create-user.dto.ts
│   │   │   └── update-user.dto.ts
│   │   └── interfaces/
│   │       └── user.interface.ts
│   │
│   └── products/              # 产品模块
│       ├── products.controller.ts
│       ├── products.module.ts
│       ├── products.service.ts
│       └── ...
│
├── entities/                  # 全局实体
│   └── base.entity.ts
│
└── database/                  # 数据库配置
    ├── migrations/            # 迁移文件
    └── seeds/                 # 种子数据

users/
├── users.module.ts           # 模块定义
├── users.controller.ts       # 控制器
├── users.controller.spec.ts  # 控制器测试
├── users.service.ts          # 服务
├── users.service.spec.ts     # 服务测试
├── entities/                 # 数据实体
│   └── user.entity.ts
├── dto/                      # 数据传输对象
│   ├── create-user.dto.ts
│   └── update-user.dto.ts
├── interfaces/               # 接口定义
│   └── user.interface.ts
├── schemas/                  # MongoDB Schema
│   └── user.schema.ts
├── repositories/             # 仓库层
│   └── users.repository.ts
├── constants/                # 常量
│   └── users.constants.ts
└── utils/                    # 工具函数
    └── users.utils.ts

{
  "$schema": "https://json.schemastore.org/nest-cli",
  "collection": "@nestjs/schematics",
  "sourceRoot": "src",
  "compilerOptions": {
    "deleteOutDir": true
  }
}

{
  "compilerOptions": {
    "module": "commonjs",
    "declaration": true,
    "removeComments": true,
    "emitDecoratorMetadata": true,
    "experimentalDecorators": true,
    "allowSyntheticDefaultImports": true,
    "target": "ES2021",
    "sourceMap": true,
    "outDir": "./dist",
    "baseUrl": "./",
    "incremental": true,
    "skipLibCheck": true,
    "strictNullChecks": true,
    "noImplicitAny": true,
    "strictBindCallApply": true,
    "forceConsistentCasingInFileNames": true,
    "noFallthroughCasesInSwitch": true
  }
}

{
  "name": "hello-nest",
  "version": "0.0.1",
  "description": "",
  "author": "",
  "private": true,
  "license": "UNLICENSED",
  "scripts": {
    "build": "nest build",
    "start": "nest start",
    "start:dev": "nest start --watch",
    "start:debug": "nest start --debug --watch",
    "start:prod": "node dist/main",
    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
    "test": "jest",
    "test:watch": "jest --watch",
    "test:cov": "jest --coverage",
    "test:e2e": "jest --config ./test/jest-e2e.json"
  }
}

# 生成模块
nest g module users

# 生成控制器
nest g controller users

# 生成服务
nest g service users

# 同时生成模块、控制器、服务
nest g resource users

# 生成守卫
nest g guard auth/jwt

# 生成拦截器
nest g interceptor logging

# 生成过滤器
nest g filter http-exception

# 生成管道
nest g pipe validation

# 生成装饰器
nest g decorator current-user

# 生成中间件
nest g middleware logger

# 不生成测试文件
nest g service users --no-spec

# 注册到指定模块
nest g controller users --module app

Controller → Service → Repository → Database
   ↓           ↓
  DTO        Entity

@Module({
  imports: [TypeOrmModule.forFeature([User])],
  controllers: [UsersController],
  providers: [UsersService],
  exports: [UsersService],  // 导出供其他模块使用
})
export class UsersModule {}