譯自:https://docs.nestjs.com/first-steps膝蜈。
在本系列文章中锅移,您將學(xué)習(xí)Nest的核心基礎(chǔ)知識(shí)。為了熟悉Nest應(yīng)用程序的基本構(gòu)建塊饱搏,我們將構(gòu)建一個(gè)基本的CRUD應(yīng)用程序非剃,它的特性涵蓋了入門級(jí)的很多內(nèi)容。
語言
我們熱愛TypeScript推沸,但最重要的是备绽,我們熱愛Node.js。這就是為什么Nest兼容TypeScript和純JavaScript鬓催。Nest利用了最新的語言特性肺素,因此要將其與普通JavaScript一起使用,我們需要一個(gè)Babel編譯器宇驾。
在我們提供的示例中压怠,我們將主要使用TypeScript,但是您總是可以將代碼片段切換為普通的JavaScript語法(只需單擊每個(gè)代碼片段的右上角的language按鈕)飞苇。
要求
請(qǐng)確保您的操作系統(tǒng)上安裝了Node.js(>= 8.9.0)。
設(shè)置
使用Nest CLI設(shè)置新項(xiàng)目非常簡單蜗顽。安裝了npm后布卡,您可以在OS終端中使用以下命令創(chuàng)建一個(gè)新的Nest項(xiàng)目:
$ npm i -g @nestjs/cli
$ nest new project-name
將創(chuàng)建project目錄,安裝節(jié)點(diǎn)模塊和其他一些樣板文件雇盖,并創(chuàng)建一個(gè)src/目錄忿等,并用幾個(gè)核心文件填充。
以下是這些核心文件的簡要概述:
文件 | 說明 |
---|---|
app.controller.ts | 有一個(gè)單一路由的基本控制器樣本崔挖。 |
app.module.ts | 應(yīng)用程序的根模塊贸街。 |
main.ts | 應(yīng)用程序的入口文件,它使用核心函數(shù)NestFactory創(chuàng)建一個(gè)Nest應(yīng)用程序?qū)嵗?/td> |
main.ts包含一個(gè)異步函數(shù)狸相,它將啟動(dòng)我們的應(yīng)用程序:
import { NestFactory } from '@nestjs/core';
import { ApplicationModule } from './app.module';
async function bootstrap() {
const app = await NestFactory.create(ApplicationModule);
await app.listen(3000);
}
bootstrap();
要?jiǎng)?chuàng)建一個(gè)Nest應(yīng)用程序?qū)嵗Ψ耍覀兪褂煤诵?strong>NestFactory類。NestFactory公開了一些靜態(tài)方法脓鹃,這些方法允許創(chuàng)建應(yīng)用程序?qū)嵗?strong>create()方法返回一個(gè)應(yīng)用程序?qū)ο笠菁猓搶?duì)象填充INestApplication接口。這個(gè)對(duì)象提供了一組方法瘸右,這些方法將在下一章中描述娇跟。在上面的main.ts示例中,我們簡單地啟動(dòng)HTTP偵聽器太颤,讓應(yīng)用程序等待入站HTTP請(qǐng)求苞俘。
請(qǐng)注意,使用Nest CLI構(gòu)建的項(xiàng)目創(chuàng)建了一個(gè)初始項(xiàng)目結(jié)構(gòu)龄章,該結(jié)構(gòu)鼓勵(lì)開發(fā)人員遵循將每個(gè)模塊保存在其專用目錄中的約定吃谣。
平臺(tái)
Nest的目標(biāo)是成為一個(gè)平臺(tái)無關(guān)的框架乞封。平臺(tái)獨(dú)立性使得創(chuàng)建可重用邏輯部件成為可能,開發(fā)人員可以跨幾種不同類型的應(yīng)用程序利用這些邏輯部件基协。從技術(shù)上講歌亲,一旦創(chuàng)建了適配器,Nest就可以使用任何節(jié)點(diǎn)HTTP框架澜驮。有兩種HTTP平臺(tái)支持開箱即用:express和fastify陷揪。你可以選擇最適合你需要的。
平臺(tái) | 描述 |
---|---|
platform-express | Express是一個(gè)著名的用于node的極簡web框架杂穷。這是一個(gè)經(jīng)過測(cè)試的悍缠、可生產(chǎn)的庫,社區(qū)提供了大量的資源耐量。默認(rèn)情況下使用@nestjs/platform-express包飞蚓。許多用戶都很好地使用了Express,不需要采取任何行動(dòng)來啟用它廊蜒。 |
platform-fastify | Fastify是一個(gè)高性能趴拧、低開銷的框架,高度專注于提供最大的效率和速度山叮。在這里閱讀如何使用它著榴。 |
無論使用哪種平臺(tái),它都公開自己的應(yīng)用程序接口屁倔。它們分別被看作NestExpressApplication和NestFastifyApplication脑又。
當(dāng)您將一個(gè)類型傳遞給NestFactory.create()方法(如下面的示例所示)時(shí),app對(duì)象將擁有專門針對(duì)該特定平臺(tái)的方法锐借。但是问麸,請(qǐng)注意,除非您確實(shí)想訪問底層平臺(tái)API钞翔,否則不需要指定類型严卖。
const app = await NestFactory.create<NestExpressApplication>(ApplicationModule);
運(yùn)行應(yīng)用程序
安裝過程完成后,可以在OS命令提示符下運(yùn)行以下命令布轿,啟動(dòng)應(yīng)用程序偵聽HTTP請(qǐng)求:
$ npm run start
該命令啟動(dòng)應(yīng)用程序妄田,HTTP服務(wù)器監(jiān)聽src/main.ts中定義的端口文件。應(yīng)用程序運(yùn)行后驮捍,打開瀏覽器并導(dǎo)航到http://localhost:3000/疟呐。你應(yīng)該看看Hello world!消息。