环境搭建

class Nest.js

1. 安装Node.js

在安装Nest.js之前,需要确保你的开发环境中已经安装了Node.js。可以按照以下步骤进行安装:

  • Windows/macOS

    1. 前往 Node.js官方网站
    2. 下载适合你操作系统的最新LTS版本(长期支持版本)。
    3. 按照安装程序的指示完成安装。
  • Linux
    可以通过包管理器安装,例如在Ubuntu上:

    sudo apt update
    sudo apt install nodejs npm
    
  • 验证安装
    安装完成后,可以通过以下命令验证Node.js和npm的安装:

    node -v
    npm -v
    

2. 创建Nest.js项目

安装完Node.js后,可以使用Nest CLI工具快速创建一个新的Nest.js项目。

  • 安装Nest CLI
    打开终端并运行以下命令:

    npm i -g @nestjs/cli
    
  • 创建新项目
    使用以下命令创建一个新的Nest.js项目(将my-nest-app替换为你的项目名称):

    nest new my-nest-app
    

    在创建过程中,CLI会询问你选择包管理器(npm或yarn),选择适合你的选项即可。

  • 进入项目目录

    cd my-nest-app
    
  • 启动开发服务器
    使用以下命令启动Nest.js开发服务器:

    npm run start
    

    默认情况下,服务器将运行在 http://localhost:3000

3. 项目结构解析

创建完成后,Nest.js项目的基本结构如下:

my-nest-app
├── src
│   ├── app.controller.ts      // 控制器,处理请求
│   ├── app.controller.spec.ts  // 控制器的测试文件
│   ├── app.module.ts           // 应用的根模块
│   ├── app.service.ts          // 服务,包含业务逻辑
│   ├── app.service.spec.ts      // 服务的测试文件
│   └── main.ts                 // 应用的入口文件
├── test                        // 测试文件夹
│   └── app.e2e-spec.ts        // 端到端测试文件
├── node_modules               // 依赖包
├── package.json                // 项目配置文件
├── tsconfig.json              // TypeScript配置文件
├── jest.config.js             // Jest配置文件
└── README.md                  // 项目的说明文件

4. 项目结构详细说明

  • src:项目源代码目录,包含应用的主要代码。

    • app.controller.ts:定义了应用的控制器,负责处理HTTP请求。
    • app.module.ts:应用的根模块,将各个部分组合在一起。
    • app.service.ts:定义服务,包含业务逻辑并可以被控制器调用。
    • main.ts:应用的入口文件,启动Nest.js应用。
  • test:存放测试代码的文件夹,包含单元测试和端到端测试。

  • node_modules:存放项目依赖的文件夹。

  • package.json:项目配置文件,包含项目的依赖、脚本和其他配置信息。

  • tsconfig.json:TypeScript的配置文件,包含编译选项和文件路径等信息。

  • jest.config.js:Jest测试框架的配置文件。

  • README.md:项目的说明文件,通常包含项目介绍、安装和使用指南。

完整项目结构示例

下面是一个包含更多功能的示例项目结构,展示如何扩展Nest.js项目:

my-nest-app
├── src
│   ├── app.controller.ts
│   ├── app.controller.spec.ts
│   ├── app.module.ts
│   ├── app.service.ts
│   ├── app.service.spec.ts
│   ├── main.ts
│   ├── users
│   │   ├── users.controller.ts   // 用户相关的控制器
│   │   ├── users.service.ts      // 用户相关的服务
│   │   ├── users.module.ts       // 用户模块
│   │   └── dto                   // 数据传输对象
│   │       └── create-user.dto.ts
│   ├── auth
│   │   ├── auth.controller.ts    // 认证相关的控制器
│   │   ├── auth.service.ts       // 认证相关的服务
│   │   └── auth.module.ts        // 认证模块
│   ├── database
│   │   ├── database.module.ts    // 数据库模块
│   │   └── entities               // 实体定义
│   │       └── user.entity.ts
├── test
│   └── app.e2e-spec.ts
├── node_modules
├── package.json
├── tsconfig.json
├── jest.config.js
└── README.md

总结

通过上述步骤,你可以成功搭建Nest.js开发环境,并理解项目的基本结构和组成部分。随着项目的发展,可以根据需求添加新的模块和功能,构建更复杂的应用。

评论区
评论列表
menu