NestJS + Zod 项目教程

NestJS + Zod 项目教程

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

nestjs-zod/
├── src/
│   ├── auth/
│   │   ├── auth.controller.ts
│   │   ├── auth.service.ts
│   │   └── auth.module.ts
│   ├── common/
│   │   ├── pipes/
│   │   │   └── zod-validation.pipe.ts
│   │   └── guards/
│   │       └── zod.guard.ts
│   ├── main.ts
│   ├── app.module.ts
│   └── config/
│       └── app.config.ts
├── test/
│   └── app.e2e-spec.ts
├── .eslintrc.js
├── .gitignore
├── package.json
├── tsconfig.json
└── README.md

目录结构介绍

• src/: 项目的源代码目录。
  • auth/: 包含认证相关的控制器、服务和模块。
    • auth.controller.ts: 认证控制器，处理认证相关的请求。
    • auth.service.ts: 认证服务，处理认证逻辑。
    • auth.module.ts: 认证模块，注册认证相关的控制器和服务。
  • common/: 包含通用的管道和守卫。
    • pipes/: 包含自定义的 Zod 验证管道。
      • zod-validation.pipe.ts: 使用 Zod 进行数据验证的管道。
    • guards/: 包含自定义的 Zod 守卫。
      • zod.guard.ts: 使用 Zod 进行数据验证的守卫。
  • main.ts: 项目的启动文件。
  • app.module.ts: 应用的主模块，注册所有子模块。
  • config/: 包含项目的配置文件。
    • app.config.ts: 应用的配置文件，包含环境变量和其他配置项。
• test/: 包含项目的端到端测试文件。
  • app.e2e-spec.ts: 端到端测试文件。
• .eslintrc.js: ESLint 配置文件，用于代码风格检查。
• .gitignore: Git 忽略文件配置。
• package.json: 项目的依赖和脚本配置。
• tsconfig.json: TypeScript 配置文件。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

main.ts

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { ZodValidationPipe } from './common/pipes/zod-validation.pipe';

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

启动文件介绍

• NestFactory.create(AppModule): 创建 NestJS 应用实例，传入主模块 AppModule。
• app.useGlobalPipes(new ZodValidationPipe()): 全局注册 Zod 验证管道，用于验证所有传入的请求数据。
• app.listen(3000): 启动应用，监听 3000 端口。

3. 项目的配置文件介绍

app.config.ts

import { registerAs } from '@nestjs/config';

export default registerAs('app', () => ({
  port: process.env.PORT || 3000,
  database: {
    host: process.env.DATABASE_HOST || 'localhost',
    port: process.env.DATABASE_PORT || 5432,
  },
}));

配置文件介绍

• registerAs('app', () => ({ ... })): 使用 @nestjs/config 模块注册应用配置。
• port: 应用的监听端口，默认值为 3000。
• database: 数据库配置。
  • host: 数据库主机地址，默认值为 localhost。
  • port: 数据库端口，默认值为 5432。

通过以上配置文件，可以在应用中轻松访问这些配置项，例如：

import { ConfigService } from '@nestjs/config';

@Injectable()
export class AppService {
  constructor(private configService: ConfigService) {}

  getPort(): number {
    return this.configService.get<number>('app.port');
  }
}

这样，AppService 可以通过 ConfigService 获取应用的端口配置。