Nest.js系列之Providers及模塊功能使用詳解
提供者
Providers是Nest的一個基本概念。提供者是一個大的分類，比如sevice、repository、factory、helper等都是提供者。可以通過constructor注入依賴關(guān)系。對象之間可以創(chuàng)建各種關(guān)系。提供者只是一個用@Injectable()裝飾的類
在控制器的文章中，知道了如何創(chuàng)建一個簡單的控制器，控制器中不應(yīng)該包含過多的復(fù)雜任務(wù)處理邏輯，這部分的任務(wù)邏輯處理應(yīng)該交給Providers
因為Nest可以面向?qū)ο蟮姆绞皆O(shè)計和組織依賴性，所以強(qiáng)烈建議遵循SOLID原則
什么是SOLID原則
SOLID 原則其實是用來指導(dǎo)軟件設(shè)計的，它一共分為五條設(shè)計原則，分別是：
- 單一職責(zé)原則（SRP）
- 開閉原則（OCP）
- 里氏替換原則（LSP）
- 接口隔離原則（ISP）
- 依賴倒置原則（DIP）
服務(wù)
從創(chuàng)建一個簡單的服務(wù)開始，服務(wù)由控制器使用，服務(wù)其實也是一個提供者
import { Injectable } from '@nestjs/common';
import { User } from './interfaces/user.interface';
@Injectable()
export class UsersService {
private readonly users: User[] = [];
create(user: User) {
this.users.push(user);
}
findAll(): User[] {
return this.users;
}
}
之前文章提到過可以使用命令快速創(chuàng)建一個服務(wù) nest g service users
控制器中如何使用服務(wù)
import { Controller, Get, Post, Body } from '@nestjs/common';
import { CreateUserDto } from './dto/create-user.dto';
import { UsersService } from './users.service';
import { User } from './interfaces/user.interface';
@Controller('users')
export class CatsController {
constructor(private usersService: UsersService) {}
@Post()
async create(@Body() createUserDto: CreateUserDto) {
this.usersService.create(createUserDto);
}
@Get()
async findAll(): Promise<User[]> {
return this.usersService.findAll();
}
}
通過實例可以看出，控制器如果想要使用服務(wù)，只需要將服務(wù)通過依賴注入的方式注入到控制器中
constructor(private usersService: UsersService) {}
依賴注入
Nest 是建立在強(qiáng)大的設(shè)計模式，通常稱為依賴注入。我們建議在官方的 Angular文檔中閱讀有關(guān)此概念的精彩文章。
在 Nest 中，借助 TypeScript 功能，管理依賴項非常容易，因為它們僅按類型進(jìn)行解析。在下面的示例中，Nest 將 catsService 通過創(chuàng)建并返回一個實例來解析 CatsService（或者，在單例的正常情況下，如果現(xiàn)有實例已在其他地方請求，則返回現(xiàn)有實例）。解析此依賴關(guān)系并將其傳遞給控制器的構(gòu)造函數(shù)（或分配給指定的屬性）：
constructor(private readonly catsService: CatsService) {}
注冊提供者
現(xiàn)在我們已經(jīng)定義了提供者（UsersService），并且已經(jīng)有了該服務(wù)的使用者（UsersController），我們需要在 Nest 中注冊該服務(wù)，以便它可以執(zhí)行注入。 為此，我們可以編輯模塊文件（app.module.ts），然后將服務(wù)添加到@Module()裝飾器的 providers 數(shù)組中。
import { Module } from '@nestjs/common';
import { UsersController } from './users/users.controller';
import { UsersService } from './users/users.service';
@Module({
controllers: [UsersController],
providers: [UsersService],
})
export class AppModule {}
小結(jié)
提供者可以簡單理解為是服務(wù)，但是畢竟服務(wù)只是一種提供者。在nest中通過使用服務(wù)來做邏輯處理。
模塊
什么是模塊
模塊是具有@Module()裝飾器的類，Nest使用模塊來組織代碼
每個nest程序至少有一個模塊，也就是根模塊。但是這是對于小應(yīng)用來說的，對于大型程序來說，會擁有多個模塊，每個模塊擁有自己的功能。 @Module()裝飾器接受屬性對象
- providers 由nest注入器實例化的提供者，并且可以至少在整個模塊中共享
- controllers 必須創(chuàng)建的控制器
- imports 導(dǎo)入模塊的列表，這些模塊導(dǎo)出了此模塊中所需要的提供者
- exports 本模塊導(dǎo)出的可以用于其他模塊的提供者
默認(rèn)情況下，該模塊封裝提供程序。這意味著無法注入既不是當(dāng)前模塊的直接組成部分，也不是從導(dǎo)入的模塊導(dǎo)出的提供程序。因此，您可以將從模塊導(dǎo)出的提供程序視為模塊的公共接口或API。
功能模塊
通常來說，一個功能對應(yīng)一個模塊，比如UsersController和UsersService應(yīng)該屬于一個模塊，該模塊就稱為功能模塊
users/users.module.ts
import { Module } from '@nestjs/common';
import { UsersController } from './users.controller';
import { UsersService } from './users.service';
@Module({
controllers: [UsersController],
providers: [UsersService],
})
export class UsersModule {}
可以使用cli命令來創(chuàng)建一個模塊
nest g module cats
當(dāng)寫好一個功能模塊之后，要把模塊導(dǎo)入到根模塊
import {Module} from '@nestjs/common';
import {UsersModule} from './users/users.module';
@Module({
imports: [CatsModule],
})
export class ApplocationModule {}
共享模塊
nest默認(rèn)情況下，模塊是單例，因此可以很輕松的在多個模塊之間共享同一個提供者實例
其實在nest中，每個模塊都是共享模塊，可以被任意模塊重復(fù)使用。但是如果要在幾個模塊共享某一個服務(wù)，比如UsersService，那就需要在它所屬的模塊中導(dǎo)出這個服務(wù)，放到exports數(shù)組中
import { Module } from '@nestjs/common';
import { UsersController } from './users.controller';
import { UsersService } from './users.service';
@Module({
controllers: [UsersController],
providers: [UsersService],
exports: [UsersService]
})
export class UsersModule {}
每個導(dǎo)入UsersModule的模塊都可以訪問UsersService
模塊的導(dǎo)出與導(dǎo)入
模塊不僅可以導(dǎo)出提供者，而且還可以導(dǎo)出自己導(dǎo)入的模塊
@Module({
imports: [CommonModule],
exports: [CommonModule],
})
export class CoreModule {}
依賴注入
提供者也可以注入到模塊中
import { Module } from '@nestjs/common';
import { UsersController } from './cats.controller';
import { UsersService } from './cats.service';
@Module({
controllers: [CatsController],
providers: [CatsService],
})
export class CatsModule {
constructor(private readonly catsService: CatsService) {}
}
全局模塊
有時候需要在任何地方導(dǎo)入相同的模塊，如果每個模塊都導(dǎo)入，就會很繁瑣，所以就有了全局模塊
import { Module, Global } from '@nestjs/common';
import { UsersController } from './users.controller';
import { UsersService } from './users.service';
@Global()
@Module({
controllers: [UsersController],
providers: [UsersService],
exports: [UsersService],
})
export class UsersModule {}
@Global 裝飾器使模塊成為全局作用域。 全局模塊應(yīng)該只注冊一次，最好由根或核心模塊注冊。 在上面的例子中，CatsService 組件將無處不在，而想要使用 CatsService 的模塊則不需要在 imports 數(shù)組中導(dǎo)入 CatsModule。
使一切全局化并不是一個好的解決方案。 全局模塊可用于減少必要模板文件的數(shù)量。 imports 數(shù)組仍然是使模塊 API 透明的最佳方式。
動態(tài)模塊
Nest 模塊系統(tǒng)包括一個稱為動態(tài)模塊的強(qiáng)大功能。此功能使您可以輕松創(chuàng)建可自定義的模塊，這些模塊可以動態(tài)注冊和配置提供程序。動態(tài)模塊在這里廣泛介紹。在本章中，我們將簡要概述以完成模塊介紹。
以下是一個動態(tài)模塊定義的示例 DatabaseModule：
import { Module, DynamicModule } from '@nestjs/common';
import { createDatabaseProviders } from './database.providers';
import { Connection } from './connection.provider';
@Module({
providers: [Connection],
})
export class DatabaseModule {
static forRoot(entities = [], options?): DynamicModule {
const providers = createDatabaseProviders(options, entities);
return {
module: DatabaseModule,
providers: providers,
exports: providers,
};
}
}Copy to clipboardErrorCopied
forRoot() 可以同步或異步（Promise）返回動態(tài)模塊。
此模塊 Connection 默認(rèn)情況下（在 @Module() 裝飾器元數(shù)據(jù)中）定義提供程序，但此外-根據(jù)傳遞給方法的 entities 和 options 對象 forRoot() -公開提供程序的集合，例如存儲庫。請注意，動態(tài)模塊返回的屬性擴(kuò)展（而不是覆蓋）@Module() 裝飾器中定義的基本模塊元數(shù)據(jù)。這就是從模塊導(dǎo)出靜態(tài)聲明的 Connection 提供程序和動態(tài)生成的存儲庫提供程序的方式。
如果要在全局范圍內(nèi)注冊動態(tài)模塊，請將 global 屬性設(shè)置為 true。
{
global: true,
module: DatabaseModule,
providers: providers,
exports: providers,
}Copy to clipboardErrorCopied
如上所述，將所有內(nèi)容全局化不是一個好的設(shè)計決策。
所述 DatabaseModule 可以被導(dǎo)入，并且被配置以下列方式：
import { Module } from '@nestjs/common';
import { DatabaseModule } from './database/database.module';
import { User } from './users/entities/user.entity';
@Module({
imports: [DatabaseModule.forRoot([User])],
})
export class AppModule {}Copy to clipboardErrorCopied
如果要依次重新導(dǎo)出動態(tài)模塊，則可以 forRoot() 在導(dǎo)出數(shù)組中省略方法調(diào)用：
import { Module } from '@nestjs/common';
import { DatabaseModule } from './database/database.module';
import { User } from './users/entities/user.entity';
@Module({
imports: [DatabaseModule.forRoot([User])],
exports: [DatabaseModule],
})
export class AppModule {}
總結(jié)
模塊就是一個功能的聚合，nest用模塊化來組織程序。
以上就是Nest.js系列之Providers及模塊功能使用詳解的詳細(xì)內(nèi)容，更多關(guān)于Nest.js Providers模塊功能的資料請關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
node 標(biāo)準(zhǔn)輸入流和輸出流代碼實例
這篇文章主要介紹了node 標(biāo)準(zhǔn)輸入流和輸出流代碼實例,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2019-09-09
本篇文章主要介紹了配置nodejs環(huán)境變量的方法，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-05-05
所謂nvm就是一個可以讓你在同一臺機(jī)器上安裝和切換不同版本node的工具,下面這篇文章主要給大家介紹了關(guān)于nvm介紹、安裝、報錯處理及使用的相關(guān)資料,文中通過圖文介紹的非常詳細(xì),需要的朋友可以參考下2022-09-09
使用Node.js實現(xiàn)一個簡單的FastCGI服務(wù)器實例
這篇文章主要介紹了使用Node.js實現(xiàn)一個簡單的FastCGI服務(wù)器實例,也可以作為一個比較詳細(xì)的Node.js服務(wù)器創(chuàng)建教程,需要的朋友可以參考下2014-06-06
這篇文章主要介紹了詳解nodejs微信公眾號開發(fā)——5.素材管理接口，非常具有實用價值，需要的朋友可以參考下2017-04-04
今天小編就為大家分享一篇nodejs aes 加解密實例，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2018-10-10
node.js操作mongoDB數(shù)據(jù)庫示例分享
這里給大家分享的是node.js操作mongoDB數(shù)據(jù)庫的示例，包括連接數(shù)據(jù)庫、插入數(shù)據(jù)、關(guān)閉數(shù)據(jù)庫、讀取數(shù)據(jù)、插入數(shù)據(jù)等方面，十分的全面，這里推薦給需要的小伙伴們。2014-11-11
今天小編就為大家分享一篇關(guān)于nodejs使用async模塊同步執(zhí)行的方法，小編覺得內(nèi)容挺不錯的，現(xiàn)在分享給大家，具有很好的參考價值，需要的朋友一起跟隨小編來看看吧2019-03-03
這篇文章主要介紹了node.js微信小程序配置消息推送的實現(xiàn)，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2019-02-02
這篇文章主要介紹了使用nodejs開發(fā)cli項目實例,本文講解使用generator-cli-starter實現(xiàn)cli項目的開發(fā),需要的朋友可以參考下2015-06-06