[[441489]]

Nest.js 是一個(gè) Node.js 的后端開(kāi)發(fā)框架，它實(shí)現(xiàn)了 MVC 模式，也支持了 IOC(自動(dòng)注入依賴)，比 Express 這類處理請(qǐng)求響應(yīng)的庫(kù)高了一個(gè)層次。而且也很容易集成 GraphQL、WebSocket 等功能，適合用來(lái)做大規(guī)模企業(yè)級(jí)開(kāi)發(fā)。

Nest.js 在國(guó)內(nèi)外用的都挺多的，今天我們就來(lái)入門下吧：做一個(gè)筆記管理功能，實(shí)現(xiàn)對(duì) mysql 單表的增刪改查并提供 Restful 的接口。

后面要介紹的內(nèi)容比較多，我們先來(lái)看下最終的效果吧：

視頻

完整代碼上傳了 github：https://github.com/QuarkGluonPlasma/nestjs-exercize

Nest.js + Typeorm 基礎(chǔ)

mysql 數(shù)據(jù)庫(kù)和 Typeorm

首先從離前端比較遠(yuǎn)的數(shù)據(jù)庫(kù)講起。

在 mysql 的官網(wǎng)下載 mysql，安裝并啟動(dòng)服務(wù)。

這時(shí)候就可以用命令行來(lái)寫(xiě) sql 操作數(shù)據(jù)庫(kù)了。

但是命令行操作不夠方便，所以我們還要下載一個(gè)有界面的 mysql 客戶端，我這里用的是 navicat。

它可以可視化的創(chuàng)建數(shù)據(jù)庫(kù)、表等，可以在編輯器里寫(xiě) sql 然后執(zhí)行。比如圖中我創(chuàng)建了 hello 的數(shù)據(jù)庫(kù)和一堆表。

Node.js 代碼里同樣可以連接上數(shù)據(jù)庫(kù)服務(wù)，然后遠(yuǎn)程執(zhí)行 sql 來(lái)對(duì)數(shù)據(jù)庫(kù)表做增刪改查。

但直接執(zhí)行 sql 比較繁瑣，能不能我只操作對(duì)象，對(duì)象屬性變了就自動(dòng)去執(zhí)行 sql 來(lái)同步數(shù)據(jù)庫(kù)呢?就像 vue 的數(shù)據(jù)變了自動(dòng)同步視圖一樣。

數(shù)據(jù)庫(kù)和對(duì)象關(guān)系的映射就叫做 ORM(Object Relational Mapping)，也就是把表映射成對(duì)象，把表與表之間的關(guān)聯(lián)映射成對(duì)象之間的關(guān)系。之后對(duì)對(duì)象的操作會(huì)通過(guò) sql 同步到數(shù)據(jù)庫(kù)。

Typeorm 就是一個(gè)實(shí)現(xiàn) orm 的框架，可以通過(guò)裝飾器來(lái)描述映射關(guān)系，比如 @Entity(實(shí)體)、@Column(列)、@PrimaryGeneratedColumn(主鍵 ID 自動(dòng)生成)

import { Entity, PrimaryGeneratedColumn, Column } from "typeorm"; 
 
@Entity() 
export class Note{ 
 
    @PrimaryGeneratedColumn() 
    id: number; 
 
    @Column() 
    title: string; 
 
    @Column() 
    content: string; 
} 

通過(guò)裝飾器聲明了關(guān)系，那么在建立了數(shù)據(jù)庫(kù)連接之后，我們只需要操作對(duì)象，Typeorm 就會(huì)自動(dòng)去執(zhí)行 sql 來(lái)把變動(dòng)同步到數(shù)據(jù)庫(kù)。

這樣，我們對(duì)數(shù)據(jù)庫(kù)的表的操作和增刪改查就實(shí)現(xiàn)了。

數(shù)據(jù)庫(kù)部分搞定之后，我們?cè)偻翱匆幌绿幚碚?qǐng)求的部分。

http 請(qǐng)求和 Nest.js

處理請(qǐng)求的后端框架我們使用 Nest.js，它提供了 Controller、Service 等劃分，這是對(duì) MVC 模式的實(shí)現(xiàn)。

Controller 里面負(fù)責(zé)處理請(qǐng)求，把處理過(guò)的參數(shù)傳遞給 service。

Service 負(fù)責(zé)業(yè)務(wù)邏輯的實(shí)現(xiàn)，基于 Typeorm 的增刪改查功能來(lái)實(shí)現(xiàn)各種上層業(yè)務(wù)邏輯。

除此以外，Nest.js 還劃分了 Module，這個(gè) Module 是邏輯上的模塊，和我們常說(shuō)的文件對(duì)應(yīng)的模塊不同，它包含了 Controller、Service 等，是對(duì)這些資源的邏輯劃分。

Module 和 Module 之間還可以有依賴關(guān)系，也就有 imports 和 exports。

所以，模塊的聲明就是這樣的：

import { Module } from '@nestjs/common'; 
 
@Module({ 
  imports: [AaaModule], 
  controllers: [BbbController], 
  providers: [BbbService], 
  exports: [BbbService] 
}) 
export class BbbModule {} 

這里通過(guò) @Module 的裝飾器來(lái)聲明了 Bbb 的模塊，它依賴了 Aaa 模塊，也就是在 imports 引入的 AaaModule。controllers 是控制器，包含 BbbController，providers 是提供商，有 service、factory 等類型，這里包含 BbbService，同時(shí)，還導(dǎo)出了 BbbService 可以被其他模塊引入。

Controller 的聲明也是通過(guò)裝飾器：

@Controller() 
export class BbbController { 
} 

Service 的聲明也是用裝飾器，只不過(guò)不叫 Service，而叫 Injectable。

@Injectable() 
export class BbbService { 
} 

至于為什么叫 Injectable，就涉及到了 IOC 的概念了。

IOC(Inverse Of Control)是控制反轉(zhuǎn)的意思，就是只需要聲明你的依賴，不需要?jiǎng)?chuàng)建依賴的對(duì)象，容器會(huì)注入給你。

因?yàn)樗械膶?duì)象都是由容器管理的，那么自然就可以在創(chuàng)建對(duì)象的時(shí)候注入它需要的依賴，這就是 IOC 的原理。

Service 是可以被作為依賴注入到其他類的實(shí)例中去的，所以用 Injectable 裝飾器。

所有的 Module 會(huì)有一個(gè)根 Module 作為入口，啟動(dòng) IOC 容器就是從這個(gè)模塊開(kāi)始的：

import { NestFactory } from '@nestjs/core'; 
import { AppModule } from './app.module'; 
import "reflect-metadata"; 
 
async function bootstrap() { 
  const app = await NestFactory.create(AppModule); 
  await app.listen(3000); 
} 
bootstrap(); 

上面就是典型的 Nest.js 啟動(dòng)代碼，從 AppModule 這個(gè)根 Module 開(kāi)始創(chuàng)建 IOC 容器，處理從 3000 端口發(fā)過(guò)來(lái)的請(qǐng)求。

reflect-metadata 模塊是用于解析類的裝飾器的，因?yàn)橐o某個(gè)類的實(shí)例注入依賴就得能解析出它通過(guò)裝飾器聲明了哪些依賴，然后注入給它。所以要實(shí)現(xiàn) IOC 需要依賴這個(gè)包。

這就是 Nest.js 大概的設(shè)計(jì)了：IOC + MVC，通過(guò) IOC 容器來(lái)管理對(duì)象的依賴關(guān)系，通過(guò) Controller、Service、Module 來(lái)做職責(zé)上的劃分。

Nest.js 結(jié)合 Typeorm

Typeorm 是做把對(duì)象的操作通過(guò) sql 同步為對(duì)數(shù)據(jù)庫(kù)操作的 orm 的，而 Nest.js 是做 Web 后端應(yīng)用的 MVC 分層以及通過(guò) IOC 管理對(duì)象的創(chuàng)建和依賴的。這倆很自然的可以結(jié)合，結(jié)合的方式就是 @nestjs/typeorm 包。

@nestjs/typeorm 包提供了 TypeOrmModule 這個(gè) Module，它有兩個(gè)靜態(tài)方法 forRoot、forFeature。

forRoot 用于創(chuàng)建數(shù)據(jù)庫(kù)連接，傳入一些配置參數(shù)，在入口 Module 引入。

@Module({ 
  imports: [ 
    TypeOrmModule.forRoot({ 
      type: 'mysql', 
      host: 'localhost', 
      port: 3306, 
      username: 'root', 
      password: '你的密碼', 
      database: '數(shù)據(jù)庫(kù)名', 
      synchronize: true 
    }), 
    NotesModule 
  ] 
}) 
export class AppModule {} 

forFeature 用于創(chuàng)建不同實(shí)體類對(duì)應(yīng)的 Repository，在用到該實(shí)體的 Module 里引入。

@Module({ 
  imports: [TypeOrmModule.forFeature([Aaa])], 
  controllers: [AaaController], 
  providers: [AaaService], 
  exports: [AaaService] 
}) 
export class AaaModule {} 

我們知道了 Typeorm 和 Nest.js 都是做什么的和怎么用，簡(jiǎn)單小結(jié)一下：

Typeorm 是 ORM 框架，用于把對(duì)象的操作同步為對(duì)數(shù)據(jù)庫(kù)的操作，會(huì)自動(dòng)執(zhí)行 sql 語(yǔ)句。

Nest.js 是 MVC 框架，用于 Web 后端應(yīng)用的邏輯分層，還提供了 Module 用來(lái)進(jìn)一步劃分 Controller 和 Service。此外，Nest.js 提供了 IOC 容器，統(tǒng)一管理對(duì)象的創(chuàng)建和依賴關(guān)系，根據(jù)聲明來(lái)自動(dòng)注入依賴。

兩者的結(jié)合就是通過(guò) @nestjs/typeorm 的包，它有兩個(gè)靜態(tài)方法用于生成 Module。

說(shuō)了這么多，大家可能還理解的不是很清楚，那么我們就來(lái)做下筆記管理的實(shí)戰(zhàn)案例吧。

實(shí)戰(zhàn)案例

Nest.js 樣板代碼比較多，自己寫(xiě)還是比較費(fèi)事的，@nestjs/cli 的命令行工具對(duì)這些做了自動(dòng)化。

首先要搭項(xiàng)目的骨架，用

nest new project-name 

然后生成某個(gè) Module 的代碼

nest g resource xxx 

生成的代碼就是帶有 Controller、Service、Module 的，并且也有了 CRUD 的樣板代碼。

我們重點(diǎn)來(lái)看下 Controller 的代碼：

import { Controller, Get, Post, Body, Patch, Param, Delete } from '@nestjs/common'; 
import { XxxService } from './xxx.service'; 
import { CreateXxxDto } from './dto/create-xxx.dto'; 
import { UpdateXxxDto } from './dto/update-xxx.dto'; 
 
@Controller('xxx') 
export class XxxController { 
  constructor(private readonly xxxService: XxxService) {} 
 
  @Post() 
  create(@Body() createXxxDto: CreateXxxDto) { 
    return this.xxxService.create(createXxxDto); 
  } 
 
  @Get() 
  findAll() { 
    return this.xxxService.findAll(); 
  } 
 
  @Get(':id') 
  findOne(@Param('id') id: string) { 
    return this.xxxService.findOne(+id); 
  } 
 
  @Patch(':id') 
  update(@Param('id') id: string, @Body() updateXxxDto: UpdateXxxDto) { 
    return this.xxxService.update(+id, updateXxxDto); 
  } 
 
  @Delete(':id') 
  remove(@Param('id') id: string) { 
    return this.xxxService.remove(+id); 
  } 
} 

@Controller 的參數(shù)可以聲明 URL 路徑，@Get、@Post、@Patch、@Delete 也可以通過(guò)參數(shù)聲明 URL 路徑，最終會(huì)把兩個(gè)拼起來(lái)。比如 /xxx/:id 的 get 方法。

@Get、@Post、@Patch、@Delete 分別對(duì)應(yīng)不同的請(qǐng)求方式。

@Param 是取路徑中的參數(shù)，@Query 是取查詢字符串的參數(shù)。

@Body 是把請(qǐng)求參數(shù)設(shè)置到對(duì)象的屬性上，被用來(lái)傳遞數(shù)據(jù)的對(duì)象叫做 dto(data transfer object)。

再就是返回的對(duì)象會(huì)被序列化成 JSON，不需要手動(dòng)序列化。

然后再看下 Service：

import { Injectable } from '@nestjs/common'; 
import { CreateXxxDto } from './dto/create-xxx.dto'; 
import { UpdateXxxDto } from './dto/update-xxx.dto'; 
 
@Injectable() 
export class XxxService { 
  create(createXxxDto: CreateXxxDto) { 
    return 'This action adds a new xxx'; 
  } 
 
  findAll() { 
    return `This action returns all xxx`; 
  } 
 
  findOne(id: number) { 
    return `This action returns a #${id} xxx`; 
  } 
 
  update(id: number, updateXxxDto: UpdateXxxDto) { 
    return `This action updates a #${id} xxx`; 
  } 
 
  remove(id: number) { 
    return `This action removes a #${id} xxx`; 
  } 
} 

這些 service 的方法都沒(méi)有具體實(shí)現(xiàn)。

我們引入 Typeorm 來(lái)做數(shù)據(jù)庫(kù)的 CRUD。

在根模塊引入用于數(shù)據(jù)庫(kù)連接的 Module

在剛創(chuàng)建的模塊引入實(shí)體對(duì)應(yīng)的 Module：

創(chuàng)建筆記實(shí)體，用 @Entity 標(biāo)識(shí)。并且用 @Column、@PrimaryGeneratedColumn 來(lái)標(biāo)識(shí)列和主鍵。

import { Entity, PrimaryGeneratedColumn, Column } from "typeorm"; 
 
@Entity() 
export class Note{ 
 
    @PrimaryGeneratedColumn() 
    id: number; 
 
    @Column() 
    title: string; 
 
    @Column() 
    content: string; 
 
    @Column() 
    createTime: Date; 
 
    @Column() 
    updateTime: Date; 
 
    @Column() 
    isDelete: boolean; 
} 

之后在 service 里注入實(shí)體對(duì)應(yīng)的操作類 Repository，就可以實(shí)現(xiàn)對(duì)筆記的增刪改查了。

用到的 dto 就是參數(shù)對(duì)應(yīng)的對(duì)象，他們是實(shí)體的一部分屬性的集合。比如 update dto：

export class UpdateNoteDto { 
    title: string; 
 
    content: string; 
 
    createTime: Date; 
 
    updateTime: Date; 
 
    isDelete: boolean; 
} 

這樣，就實(shí)現(xiàn)了對(duì)筆記的增刪改查。

我們用 postman 來(lái)測(cè)試下效果：

運(yùn)行 npm start 把項(xiàng)目跑起來(lái)

可以看到 4 個(gè)接口的路由映射都成功了。

數(shù)據(jù)庫(kù)一開(kāi)始有兩條記錄：

通過(guò)查詢接口能正確的查出來(lái)：

然后測(cè)試下修改接口：

數(shù)據(jù)庫(kù)中確實(shí)被修改了：

經(jīng)過(guò)測(cè)試，對(duì)筆記單表的 CRUD 的功能正常。

視頻

我們完成了第一個(gè) Nest.js 的后端應(yīng)用!

完整代碼上傳了 github：https://github.com/QuarkGluonPlasma/nestjs-exercize

總結(jié)

Typeorm 是一個(gè) ORM 框架，通過(guò)映射表和對(duì)象的對(duì)應(yīng)關(guān)系，就可以把對(duì)對(duì)象的操作轉(zhuǎn)換為對(duì)數(shù)據(jù)庫(kù)的操作，自動(dòng)執(zhí)行 sql 語(yǔ)句。

Nest.js 是一個(gè) MVC 框架，提供了 Module、Controller、Service 的邏輯劃分，也實(shí)現(xiàn)了 IOC 模式，集中管理對(duì)象和自動(dòng)注入依賴。

Typeorm 和 Nest.js 的結(jié)合使用 @nestjs/typeorm 的包，它提供了一個(gè) TypeormModule 的模塊，有 forRoot 和 forFeature 兩個(gè)靜態(tài)方法。forRoot 方法用于生成連接數(shù)據(jù)庫(kù)的 Module，forFeature 用于生成實(shí)體對(duì)應(yīng)的 Repository 的 Module。

Nest.js 有很多樣板代碼，可以用 @nestjs/cli 的命令行工具生成，包括整體的和每個(gè) Module 的。

總之，理解了 IOC，理解了 Module、Controller、Service 的劃分，就算是初步掌握了 Nest.js，結(jié)合 Typeorm 的 ORM 框架可以輕松的做數(shù)據(jù)庫(kù)表的 CRUD。