logologo
文档仓库
文档仓库
logologo
开始

概述

第一步
控制器
提供者
模块
中间件
异常过滤器
管道
守卫
拦截器
自定义装饰器

基础

自定义提供程序
异步提供者
动态模块
注入作用域
循环依赖
模块引用
懒加载模块
执行上下文
生命周期事件
发现服务
平台无关
单元测试

技术

配置
SQL
Mongo
验证
缓存
序列化
版本控制
任务调度
队列
日志
Cookies
事件
压缩
文件上传
文件流
HTTP 模块
Session
MVC
性能(Fastify)
SSE

安全

认证
授权
加密与哈希
Helmet
CORS
CSRF
速率限制

GraphQL

快速开始
解析器
变更
订阅
标量
指令
接口
联合与枚举
字段中间件
类型映射
插件
复杂度
扩展
CLI 插件
生成SDL
共享模型
其他功能
联邦

WebSocket

网关
异常过滤器
管道
守卫
拦截器
适配器

微服务

基础
Redis
MQTT
NATS
RabbitMQ
Kafka
gRPC
自定义传输
异常过滤器
管道
守卫
拦截器
部署
独立应用程序

CLI

概述
工作区
库
用法
脚本

OpenAPI

介绍
装饰器
类型映射
操作
其他特性
安全
类型与参数
CLI 插件

实用示例

REPL
CRUD生成器
SWC
Passport(认证)
热重载
MikroORM
TypeORM
Mongoose
Sequelize
路由模块
Swagger
健康检查
CQRS
Compodoc
Prisma
Sentry
静态资源
Commander
异步本地存储
Necord
套件(原Automock)

常见问题

Serverless
HTTP 适配器
长连接
全局前缀
原始请求体
混合应用
HTTPS & 多服务器
请求生命周期
错误

开发工具

概述
CI/CD
迁移指南
API参考(官方)

生态与案例

谁在用
精彩资源

支持

支持

社区

贡献者

最后更新于: 2025/11/18 02:11:37

上一页生命周期事件
下一页平台无关

#发现服务

由 @nestjs/core 包提供的 DiscoveryService 是一个强大的工具,允许开发者动态检查和检索 NestJS 应用程序中的提供者、控制器和其他元数据。这在构建依赖运行时自省的插件、装饰器或高级功能时特别有用。通过利用 DiscoveryService,开发者可以创建更灵活和模块化的架构,实现应用程序中的自动化和动态行为。

#快速开始

在使用 DiscoveryService 之前,您需要在打算使用它的模块中导入 DiscoveryModule。这确保了该服务可用于依赖注入。以下是在 NestJS 模块中配置的示例:

import { Module } from '@nestjs/common';
import { DiscoveryModule } from '@nestjs/core';
import { ExampleService } from './example.service';

@Module({
  imports: [DiscoveryModule],
  providers: [ExampleService],
})
export class ExampleModule {}

模块设置完成后,DiscoveryService 可以被注入到任何需要动态发现的提供者或服务中。

example.service.ts
@Injectable()
export class ExampleService {
 constructor(private readonly discoveryService: DiscoveryService) {}
}

#发现提供者和控制器

DiscoveryService 的一个关键能力是检索应用中所有已注册的提供者。这对于基于特定条件动态处理提供者非常有用。以下代码片段展示了如何访问所有提供者:

const providers = this.discoveryService.getProviders();
console.log(providers);

每个提供者对象包含其实例、令牌和元数据等信息。同样,如果需要检索应用中所有已注册的控制器,可以通过以下方式实现:

const controllers = this.discoveryService.getControllers();
console.log(controllers);

该特性对于需要动态处理控制器的场景特别有用,例如分析跟踪或自动注册机制。

#提取元数据

除了发现提供者和控制器外,DiscoveryService 还能获取附加在这些组件上的元数据。这对于处理在运行时存储元数据的自定义装饰器特别有价值。

例如,考虑使用自定义装饰器为提供者标记特定元数据的情况:

import { DiscoveryService } from '@nestjs/core';

export const FeatureFlag = DiscoveryService.createDecorator();

将此装饰器应用于服务后,可以存储后续可查询的元数据:

import { Injectable } from '@nestjs/common';
import { FeatureFlag } from './custom-metadata.decorator';

@Injectable()
@FeatureFlag('experimental')
export class CustomService {}

当以这种方式将元数据附加到提供者后,DiscoveryService 可以轻松根据分配的元数据筛选提供者。以下代码片段演示了如何检索标记了特定元数据值的提供者:

const providers = this.discoveryService.getProviders();

const [provider] = providers.filter(
  (item) =>
    this.discoveryService.getMetadataByDecorator(FeatureFlag, item) ===
    'experimental',
);

console.log(
  'Providers with the "experimental" feature flag metadata:',
  provider,
);

#结论

DiscoveryService 是一个多功能且强大的工具,能够在 NestJS 应用程序中实现运行时内省。通过支持动态发现提供者、控制器和元数据,它在构建可扩展框架、插件和自动化驱动功能方面发挥着关键作用。无论是需要扫描和处理提供者、提取元数据进行高级处理,还是创建模块化和可扩展的架构,DiscoveryService 都为实现这些目标提供了高效且结构化的方法。