返回

NestJS 从入门到精通:全面解析目录结构和 Hello World

前端

NestJS 初始化后的目录结构

初始化 NestJS 项目后,项目根目录下会出现以下文件和文件夹:

  • package.json :包含项目依赖项和配置信息。
  • nest-cli.json :NestJS CLI 工具的配置文件。
  • README.md :项目的自述文件。
  • tsconfig.json :TypeScript 配置文件。
  • node_modules :Node.js 模块文件夹,包含项目依赖项。
  • src :NestJS 应用代码文件夹。

src 文件夹

src 文件夹是 NestJS 应用的主要代码文件夹,包含以下子文件夹和文件:

  • app.controller.spec.ts :app.controller.ts 的测试文件。
  • app.controller.ts :应用程序控制器,负责处理 HTTP 请求和响应。
  • app.module.ts :应用程序模块,定义应用程序的组件和依赖关系。
  • app.service.spec.ts :app.service.ts 的测试文件。
  • app.service.ts :应用程序服务,用于业务逻辑。
  • main.ts :应用程序入口文件,用于启动 NestJS 应用程序。

编写 Hello World 程序

在 app.controller.ts 文件中,添加以下代码:

import { Controller, Get } from '@nestjs/common';

@Controller()
export class AppController {
  @Get()
  getRoot(): string {
    return 'Hello, World!';
  }
}

代码解析

  • @Controller() 装饰器表示这是一个控制器类,用于处理 HTTP 请求。
  • @Get() 装饰器表示该方法是一个 GET 请求处理程序,用于处理 GET 请求。
  • getRoot() 方法是请求处理程序,当收到 GET 请求时,它返回 "Hello, World!"。

运行程序

在终端中运行以下命令启动 NestJS 应用程序:

npm run start

浏览器中访问 http://localhost:3000 即可看到 "Hello, World!" 输出。

总结

本文全面解析了 NestJS 初始化后的目录结构,并展示了如何编写一个简单的 "Hello World" 程序。通过了解目录结构和基础代码,你将为探索 NestJS 框架打下坚实的基础。