NestJS入门教程—03.初始化目录介绍和HelloWorld

上节课我们使用NestJS CLI ，在D盘根目录，创建了一个nestjs-demo的新项目，这节主要任务是带大家看一下初始化项目的目录结构是怎么样的，每个文件的作用是什么。然后给大家展示一下HelloWorld的页面。

初始化目录文件说明

先来看一下用NestJS CLI 工具生成项目后有哪些文件。我们要了解文件，知道每个文件的作用。这对以后编写项目和看别人的开源项目非常有帮助。

+-- dist[目录]                      // 编译后的目录，用于预览项目
+-- node_modules[目录]              // 项目使用的包目录，开发使用和上线使用的都在里边
+-- src[目录]                       // 源文件/代码，程序员主要编写的目录
|  +-- app.controller.spec.ts      // 对于基本控制器的单元测试样例
|  +-- app.controller.ts           // 控制器文件，可以简单理解为路由文件
|  +-- app.module.ts               // 模块文件，在NestJS世界里主要操作的就是模块
|  +-- app.service.ts              // 服务文件，提供的服务文件，业务逻辑编写在这里
|  +-- app.main.ts                 // 项目的入口文件，里边包括项目的主模块和监听端口号
+-- test[目录]                      // 测试文件目录，对项目测试时使用的目录，比如单元测试...
|  +-- app.e2e-spec.ts             // e2e测试，端对端测试文件，测试流程和功能使用
|  +-- jest-e2e.json               // jest测试文件，jset是一款简介的JavaScript测试框架
+-- .eslintrc.js                   // ESlint的配置文件
+-- .gitignore                     // git的配置文件，用于控制哪些文件不受Git管理
+-- .prettierrc                    // prettier配置文件，用于美化/格式化代码的
+-- nest-cli.json                  // 整个项目的配置文件，这个需要根据项目进行不同的配置
+-- package-lock.json              // 防止由于包不同，导致项目无法启动的配置文件，固定包版本
+-- package.json                   // 项目依赖包管理文件和Script文件，比如如何启动项目的命令
+-- README.md                      // 对项目的描述文件，markdown语法
+-- tsconfig.build.json            // TypeScript语法构建时的配置文件
+-- tsconfig.json                  // TypeScript的配置文件，控制TypeScript编译器的一些行为

src目录下的文件说明

src目录是日常工作编写代码的主要目录，从基本的目录结构也可以对NestJS编写模式有很好的了解。

+-- src[目录]                       // 源文件/代码，程序员主要编写的目录
|  +-- app.controller.spec.ts      // 对于基本控制器的单元测试样例
|  +-- app.controller.ts           // 控制器文件，可以简单理解为路由文件
|  +-- app.module.ts               // 模块文件，在NestJS世界里主要操作的就是模块
|  +-- app.service.ts              // 服务文件，提供的服务文件，业务逻辑编写在这里
|  +-- app.main.ts                 // 项目的入口文件，里边包括项目的主模块和监听端口号

三种项目启动脚本说明

当掌握了NestJS的基本目录和文件作用后，还需要对启动命令进行了解。打开package.json 文件，可以看到下面的代码。

"start": "nest start",                              // 最常用的开始模式
"start:dev": "nest start --watch",                  // 开发模式的启动 有监视功能
"start:debug": "nest start --debug --watch",        // 调试Bug时的启动 调试程序时使用

对启动脚本了解后，我们启动一下项目。打开终端（ctrl+shift+）, 输入npm run start:dev`启动项目。

HelloWorld程序的编写

当项目启动后，我们如何访问到这个项目那？打开/src/main.ts 文件，可以看到监听的是3000端口，这时候在浏览器地址栏中输入http://localhost:3000 就可以访问HelloWorld的程序了。

你也可以打开/src/app.service.ts文件，把里边的Hello World改为hello JSPang,然后再刷新浏览器看看结果。

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

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

好了，这就是本节课的内容了。本节主要讲解了NestJS CLI生成项目的初始目录的结构和每个文件的作用，也简单演示了一下如何访问程序和修改HelloWorld页面。希望小伙伴们都动起来，和我一起学习。