小满nestjs（第六章 CLI实战：从零到一构建项目骨架）

1. 为什么需要NestJS CLI？

刚开始接触NestJS时，我完全手动创建过项目。结果花了一整天时间配置各种依赖和目录结构，最后发现连热更新都没搞定。后来发现NestJS CLI只需要一条命令就能解决所有问题，真是后悔没早点用。

CLI工具就像是一个经验丰富的项目架构师。它知道：

• 标准的项目目录应该怎么组织
• 需要安装哪些核心依赖
• 如何配置TypeScript编译选项
• 怎样设置开发和生产环境的不同启动脚本

手动创建项目最大的问题是容易遗漏关键配置。比如有一次我忘记配置tsconfig.json中的experimentalDecorators，导致所有装饰器语法都报错，排查了半天才发现问题。而CLI生成的项目从一开始就规避了这些坑。

2. 快速创建你的第一个NestJS项目

2.1 环境准备

首先确保你的开发环境已经安装：

• Node.js (建议16.x或18.x LTS版本)
• npm或yarn包管理器
• 推荐使用VS Code作为IDE

安装NestJS CLI全局工具：

npm install -g @nestjs/cli

验证安装是否成功：

nest --version

2.2 项目初始化

创建新项目有两种方式：

1. 交互式创建（推荐新手）：

nest new

CLI会询问项目名称、包管理器选择等信息

2. 直接创建：

nest new my-project

我更喜欢加上--strict参数启用TypeScript严格模式：

nest new my-project --strict

2.3 项目结构解析

生成的项目包含以下核心目录和文件：

my-project/ ├── src/ │ ├── app.controller.ts │ ├── app.module.ts │ ├── app.service.ts │ └── main.ts ├── test/ ├── nest-cli.json ├── package.json ├── tsconfig.json └── README.md

其中nest-cli.json是CLI的配置文件，可以自定义：

• 源代码目录
• 编译输出目录
• 生成文件的模板等

3. CLI生成的核心文件详解

3.1 入口文件main.ts

这个文件相当于Vue项目的main.js，是应用的启动入口：

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()方法会：

1. 创建Nest应用实例
2. 初始化所有模块依赖
3. 设置全局管道、过滤器、拦截器等

我经常在这里添加全局中间件：

app.use(loggerMiddleware);

3.2 控制器(Controller)

生成的app.controller.ts演示了最基本的REST端点：

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

实际项目中我通常会：

1. 添加路由前缀：

@Controller('api')

2. 使用DTO验证请求参数
3. 添加Swagger文档装饰器

3.3 服务(Service)

app.service.ts是业务逻辑的存放地：

import { Injectable } from '@nestjs/common'; @Injectable() export class AppService { getHello(): string { return 'Hello World!'; } }

@Injectable()装饰器让这个类可以被依赖注入系统管理。我在这里通常会：

• 连接数据库
• 调用外部API
• 实现核心业务逻辑

4. CLI的高级用法

4.1 生成新模块

开发中我经常需要添加新功能模块：

nest generate module users nest generate controller users nest generate service users

更简洁的写法：

nest g mo users nest g co users nest g s users

4.2 自定义模板

CLI允许修改生成文件的模板。在项目根目录创建template文件夹，然后修改nest-cli.json：

{ "generateOptions": { "spec": false, "template": "./template" } }

我通常会自定义：

• 添加统一的版权注释
• 预置常用的导入语句
• 设置默认的类命名规范

4.3 项目构建与部署

CLI内置了构建命令：

nest build

这会：

1. 编译TypeScript代码
2. 输出到dist目录
3. 保留所有非TS资源文件

生产环境启动：

npm run start:prod

我通常会配合PM2进行进程管理：

pm2 start dist/main.js --name my-nest-app

5. 常见问题与解决方案

5.1 热更新失效

如果发现修改代码后没有自动重新编译：

1. 检查是否运行的是start:dev脚本
2. 确保没有手动修改node_modules
3. 尝试删除.cache文件夹后重启

5.2 依赖注入错误

遇到Nest can't resolve dependencies错误时：

1. 检查相关Provider是否添加了@Injectable()
2. 确认模块中正确导入了所有依赖
3. 查看循环依赖问题

5.3 性能优化建议

对于大型项目：

1. 启用--webpack标志加速热更新

nest start --watch --webpack

2. 使用SWC替代TypeScript编译器
3. 合理使用懒加载模块

从手动创建到CLI工具，我节省了至少70%的项目初始化时间。特别是在团队协作时，CLI确保所有人的项目结构保持一致，减少了大量沟通成本。当你熟悉基础用法后，可以进一步探索nest-cli.json的配置选项，打造更适合自己团队的开发工作流