NestJS开发核心概念Providers类基本用法详解

 更新时间:2023年08月08日 09:55:46   作者:南玖  
这篇文章主要为大家介绍了NestJS开发核心概念Providers类基本用法详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

前言

ProvidersNest中的一个基本概念,许多Nest中定义的类都可以被视为一个Provider,比如:service、repository、factory、helper等,它们都可以通过constructor注入依赖关系,这就意味着类与类之间可以创建各种依赖关系,并且维护各个类之间依赖关系的工作将委托给Nest运行时系统。

Provider类(service)基本用法

前面几章我们通过nest-cli生成的代码中就包含有service

比如:

// 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类通过@Injectable装饰器标记为一个provider,表明该类可以被NestIOC容器管理

在module中注册

服务需要在对应的module中进行注册,如果不注册IOC容器是不会帮你创建对象的,而且还会报错

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

在controller中注入并使用

module中注册service类后,再通过controller的构造函数进行注入,那么该类就可以在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);
  }
}

可以看到是通过类构造函数 constructor(private readonly nanjiuService: NanjiuService) {}这种方式来进行依赖注入的,Nest提供了IOC容器利用Typescript自带类型的特点自动创建对象的能力,注意这里是单例模式,如果该Service在其它地方也被用过,那么会在不会重新创建对象,各个应用只会有一个该Service的对象,容器会先寻找当前有没有,如果没有再进行创建。

自定义Provider

Provider可以是一个值(value),也可以是一个类(class),还可以是一个工厂函数(factory)

useClass

上面providers的那种写法其实是一种简写,它的完整写法应该是这样:

// nanjiu.module.ts
@Module({
  controllers: [NanjiuController], // 控制器
  providers: [{
    provide: 'NANJIU',  // 自定义依赖注入的标识
    useClass: NanjiuService // 依赖注入的类
  }]
})
export class NanjiuModule {}

完整写法可以通过provide属性给不同的provider标注不同的token

然后再controller中需要使用@Inject(对应的token)进行注入

// 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',  // 自定义依赖注入的标识
    useValue: {
      name: 'nanjiu' // 依赖注入的值
    }
  }]
})

useFactory

工厂函数可以提供动态的provider,由factory函数的返回值来确定,factory函数可以很简单也可以很复杂,它也可以使用其它provider,不过需要在inject属性进行注入,注入的provider可以是可选的

  • 工厂函数可以接受(可选)参数。
  • (可选)inject属性接受一组提供程序,Nest 将在实例化过程中解析这些提供程序并将其作为参数传递给工厂函数。这两个列表应该是相关的:Nest 将以inject相同的顺序将列表中的实例作为参数传递给工厂函数。
// 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',  // 自定义依赖注入的标识
    useClass: NanjiuService // 依赖注入的类
  },
  UserService,
  {
    provide: 'USER', // 自定义依赖注入的标识
    useFactory: (...args) => { // 工厂模式
      console.log('useFactory', args)
      return new UserService() // 依赖注入的类
    },
    inject: [UserService] // 依赖注入的类
  }
]
})
export class NanjiuModule {}

可选的Provider

有时你可能存在不一定需要解决的依赖关系。例如,你的类可能依赖于配置对象,但如果没有传递任何内容,则应使用默认值。在这种情况下,依赖关系变得可选,这时候可以给对应的注入服务再增加一个@Optional()装饰器就行

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

异步Provider

useFactory可以返回一个promise 或者其他异步操作,Nest 将在实例化任何依赖(注入)此类提供程序的类之前等待promise的结果。

// nanjiu.module.ts
@Module({ // 模块装饰器
  controllers: [NanjiuController], // 控制器
  providers: [
  UserService,
  {
    provide: 'USER', // 自定义依赖注入的标识
    useFactory: async () => { // 工厂模式
      return new Promise((resolve, reject) => {
        setTimeout(() => {
          resolve(new UserService())
        }, 1000)
      })
    },
    inject: [UserService] // 依赖注入的类
  }
]
})
export class NanjiuModule {}

以上就是NestJS开发核心概念Providers类基本用法详解的详细内容,更多关于NestJS核心Providers类的资料请关注脚本之家其它相关文章!

相关文章

  • 从零开始学习Node.js系列教程一:http get和post用法分析

    从零开始学习Node.js系列教程一:http get和post用法分析

    这篇文章主要介绍了从零开始学习Node.js系列教程一:http get和post用法,结合具体实例形式分析了nodejs中get与post请求的使用方法与相关注意事项,需要的朋友可以参考下
    2017-04-04
  • 详解利用 Express 托管静态文件的方法

    详解利用 Express 托管静态文件的方法

    本篇文章主要介绍了详解利用 Express 托管静态文件的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-09-09
  • nodejs控制台打印高亮代码的实现方法

    nodejs控制台打印高亮代码的实现方法

    这篇文章主要给大家介绍了关于nodejs控制台打印高亮代码的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-05-05
  • Node.js 获取微信JS-SDK CONFIG的方法示例

    Node.js 获取微信JS-SDK CONFIG的方法示例

    这篇文章主要介绍了Node.js 获取微信JS-SDK CONFIG的方法示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-05-05
  • 使用puppeteer破解极验的滑动验证码

    使用puppeteer破解极验的滑动验证码

    这篇文章主要介绍了利用puppeteer破解极验的滑动验证功能,基本流程代码实现给大家介绍的非常详细,需要的朋友可以参考下
    2018-02-02
  • 从零学习node.js之搭建http服务器(二)

    从零学习node.js之搭建http服务器(二)

    NodeJs是什么我想大家已经很了解了,作为一个前端工程师,想要不断提升自己,一般都会接触到后端服务器的技术,NodeJs给我们提供了一个学习成本相对较低的捷径可走。下面这篇文章主要介绍了node.js中搭建http服务器的相关资料,需要的朋友可以参考下。
    2017-02-02
  • node.js利用mongoose获取mongodb数据的格式化问题详解

    node.js利用mongoose获取mongodb数据的格式化问题详解

    这篇文章主要给大家介绍了关于node.js利用mongoose获取mongodb数据的格式化问题,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习把。
    2017-10-10
  • Node.js与MySQL交互操作及其注意事项

    Node.js与MySQL交互操作及其注意事项

    这篇文章给大家主要介绍了Node.js与MySQL交互操作及其注意事项,非常的详细,有相同需求的小伙伴可以参考下
    2016-10-10
  • npm install常见报错以及问题详解

    npm install常见报错以及问题详解

    npm install总是一言难尽,下面这篇文章主要给大家介绍了关于npm install常见报错以及问题的相关资料,文中通过图文以及实例代码介绍的非常详细,需要的朋友可以参考下
    2023-02-02
  • node.js开发中使用Node Supervisor实现监测文件修改并自动重启应用

    node.js开发中使用Node Supervisor实现监测文件修改并自动重启应用

    这篇文章主要介绍了node.js开发中使用Node Supervisor实现监测文件修改并自动重启应用的功能,从而避免大量重复的CTRL+C终止程序动作,需要的朋友可以参考下
    2014-11-11

最新评论