Nest.js 是一个用于构建高效、可靠和可扩展的服务器端应用程序的框架。它建立在 Express 之上,并利用了 TypeScript 的强大功能。本指南将带你了解如何创建你的第一个 Nest.js 应用程序。
环境准备
在开始之前,请确保你的开发环境中安装了以下软件:
- Node.js(版本 10.x 或更高)
- npm 或 yarn(作为包管理器)
- 一个代码编辑器(如 Visual Studio Code)
创建新的 Nest.js 应用程序
-
初始化一个新的 Nest.js 项目:
打开终端或命令提示符,并运行以下命令来创建一个新的 Nest.js 项目:
npx create-nest-app my-nest-app
这里
my-nest-app
是你的项目名称,你可以根据需要更改它。 -
进入项目目录:
创建项目后,进入项目目录:
cd my-nest-app
-
安装依赖:
使用 npm 或 yarn 安装项目依赖:
npm install # 或者 yarn
了解 Nest.js 应用程序结构
在项目目录中,你会看到以下文件和文件夹:
src
:包含应用程序的所有源代码。main.ts
:应用程序的入口点。app.module.ts
:根模块,定义了应用程序的结构。app.controller.ts
和app.service.ts
:示例控制器和服务。
package.json
和package-lock.json
:定义了项目的依赖和脚本。tsconfig.json
:TypeScript 编译器的配置文件。nest-cli.json
:Nest CLI 配置文件。
运行你的 Nest.js 应用程序
-
启动开发服务器:
使用以下命令启动 Nest.js 的热重载开发服务器:
npm run start:dev # 或者 yarn start:dev
-
查看应用程序:
打开浏览器并访问
http://localhost:3000
。你应该能看到 Nest.js 欢迎页面。
创建你的第一个控制器和路由
-
生成一个新的控制器:
使用 Nest CLI 生成一个新的控制器:
npx nest g controller hello
这将创建一个名为
HelloController
的新控制器。 -
添加一个新的路由:
在
hello.controller.ts
文件中,添加一个新的路由:import { Controller, Get } from '@nestjs/common'; @Controller('hello') export class HelloController { @Get() getHello(): string { return 'Hello World!'; } }
这段代码创建了一个简单的 GET 路由,当访问
/hello
时,它将返回 “Hello World!”。 -
重新启动开发服务器:
如果你之前已经启动了开发服务器,你需要重新启动它以查看更改:
npm run start:dev # 或者 yarn start:dev
-
测试你的路由:
再次打开浏览器并访问
http://localhost:3000/hello
。你应该会看到 “Hello World!” 的消息。
结论
恭喜!你已经成功创建并运行了你的第一个 Nest.js 应用程序,并添加了你的第一个路由。Nest.js 提供了许多其他功能,如依赖注入、中间件、守卫、管道等,这些都是构建复杂和可扩展应用程序的重要工具。随着你对 Nest.js 的进一步学习,你将能够利用这些功能来构建强大的服务器端应用程序。