微服务管家:NestJS 如何使用服务发现 Consul 实现高效的微服务节点管理

前言

微服务架构中,服务发现是一项基础且关键的功能,它允许服务实例在网络中被动态发现。Consul 是一种服务网格解决方案,提供了服务发现、运行状况检查,过去和现代应用程序的连接等功能。

本教程将向您展示如何在 NestJS 框架中集成 Consul 实现服务发现的能力。

什么是 Consul

Consul 是由 HashiCorp 公司开发的一种服务网格解决方案,它提供完整的服务网格特性,并且可以在任何运行您的应用程序的环境中运行。

它具有以下几个主要功能:

  1. 服务发现 - Consul 客户端可以注册服务,例如一个web服务器,以便其他客户端可以使用 Consul 来发现服务的位置。
  2. 运行状况检查 - Consul 客户端可以提供任何数量的运行状况检查服务,以便可以自动移除不健康的服务实例。
  3. KV 存储 - Consul 提供一个简单的键值对存储,用于存储配置和其他用途。
  4. 多数据中心 - Consul 支持多数据中心,这是其特别适用于大型公司和企业的原因。

使用步骤

以下是在 NestJS 应用程序中集成 Consul 用于服务发现的步骤:

一、 安装 Consul

在您的本地机器或服务器上安装 Consul。详细的安装教程可以在 Consul 的官方网站找到。您可以通过它们的指南快速启动和运行 Consul 代理。

# 例如,在macOS上安装 Consul
brew install consul# 启动 Consul agent
consul agent -dev

二、初始化 NestJS 项目

如果您还没有 NestJS 项目,可以用以下命令创建一个:

nest new project-name

三、安装必要的库

为了使 NestJS 能够与 Consul 集成,您需要安装 node-consul,这是 Consul 的 Node.js 客户端库。

npm install consul

四、创建 Consul 服务模块

在 NestJS 项目中创建一个新模块用于封装 Consul 基本操作:

// consul.service.tsimport { Injectable } from '@nestjs/common';
import * as Consul from 'consul';@Injectable()
export class ConsulService {private consul: Consul.Consul;constructor() {this.consul = new Consul({// Consul 的配置项host: 'localhost',port: 8500 // 根据实际端口号修改});}async registerService(serviceInfo: Consul.Agent.Service.RegisterOptions) {return new Promise<void>((resolve, reject) => {this.consul.agent.service.register(serviceInfo, (err) => {if (err) {reject(err);return;}resolve();});});}// 其他 Consul 的操作方法
}

五、 在 NestJS 应用生命周期中应用 Consul 服务

让 NestJS 在应用启动时自动注册服务,并在应用关闭时自动注销服务。

  1. 在您的主模块(例如 AppModule)中导入刚才创建的 ConsulService 服务,并在模块中注册:

    // app.module.ts
    import { Module } from '@nestjs/common';
    import { ConsulService } from './consul.service';@Module({// ...providers: [ConsulService],
    })
    export class AppModule {}
  2. 修改您的主 AppService 或自定义一个新服务来实现 NestJS 应用的生命周期的钩子 onModuleInitonApplicationShutdown

    // app.service.ts
    import { Injectable, OnModuleInit, OnApplicationShutdown } from '@nestjs/common';
    import { ConsulService } from './consul.service';@Injectable()
    export class AppService implements OnModuleInit, OnApplicationShutdown {constructor(private consulService: ConsulService) {}async onModuleInit(): Promise<void> {// 当模块初始化时注册服务try {await this.consulService.registerService({name: 'nestjs-service',// 其他需要的配置});console.log('服务成功注册到Consul');} catch (error) {console.error('服务注册失败:', error);}}async onApplicationShutdown(signal?: string): Promise<void> {// 应用关闭时注销服务try {// 具体的服务注销逻辑console.log(`服务注销成功`);} catch (error) {console.error('服务注销失败:', error);}}
    }
  3. AppService 添加到您的主应用模块中去。这样可以确保注册的服务在 NestJS 应用生命周期中被正确管理:

    // app.module.ts
    // ...
    import { AppService } from './app.service';@Module({// ...providers: [ConsulService, AppService],
    })
    export class AppModule {}

这样,当您的 NestJS 服务启动时,它会自动向 Consul 注册服务,当服务关闭时,它又会自动从 Consul 注销服务。

如何调用 Consul 注册的微服务

消费通过 Consul 发现的服务意味着您需要从 Consul 获取服务的地址和端口信息,然后基于这些信息去发起请求。以下步骤将介绍如何在 NestJS 应用中实现这一点。

一、查询服务

在我们创建的 ConsulService 服务中,实现一个方法来获取所有活跃的服务实例。

// consul.service.ts// ... (其他代码)@Injectable()
export class ConsulService {// ... (其他代码)async discoverService(serviceName: string): Promise<Consul.Agent.Service[]> {return new Promise((resolve, reject) => {this.consul.agent.service.list((err, result) => {if (err) {reject(err);return;}const services = [];for (let id in result) {if (result[id].Service === serviceName) {services.push(result[id]);}}resolve(services);});});}
}

二、实现服务消费逻辑

在您要消费服务的地方(比如某个服务或控制器中),调用刚才实现的 discoverService 方法获取服务实例。

// some.service.tsimport { Injectable } from '@nestjs/common';
import { HttpService } from '@nestjs/axios';
import { ConsulService } from './consul.service';
import { firstValueFrom } from 'rxjs';@Injectable()
export class SomeService {constructor(private httpService: HttpService,private consulService: ConsulService) {}async consumeService(serviceName: string) {try {const services = await this.consulService.discoverService(serviceName);if (services.length === 0) {throw new Error('服务未发现');}// 假设我们只关注第一个服务实例const serviceInstance = services[0];// 构建服务实例的地址,以便请求const url = `http://${serviceInstance.Address}:${serviceInstance.Port}/path-to-service-resource`;// 发送请求到服务实例const response = await firstValueFrom(this.httpService.get(url));return response.data;} catch (error) {throw error;}}
}

注意:在实际环境中,您可能希望实现更复杂的逻辑,比如负载均衡(选择多个实例)或者使用失败重试机制等。

三、调用服务

在控制器或者其他需要消费服务的地方调用 SomeService

// some.controller.tsimport { Controller, Get } from '@nestjs/common';
import { SomeService } from './some.service';@Controller()
export class SomeController {constructor(private readonly someService: SomeService) {}@Get()async consume() {const data = await this.someService.consumeService('nestjs-service');return data;}
}

这样,当您的控制器收到 HTTP 请求时,它将通过 SomeService 使用 Consul 服务发现机制来消费远端的服务。

总结

集成 Consul 到 NestJS 应用中是微服务架构中一个关键的步骤。通过这一流程,您的服务可以被动态地发现和管理。在微服务架构中,你可以根据实际业务场景,针对性地实现高可用性和负载均衡等策略。使用 NestJS 框架和 Consul 服务发现,你可以构建一个既灵活又可扩展的微服务系统。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/602466.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

大津法(OTSU)点云强度信息分割

目录 一、相关介绍 二、计算方法 三、实现代码 四、运行结果 一、相关介绍 大津法是一种灰度图像自适应的阈值分割方法,1979年由日本学者大津提出。大津法根据图像的灰度分布,将图像分成背景和前景两部分,前

SiC电机控制器(逆变器)发展概况及技术方向

SiC电机控制器&#xff08;逆变器&#xff09;发展概况及技术方向 1.概述2.电动汽车动力系统设计趋势3.栅极驱动器和驱动电源配置4.结论 tips&#xff1a;资料来自网上搜集&#xff0c;仅供学习使用。 1.概述 2022年到2023年&#xff0c;第三代半导体碳化硅被推上了新的热潮。…

前端uniapp的tab选项卡for循环切换、开通VIP实战案例【带源码/最新】

目录 效果图图1图2 源码最后 这个案例是uniapp&#xff0c;同样也适用Vue项目&#xff0c;语法一样for循环&#xff0c;点击切换 效果图 图1 图2 源码 直接代码复制查看效果 <template><view class"my-helper-service-pass"><view class"tab…

【Vue】灵魂拷问

1、说说Vue的优缺点 优点&#xff1a;渐进式&#xff0c;组件化&#xff0c;轻量级&#xff0c;虚拟dom&#xff0c;响应式&#xff0c;单页面路由&#xff0c;数据与视图分开缺点&#xff1a;单页面不利于seo&#xff0c;不支持IE8以下&#xff0c;首屏加载时间长 2、为什么…

第14课 利用openCV快速数豆豆

除了检测运动&#xff0c;openCV还能做许多有趣且实用的事情。其实openCV和FFmpeg一样都是宝藏开源项目&#xff0c;貌似简单的几行代码功能实现背后其实是复杂的算法在支撑。有志于深入学习的同学可以在入门后进一步研究算法的实现&#xff0c;一定会受益匪浅。 这节课&#…

(Python + Selenium4)Web自动化测试自学Day1

目录 文章声明⭐⭐⭐让我们开始今天的学习吧&#xff01;自动打开Chrome浏览器实现自动搜索元素定位常用的元素定位方式By.IDBy.CLASS_NAMEBy.TAG_NAMEBy.NAMEBy.LINK_TEXTBy.PARTIAL_LINK_TEXTBy.CSS_SELECTOR根据id定位根据class定位根据属性定位组合定位 By.XPATH 文章声明⭐…

js的for嵌套和数组的map+some两种方法实现两个对象数组进行比对,得到一个期望的新数组

项目需求有个数据需要处理,现有两个数组arr1和arr2,其中 arr1为[“香蕉”, “苹果”, “梨子”],arr2为 [{ checked: true, name: “苹果” }] ,现在想实现的目的是,只要有arr1里的项与arr2项里的name一致的话就将其checked设为true,否则设为false,最终得到的数组是arr3,…

#error 在C语言中的作用

1、#error命令是C/C语言的预处理命令之一 #error 是C语言中的预处理指令之一&#xff0c;用于在编译时生成一个错误消息。当编译器遇到 #error 指令时&#xff0c;会立即停止编译&#xff0c;并将指定的错误消息输出到编译器的错误信息中。 在给定的代码中&#xff0c;#error…

ubuntu/linux 如何在虚拟环境中下载MPI-IS mesh

麻了&#xff0c;又碰到这个库了&#xff0c;记录一下&#xff0c;希望对大家有用 下载代码&#xff1a;https://github.com/MPI-IS/mesh 安装libboost-dev sudo apt-get install libboost-dev激活自己的虚拟环境&#xff0c;下面的操作在自己的虚拟环境里进行 在mesh-master…

vivado 不支持的SDC命令

不支持以下SDC命令。 • set_clock_gating_check • set_clock_transition • set_ideal_latency • set_ideal_network • set_ideal_transition • set_max_fanout • set_drive • set_driving_cell • set_fanout_load • set_input_transition • se…

玩转Mysql 二(MySQL的目录结构与表结构)

一路走来,所有遇到的人,帮助过我的、伤害过我的都是朋友,没有一个是敌人。 一、MYSQL目录结构及命令存放路径 1、查看MYSQL数据文件存放路径 mysql> show variables like datadir; 注意:生成环境要提前规划好数据存放目录,存储一般以T为单位闪盘。 2、MYSQL命令存放…

系统学习Python——类(class):静态方法(staticmethod)和类方法(classmethod)-[基础知识]

分类目录&#xff1a;《系统学习Python》总目录 我们可以在类中定义两种方法&#xff0c;它们不需要一个实例就可以被调用&#xff1a;静态方法&#xff08;staticmethod&#xff09;大致与一个类中简单的无实例函数的工作方式类似&#xff0c;而类方法则被传人一个类而不是一个…

Note: A Woman Doctor Lina

A woman doctor Lina 女医生丽娜 Born in a pigs’ nest, Lina led a poor life in her childhood. 出生在猪圈里&#xff0c;丽娜过着贫穷的童年生活。 led nest She was looked down upon by the children of her generation. 她被她同时代的孩子瞧不起。 generation look…

day 38 动态规划(1)

day38 代码随想录 2024.1.6 开始动态规划&#xff01; 递归五部曲&#xff1a; 确定dp数组含义确定递推公式dp数组初始化遍历顺序举例推导dp数组 1. 50斐波那契数列 经典的动态规划入门第一题&#xff0c;直接递归五部曲&#xff0c; 本题递归数组是具体要求的值&#xff0c…

每日一题 - 240106 - D - Loong and Takahashi

D - Loong and Takahashi TAG - 回形矩阵 回形矩阵 回形矩阵时间复杂度 - O ( N N ) O(N \times N) O(NN) // #include<bits/stdc.h> using namespace std; // #define int long long const int N50; int g[N][N];void solve() {int n;scanf("%d",&n )…

私有云平台搭建openstack和ceph结合搭建手册

OpenStack与云计算 什么是云&#xff1f; 如何正确理解云&#xff0c;可以从以下几个方面。 云的构成。 用户&#xff1a;对用户而言是透明无感知的&#xff0c;不用关心底层构成&#xff0c;只需要知道利用云完成自己任务即可。 云提供商&#xff1a;对云资产管理和运维。 云…

CentOS安装JDK

目录 一、文件准备 1、目录创建 2、导入jdk压缩文件 3、解压压缩包 二、配置 1.配置环境变量 2.使用source命令生效环境变量 3、测试 总结 一、文件准备 1、目录创建 在/usr/local下创建java 目录 2、导入jdk压缩文件 3、解压压缩包 tar -zxf jdk-8u201-linux-x64.t…

[C#]使用onnxruntime部署yolov8-onnx印章检测

【官方框架地址】 https://github.com/ultralytics/ultralytics.git 【算法介绍】 YOLOv8是目标检测领域中的一种先进算法&#xff0c;它是YOLO&#xff08;You Only Look Once&#xff09;系列算法的最新发展。YOLO算法以其高效和实时的性能而著名&#xff0c;而YOLOv8则进一…

计算机毕业设计----ssm大学生兼职论坛

项目介绍 该项目是一个大学生校园兼职平台&#xff0c;分为前台和后台功能&#xff0c;主要用户有三种角色&#xff1a;分别是商家、学生、管理员。商家可以发布兼职信息&#xff0c;发布后&#xff0c;管理员进入后台确认信息是否有效&#xff0c;并且审核该兼职信息。学生登…

vue接入高德地图

使用 JSAPI 安全模式,代理服务请以_AMapService 作为一级路由 index.html <script type"text/javascript">window._AMapSecurityConfig {serviceHost: "http://xx.xx.xx.xx:8223/_AMapService"};</script><script type"text/javascr…