快捷導(dǎo)航

NestJS開(kāi)發(fā)核心概念Providers類(lèi)基本用法詳解

更新時(shí)間：2023年08月08日 09:55:46 作者：南玖

這篇文章主要為大家介紹了NestJS開(kāi)發(fā)核心概念Providers類(lèi)基本用法詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪

前言

Providers是Nest中的一個(gè)基本概念，許多Nest中定義的類(lèi)都可以被視為一個(gè)Provider，比如：service、repository、factory、helper等，它們都可以通過(guò)constructor注入依賴(lài)關(guān)系，這就意味著類(lèi)與類(lèi)之間可以創(chuàng)建各種依賴(lài)關(guān)系，并且維護(hù)各個(gè)類(lèi)之間依賴(lài)關(guān)系的工作將委托給Nest運(yùn)行時(shí)系統(tǒng)。

Provider類(lèi)(service)基本用法

前面幾章我們通過(guò)nest-cli生成的代碼中就包含有service類(lèi)

比如：

// nanjiu.service.ts
import { Injectable } from '@nestjs/common';
import { CreateNanjiuDto } from './dto/create-nanjiu.dto';
import { UpdateNanjiuDto } from './dto/update-nanjiu.dto';
@Injectable()
export class NanjiuService {
  create(createNanjiuDto: CreateNanjiuDto) {
    return 'This action is nanjiu post';
  }
  findAll() {
    return `This action returns all nanjiu`;
  }
  findOne(id: number) {
    return `This action returns a #${id} nanjiu`;
  }
  update(id: number, updateNanjiuDto: UpdateNanjiuDto) {
    return `This action updates a #${id} nanjiu`;
  }
  remove(id: number) {
    return `This action removes a #${id} nanjiu`;
  }
}

使用步驟如下：

@Injectable()裝飾器

這里的NanjiuService類(lèi)通過(guò)@Injectable裝飾器標(biāo)記為一個(gè)provider，表明該類(lèi)可以被Nest的IOC容器管理

在module中注冊(cè)

服務(wù)需要在對(duì)應(yīng)的module中進(jìn)行注冊(cè)，如果不注冊(cè)IOC容器是不會(huì)幫你創(chuàng)建對(duì)象的，而且還會(huì)報(bào)錯(cuò)

// nanjiu.module.ts
@Module({
  controllers: [NanjiuController],
  providers: [NanjiuService]
})
export class NanjiuModule {}

在controller中注入并使用

在module中注冊(cè)service類(lèi)后，再通過(guò)controller的構(gòu)造函數(shù)進(jìn)行注入，那么該類(lèi)就可以在controller中去使用了

// nanjiu.controller.ts
@Controller('nanjiu')
export class NanjiuController {
  constructor(private readonly nanjiuService: NanjiuService) {}
  @Post()
  @Header('Cache-Control', 'none')
  create(@Body() createNanjiuDto: CreateNanjiuDto) {
    console.log('body', createNanjiuDto)
    return this.nanjiuService.create(createNanjiuDto);
  }
}

可以看到是通過(guò)類(lèi)構(gòu)造函數(shù) constructor(private readonly nanjiuService: NanjiuService) {}這種方式來(lái)進(jìn)行依賴(lài)注入的，Nest提供了IOC容器利用Typescript自帶類(lèi)型的特點(diǎn)自動(dòng)創(chuàng)建對(duì)象的能力，注意這里是單例模式，如果該Service在其它地方也被用過(guò)，那么會(huì)在不會(huì)重新創(chuàng)建對(duì)象，各個(gè)應(yīng)用只會(huì)有一個(gè)該Service的對(duì)象，容器會(huì)先尋找當(dāng)前有沒(méi)有，如果沒(méi)有再進(jìn)行創(chuàng)建。

自定義Provider

Provider可以是一個(gè)值(value)，也可以是一個(gè)類(lèi)(class)，還可以是一個(gè)工廠函數(shù)(factory)

useClass

上面providers的那種寫(xiě)法其實(shí)是一種簡(jiǎn)寫(xiě)，它的完整寫(xiě)法應(yīng)該是這樣：

// nanjiu.module.ts
@Module({
  controllers: [NanjiuController], // 控制器
  providers: [{
    provide: 'NANJIU',  // 自定義依賴(lài)注入的標(biāo)識(shí)
    useClass: NanjiuService // 依賴(lài)注入的類(lèi)
  }]
})
export class NanjiuModule {}

完整寫(xiě)法可以通過(guò)provide屬性給不同的provider標(biāo)注不同的token

然后再controller中需要使用@Inject(對(duì)應(yīng)的token)進(jìn)行注入

// nanjiu.controller.ts
@Controller('nanjiu')
export class NanjiuController {
  constructor(@Inject('NANJIU') private readonly nanjiuService: NanjiuService) {}

  @Post()
  @Header('Cache-Control', 'none')
  create(@Body() createNanjiuDto: CreateNanjiuDto) {
    console.log('body', createNanjiuDto, this.nanjiuService)
    return true
    return this.nanjiuService.create(createNanjiuDto);
  }
}

useValue

還可以使用useValue自定義注入值

// nanjiu.module.ts
@Module({ // 模塊裝飾器
  controllers: [NanjiuController], // 控制器
  providers: [{
    provide: 'NANJIU',  // 自定義依賴(lài)注入的標(biāo)識(shí)
    useValue: {
      name: 'nanjiu' // 依賴(lài)注入的值
    }
  }]
})

useFactory

工廠函數(shù)可以提供動(dòng)態(tài)的provider，由factory函數(shù)的返回值來(lái)確定，factory函數(shù)可以很簡(jiǎn)單也可以很復(fù)雜，它也可以使用其它provider，不過(guò)需要在inject屬性進(jìn)行注入，注入的provider可以是可選的

工廠函數(shù)可以接受（可選）參數(shù)。
（可選）inject屬性接受一組提供程序，Nest 將在實(shí)例化過(guò)程中解析這些提供程序并將其作為參數(shù)傳遞給工廠函數(shù)。這兩個(gè)列表應(yīng)該是相關(guān)的：Nest 將以inject相同的順序?qū)⒘斜碇械膶?shí)例作為參數(shù)傳遞給工廠函數(shù)。

// nanjiu.module.ts
import { Module } from '@nestjs/common';
import { NanjiuService } from './nanjiu.service';
import { UserService } from 'src/user/user.service';
import { NanjiuController } from './nanjiu.controller';
@Module({ // 模塊裝飾器
  controllers: [NanjiuController], // 控制器
  providers: [{
    provide: 'NANJIU',  // 自定義依賴(lài)注入的標(biāo)識(shí)
    useClass: NanjiuService // 依賴(lài)注入的類(lèi)
  },
  UserService,
  {
    provide: 'USER', // 自定義依賴(lài)注入的標(biāo)識(shí)
    useFactory: (...args) => { // 工廠模式
      console.log('useFactory', args)
      return new UserService() // 依賴(lài)注入的類(lèi)
    },
    inject: [UserService] // 依賴(lài)注入的類(lèi)
  }
]
})
export class NanjiuModule {}

可選的Provider

有時(shí)你可能存在不一定需要解決的依賴(lài)關(guān)系。例如，你的類(lèi)可能依賴(lài)于配置對(duì)象，但如果沒(méi)有傳遞任何內(nèi)容，則應(yīng)使用默認(rèn)值。在這種情況下，依賴(lài)關(guān)系變得可選，這時(shí)候可以給對(duì)應(yīng)的注入服務(wù)再增加一個(gè)@Optional()裝飾器就行

import { Injectable, Optional, Inject } from '@nestjs/common';
@Injectable()
export class HttpService<T> {
  constructor(@Optional() @Inject('HTTP_OPTIONS') private httpClient: T) {}
}

異步Provider

useFactory可以返回一個(gè)promise 或者其他異步操作，Nest 將在實(shí)例化任何依賴(lài)（注入）此類(lèi)提供程序的類(lèi)之前等待promise的結(jié)果。

// nanjiu.module.ts
@Module({ // 模塊裝飾器
  controllers: [NanjiuController], // 控制器
  providers: [
  UserService,
  {
    provide: 'USER', // 自定義依賴(lài)注入的標(biāo)識(shí)
    useFactory: async () => { // 工廠模式
      return new Promise((resolve, reject) => {
        setTimeout(() => {
          resolve(new UserService())
        }, 1000)
      })
    },
    inject: [UserService] // 依賴(lài)注入的類(lèi)
  }
]
})
export class NanjiuModule {}

以上就是NestJS開(kāi)發(fā)核心概念Providers類(lèi)基本用法詳解的詳細(xì)內(nèi)容，更多關(guān)于NestJS核心Providers類(lèi)的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: