Nodejs Nestjs服务发现与配置管理插件nestjs-consul的使用

Nodejs Nestjs服务发现与配置管理插件nestjs-consul的使用
nestjs-consul 是一个用于 NestJS 应用程序的 Consul 集成库，可以帮助你实现服务发现和服务配置管理。Consul 是一个由 HashiCorp 开发的服务网格解决方案，提供了服务发现、健康检查、KV 存储等功能。

安装

首先，你需要安装 nestjs-consul 和 Consul 客户端库：

npm install @nestjs/consul consul

配置

接下来，你需要在你的 NestJS 项目中配置 nestjs-consul。这通常涉及到创建一个模块，并在其中提供 ConsulModule。

创建模块

假设你有一个名为 AppModule 的主模块，你可以这样配置：

import { Module } from '@nestjs/common';
import { ConsulModule, ConsulService } from '@nestjs/consul';

@Module({
  imports: [
    ConsulModule.register({
      host: 'localhost', // Consul 服务器地址
      port: 8500, // Consul 服务器端口
      timeout: 10000, // 请求超时时间
    }),
  ],
  providers: [ConsulService],
})
export class AppModule {}

使用服务

你可以在你的服务或控制器中注入 ConsulService 来访问 Consul 功能。例如：

import { Injectable } from '@nestjs/common';
import { ConsulService } from '@nestjs/consul';

@Injectable()
export class DiscoveryService {
  constructor(private readonly consulService: ConsulService) {}

  async registerService() {
    await this.consulService.agent.service.register({
      name: 'my-service',
      serviceId: 'my-unique-service-id',
      address: 'localhost',
      port: 3000,
      tags: ['v1'],
      check: {
        http: 'http://localhost:3000/health',
        interval: '10s',
      },
    });
  }

  async discoverServices() {
    const services = await this.consulService.catalog.service.get('my-service');
    return services;
  }
}

服务发现

你可以通过调用 discoverServices() 方法来获取已注册的服务列表。上述代码中的 discoverServices 方法会从 Consul 中获取所有名为 my-service 的服务实例。

服务配置管理

虽然 nestjs-consul 主要关注于服务发现，但你可以利用 Consul 的 Key/Value 存储功能来存储和检索配置数据。你可以使用 ConsulService 的 kv 方法来操作这些键值对。

async getConfiguration(key: string) {
  const config = await this.consulService.kv.get(key);
  return config;
}

async setConfiguration(key: string, value: any) {
  await this.consulService.kv.put({ key, value });
}

总结

通过使用 nestjs-consul，你可以轻松地将 Consul 集成到你的 NestJS 应用程序中，以实现服务发现和配置管理。这不仅可以提高系统的可维护性和可扩展性，还可以简化微服务架构下的服务间通信。