译自:https://docs.nestjs.com/first-steps。
在本系列文章中,您将学习Nest的核心基础知识。为了熟悉Nest应用程序的基本构建块,我们将构建一个基本的CRUD应用程序,它的特性涵盖了入门级的很多内容。
语言
我们热爱TypeScript,但最重要的是,我们热爱Node.js。这就是为什么Nest兼容TypeScript和纯JavaScript。Nest利用了最新的语言特性,因此要将其与普通JavaScript一起使用,我们需要一个Babel编译器。
在我们提供的示例中,我们将主要使用TypeScript,但是您总是可以将代码片段切换为普通的JavaScript语法(只需单击每个代码片段的右上角的language按钮)。
要求
请确保您的操作系统上安装了Node.js(>= 8.9.0)。
设置
使用Nest CLI设置新项目非常简单。安装了npm后,您可以在OS终端中使用以下命令创建一个新的Nest项目:
$ npm i -g @nestjs/cli
$ nest new project-name
将创建project目录,安装节点模块和其他一些样板文件,并创建一个src/目录,并用几个核心文件填充。
以下是这些核心文件的简要概述:
文件 | 说明 |
---|---|
app.controller.ts | 有一个单一路由的基本控制器样本。 |
app.module.ts | 应用程序的根模块。 |
main.ts | 应用程序的入口文件,它使用核心函数NestFactory创建一个Nest应用程序实例。 |
main.ts包含一个异步函数,它将启动我们的应用程序:
import { NestFactory } from '@nestjs/core';
import { ApplicationModule } from './app.module';
async function bootstrap() {
const app = await NestFactory.create(ApplicationModule);
await app.listen(3000);
}
bootstrap();
要创建一个Nest应用程序实例,我们使用核心NestFactory类。NestFactory公开了一些静态方法,这些方法允许创建应用程序实例。create()方法返回一个应用程序对象,该对象填充INestApplication接口。这个对象提供了一组方法,这些方法将在下一章中描述。在上面的main.ts示例中,我们简单地启动HTTP侦听器,让应用程序等待入站HTTP请求。
请注意,使用Nest CLI构建的项目创建了一个初始项目结构,该结构鼓励开发人员遵循将每个模块保存在其专用目录中的约定。
平台
Nest的目标是成为一个平台无关的框架。平台独立性使得创建可重用逻辑部件成为可能,开发人员可以跨几种不同类型的应用程序利用这些逻辑部件。从技术上讲,一旦创建了适配器,Nest就可以使用任何节点HTTP框架。有两种HTTP平台支持开箱即用:express和fastify。你可以选择最适合你需要的。
平台 | 描述 |
---|---|
platform-express | Express是一个著名的用于node的极简web框架。这是一个经过测试的、可生产的库,社区提供了大量的资源。默认情况下使用@nestjs/platform-express包。许多用户都很好地使用了Express,不需要采取任何行动来启用它。 |
platform-fastify | Fastify是一个高性能、低开销的框架,高度专注于提供最大的效率和速度。在这里阅读如何使用它。 |
无论使用哪种平台,它都公开自己的应用程序接口。它们分别被看作NestExpressApplication和NestFastifyApplication。
当您将一个类型传递给NestFactory.create()方法(如下面的示例所示)时,app对象将拥有专门针对该特定平台的方法。但是,请注意,除非您确实想访问底层平台API,否则不需要指定类型。
const app = await NestFactory.create<NestExpressApplication>(ApplicationModule);
运行应用程序
安装过程完成后,可以在OS命令提示符下运行以下命令,启动应用程序侦听HTTP请求:
$ npm run start
该命令启动应用程序,HTTP服务器监听src/main.ts中定义的端口文件。应用程序运行后,打开浏览器并导航到http://localhost:3000/。你应该看看Hello world!消息。