這篇文章帶大家來認識node中的Nest.js框架，聊聊為什麼選擇 Nest，創建和運行專案、不同方式接收請求的方法，希望對大家有幫助！
最近在考慮和小夥伴做一個todolist平台給自己用，很久之前學習過express ，想著與時俱進一下,看看近期熱度較高的幾個框架是怎麼樣的。在幾個對比下選擇了 nest 在初步使用後記錄一下，方便日後查閱。
貼出中文文件以便大家進一步學習Nest
Nest.js框架簡介
- Nest 是一個用於建立高效，可擴充的 Node.js 伺服器端應用程式的框架。它使用漸進式JavaScript，內建並完全支援 TypeScript（但仍允許開發人員使用純JavaScript 編寫程式碼）並結合了OOP（物件導向程式設計），FP（函數式程式設計）和FRP（函數式響應編程）的元素。
- Nest 框架底層 HTTP 平台預設是基於 Express 實現的，所以無需擔心第三方函式庫的缺失。 Nest 旨在成為一個與平台無關的框架。透過平台，可以創建可重複使用的邏輯部件，開發人員可以利用這些部件來跨越多種不同類型的應用程式。 nest 目前有兩個支援開箱即用的 HTTP 平台：express 和 fastify 可以在專案中直接引入。
為什麼選擇 Nest
- 目前市面上有許多 node 框架可供大家選擇。
- Express.js 是 Node.JS 誕生之初，是一款基於Node.js以及Chrome V8引擎，快速、極簡的JS服務端開發框架。
- Koa.js是一款微型Web框架，寫一個hello world很簡單，但web應用程式離不開session，視圖模板，路由，檔案上傳，日誌管理。這些 Koa 都不提供，需要自行到官方的 Middleware 尋找。然而，100個人可能找出100種搭配。
- Egg.js是基於Koa.js，解決了上述問題，將社群最佳實踐整合進了Koa.js，另取名叫Egg.js，並且將多進程啟動，開發時的熱更新等問題一併解決了。這對開發者很友好，開箱即用，開箱即是最(較)佳配置。 Egg.js發展期間，ECMAScript又推出了 async await，相比yield的語法async寫起來更直。後面Koa.js也同步進行了跟進。
- Midway 是阿里團隊，基於漸進式理念研發的 Node.js 框架，結合了 OOP和函數式兩種程式設計範式。以egg 是作為底層框架，加上了良好的TypeScript的定義支持等眾多新特性,推出了Midway，有興趣的小伙伴可以去官方文檔學習一下
- Nest.js 基於Express.js的全功能框架Nest.js，他是在Express.js上封裝的，充分利用了TypeScript的特性；Nest.js的優點是社區活躍，漲勢喜人，截止目前在GitHub 擁有
43.7k Star 是近期比較熱門的企業級框架。
- 基於支持底層支援ts與企業級和社群活躍度等綜合考慮，這裡我選擇用nest來進行學習。各位同學可以按需選擇。
建立專案
建立專案
运行项目
$ npm run start:watch // 启动项目并监听代码变动 这里可以在package.json 中进行配置指令
登入後複製
我们可以看到服务已经启动,输入本机地址并带上端口号3000,发送一次 get 请求 则会返回 `Hello World`。
这里是因为在 app.controll.ts 文件中 @Get()HTTP请求装饰器告诉Nest为HTTP请求的特定端点创建处理程序。
登入後複製
路由
在开始写代码之前我们先简单看一下nest中的基础路由配置是怎样的，就目前而言我的理解为nest的路由是由
全局路由 路由前缀(局部路由) 方法装饰器 组成路由映射提供给前端使用。
/* main.ts */
main文件中我们可以在项目监听前配置一个全局的api前缀
async function bootstrap() {
const app = await NestFactory.create(AppModule);
//设置全局前缀
app.setGlobalPrefix('api');
await app.listen(3000);
}
/* app.controller.ts */
@Controller('user') // 控制器设置路由前缀 我理解为局部路由
export class AppController {
constructor(private readonly appService: AppService) {}
@Get('find') // 方法装饰器设置路由路径 这里我理解为设置api子路由
getHello(): string {
return this.appService.getHello();
}
}登入後複製
以上方法在api中映射成完整的路由为GET api/user/find 。
其中 @Get()HTTP请求装饰器告诉Nest为HTTP请求的特定端点创建处理程序。
- 可以看到上面的
get 接收请求及路由以可以使用，下面我们看一下 nest 中如何接收 post 等其他请求方式
不同方式接收请求
这里用到的 Nest 提供的请求装饰器知识点Request 对象代表 HTTP 请求，并具有查询字符串，请求参数参数，HTTP 标头（HTTP header） 和 正文（HTTP body）的属性（在这里阅读更多）。在多数情况下，不必手动获取它们。 我们可以使用专用的装饰器，比如开箱即用的 @Body() 或 @Query() 。 下面是 Nest 提供的装饰器及其代表的底层平台特定对象的对照列表。
下面我们看一下 nest 中如何接收 get post put delete 发起的请求，用几个可用的装饰器来创建基本控制器。 该控制器暴露了几个访问和操作内部数据的方法。
Get
我们先创建一个 user 服务/控制器/moudle
/ * user.service.ts */ 先创建一个 user service服务文件
import { Injectable } from '@nestjs/common';
@Injectable() //
// 这里
export class UserService {
findUser(sid: string): string {
console.log(sid);
if (sid === '123456') {
return 'kid is here';
}
return 'No one here';
}
}登入後複製
该服务将负责数据存储和检索，其由 UserController 使用，我们用 @Injectable() 来装饰这个类
/ * user.controller.ts */ 创建一个 user 控制器文件
import { Controller, Get, Query } from '@nestjs/common';
import { UserService } from './user.service';
@Controller('user')
export class UserController {
constructor(private readonly userService: UserService) {}
@Get('findOne') //这里暴露出的路由为 user/find
findUser(@Query() query: any) {
return this.userService.findUser(query.sid);
}登入後複製
控制器的目的是接收应用的特定请求。路由机制控制哪个控制器接收哪些请求。通常，每个控制器有多个路由，不同的路由可以执行不同的操作。
为了创建一个基本的控制器，我们使用类和装饰器。装饰器将类与所需的元数据相关联，并使 Nest 能够创建路由映射（将请求绑定到相应的控制器）。
/ * user.module.ts */ 创建一个 user mod
import { Module } from '@nestjs/common';
import { UserController } from './user.controller';
import { UserService } from './user.service';
@Module({
controllers: [UserController],
providers: [UserService],
})
export class UserModule {}
/* app.module.ts */ 最后在app.module中引入我们自己写的module
import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { UserModule } from './user/user.module';
@Module({
imports: [UserModule],
controllers: [AppController],
providers: [AppService],
})
export class AppModule {}登入後複製
控制器已经准备就绪，可以使用，但是 Nest 依然不知道 UserController 是否存在，所以它不会创建这个类的一个实例。
控制器总是属于模块，这就是为什么我们在 @Module() 装饰器中包含 controllers 数组的原因。 由于除了根模块 AppModule之外，我们还没有定义其他模块，所以我们将使用它来介绍 UserController
使用 postman 看下效果
- 可以看到发送get请求 请求成攻。
- 接下来我们依次使用
post put delete 发送请求,看nest是如何接受并处理的
Post
user.service 文件
/ * user.service.ts */ 先创建一个 user service服务文件
import { Injectable } from '@nestjs/common';
@Injectable() //
// 这里
setUser(sid: string, body: any): any {
if (sid === '123456') {
return {
msg: '设置成功',
body,
};
}
}登入後複製
user.controller 文件
/ * user.controller.ts */ 创建一个 user 控制器文件
import { Controller, Get, Query } from '@nestjs/common';
import { UserService } from './user.service';
@Controller('user')
export class UserService {
@Post('set')
setUser(@Body() body: any, @Query() query: any) {
return this.userService.setUser(query.sid, body);
}
}登入後複製
使用 postman 看下效果
Put
使用 postman 看下效果
Delete
user.service 文件
/ * user.service.ts */ 先创建一个 user service服务文件
import { Injectable } from '@nestjs/common';
@Injectable() //
// 这里
deleteUser(sid: string): any {
if (sid === '123456') {
return {
msg: '删除成功',
};
}
}登入後複製
user.controller 文件
/ * user.controller.ts */ 创建一个 user 控制器文件
import { Body, Controller, Get, Param, Post, Put, Query } from '@nestjs/common';
import { UserService } from './user.service';
@Controller('user')
export class UserService {
@Delete(':sid')
deleteUser(@Param('sid') sid: string) {
return this.userService.deleteUser(sid);
}
}登入後複製
使用 postman 看下效果
总结
- 至此我们用 Nest 的装饰器模拟了基础的接口请求增删改查，认识到 Nest 中的三种基本应用程序构建块
Module Controller Service
- 服务和控制的划分明确，带来更好的代码体验。
TypeScrip 的个人使用还有待提高，以后还要继续学习hhh
更多node相关知识，请访问：nodejs 教程！
以上是深入淺析node中的Nest.js框架的詳細內容。更多資訊請關注PHP中文網其他相關文章！
