Nestjs中文文档(一)
nestjs原中文文档缺少太多 故有此系列。直接对比nestjs英文网站翻译,先机翻再推敲, 一个模块一个章节
版本: 6.10.14
首次安装
在这组文章中,您将学习Nest的核心基础知识。为了熟悉Nest应用程序的基本构建块,我们将构建一个基本的CRUD应用程序,它的特性在入门级涵盖了很多方面
语言
我们喜欢使用typescript,但是我们更喜欢nodejs!,这就是为什么nestjs会兼容typescript和纯javascript.
nestjs主要使用typescript
作为主力开发语言,您不用特意学习它,因为它真的和es6
很像,您可以在模仿过程中逐渐了解到typescript
.nestjs主要借鉴了angular,而angular借鉴了spring,所以有angular或者java开发经验将会变得更加容易。
开始
使用Nest CLI设置新项目非常简单。安装了npm后,可以在OS终端中使用以下命令创建新的Nest项目
$ npm i -g @nestjs/cli
$ nest new project-name
将创建项目目录,安装节点模块和其他几个样板文件,并创建一个src/目录,并用几个核心文件填充,结构如下:
src
---app.controller.ts
---app.module.ts
---main.ts
以下是这些核心文件的简要概述
文件名 | 描述 |
---|---|
app.module.ts | 项目的根模块 |
app.controller.ts | 一个基本的控制器 |
main.ts | 使用核心函数NestFactory创建Nest应用程序实例的应用程序的入口文件 |
main.ts
包含一个异步函数,它将引导整个Nest程序
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
async function bootstrap() {
const app = await NestFactory.create(AppModule);
await app.listen(3000);
}
bootstrap();
要创建一个Nest应用程序实例,我们使用核心NestFactory
类。NestFactory
公开了一些允许创建应用程序实例的静态方法。这个create()
方法返回一个application对象,该对象实现了INestApplication
接口,现在只需要监听3000端口,等待http请求即可。
注意,使用Nest CLI构建的项目会创建一个初始的项目结构,我们鼓励开发者们将模块module放到自己的专用目录中去。
平台
Nest的目标是成为一个平台无关的框架。平台独立性使得创建可重用的逻辑部件成为可能,开发人员可以跨多种不同类型的应用程序利用这些逻辑部件。从技术上讲,一旦创建了适配器,Nest就可以使用任何Node HTTP框架。有两个现成支持的HTTP平台:express
和fastfy
。你可以选择最适合你需要的
平台 | 描述 |
---|---|
express | Express是一个在nodejs中最著名的极简web框架。这是一个经过时间检验,生产完备的库,有很多社区实现的资源。默认情况下使用@nestjs/platform express包。许多用户都能很好地使用Express,无需采取任何措施即可启用它。 |
fastify | fastify 是一个高性能和低开销的框架,高度集中于提供最大的效率和速度。可以在搜索引擎中了解它。 |
无论使用哪个平台,它都会公开自己的应用程序接口。分别为NestExpressApplication
和nestFastFyApplication
当您将类型传递给NestFactory.create()方法时,如下面的示例所示,app对象将具有专门用于该特定平台的方法。但是,请注意,您不需要指定平台类型(express或fastify),除非您真正想访问底层平台API。
const app = await NestFactory.create<NestExpressApplication>(AppModule);
运行
安装过程完成后,可以在操作系统命令提示符下运行以下命令
$ npm run start
此命令通过HTTP服务器监听src/main.ts文件中定义的端口来启动应用程序,应用程序运行后,打开浏览器并导航到http://localhost:3000/。你应该看到了hello world!
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。