Node.js + Consul 实现服务注册、健康检查、配置中心

图片描述本篇主要介绍了 Node.js 如何与 Consul 进行集成，Consul 只是服务注册的一种实现，还有其它的例如 Zookeeper、Etcd 等，服务注册发现在微服务架构中扮演这一个重要的角色，伴随着服务的大量出现，服务与服务之间的配置管理、运维管理也变的难以维护，通过 Consul 可以解决这些问题，实现服务治理、服务监控。

关于 Consul 的更多知识点不在这里赘述，但是在学习本节之前还是希望您能先了解下，请移步我之前写的 微服务服务注册发现之 Consul 系列文章。

初始化 Consul 客户端

初始化一个 Consul 客户端，关于 Node.js 中的 Consul 客户端以下项目使用 node-consul 模块。

作者：五月君链接：https://www.imooc.com/article/289202来源：慕课网本文首次发布于慕课网 ，转载请注明出处，谢谢合作

核心配置说明

  • host (String, default: 127.0.0.1): 配置 Consul 地址
  • port (Integer, default: 8500): 配置 Consul 端口
  • secure (Boolean, default: false): 启用 HTTPS
  • promisify (Boolean|Function, optional): 启动 Promise 风格，默认为 Callback

示例

  1. const Consul = require('consul');
  3. const consul = new Consul({
  4.     host: '192.168.6.128',
  5.     port: 8500,
  6.     promisify: true,
  7. });

服务注册与健康检查

注册一个服务并启动健康检查

核心配置说明

  • name (String): 注册的服务名称
  • id (String, optional): 服务注册标识
  • tags (String[], optional): 服务标签
  • address (String, optional): 需要注册的服务地址（客户端）
  • port (Integer, optional): 需要注册的服务端口（客户端）
  • check (Object, optional): 服务的健康检查核心参数如下
    • http (String): 健康检查路径, interval 参数为必须设置
    • interval (String): 健康检查频率
    • timeout (String, optional): 健康检查超时时间
  • checks (Object[], optional): 如果有多个检查的路径，可采用对象数组形式，参数参照上面的 check

简单示例

  1. consul.agent.service.register({
  2.     name: serviceName,
  3.     address: '192.168.20.193',
  4.     port: 3000,
  5.     check: {
  6.         http: 'http://192.168.20.193:3000/health',
  7.         interval: '10s',
  8.         timeout: '5s',
  9.     }
  10. }, function(err, result) {
  11.     if (err) {
  12.         console.error(err);
  13.         throw err;
  14.     }
  16.     console.log(serviceName + ' 注册成功！');
  17. })

配置Consul管理控制台

Consul 提供了 Key/Value 存储，可以做为服务的配置中心，并且提供了 JSON、YAML、HCL 三种格式，在最早的 Consul 版本中只有一种 JSON 格式。

以下是我为 Consul 管控台配置的数据，如下图所示：

图片描述

服务配置中心实现

Consul 的 Key/Value 功能可以做为服务的配置中心，对于项目中一些可变化的参数信息，可配置在 Consul 中，这样当数据改变时候不用因为配置的更改而导致项目还要重新发布

获取配置信息

这个 Key 为我们配置的路径，例如我要获取上面配置的 User 数据，Key 就为 ‘develop/user’

  1. consul.kv.get(key)

更新配置信息

  • key (String): 更新的路径，例如 ‘develop/user’
  • value (String|Buffer): 更新的数据信息

注意：如果我们要更新 JSON 中的某个字段，首先我们需要先通过 consul.kv.get 读取到 JSON 对象，程序处理之后，做为 set 的第二个参数进行传递更新。

  1. consul.kv.set('develop/user', JSON.stringify(user))

HTTP API 调用

还可以直接通过 HTTP API 接口直接调用，例如：http://192.168.6.128:8500/v1/kv/develop/user?raw，如果你只想用 Consul 做为配置中心，也可以通过简单的 HTTP API 调用将数据存入本地定时更新本地配置，但这要你自己去实现。

图片描述

在Nodejs中进行测试

以下为一个简单的 Demo 展示了在 Node.js 如何与 Consul 之间进行服务注册、健康检查及配置中心的应用，可以很好的将上面讲解的理论知识进行实践。

封装 Consul

  1. // consul.js
  2. const Consul = require('consul');
  4. class ConsulConfig {
  5.     constructor () {
  6.         const serviceName = 'consul-demo';
  8.         // 初始化 consul
  9.         this.consul = new Consul({
  10.             host: '192.168.6.128',
  11.             port: 8500,
  12.             promisify: true,
  13.         });
  15.         // 服务注册与健康检查配置
  16.         this.consul.agent.service.register({
  17.             name: serviceName,
  18.             address: '192.168.20.193', // 注意：192.168.20.193 为我本地的内网 ip，通过 ifconfig 查看
  19.             port: 3000,
  20.             check: {
  21.                 http: 'http://192.168.20.193:3000/health',
  22.                 interval: '10s',
  23.                 timeout: '5s',
  24.             }
  25.         }, function(err, result) {
  26.             if (err) {
  27.                 console.error(err);
  28.                 throw err;
  29.             }
  31.             console.log(serviceName + ' 注册成功！');
  32.         })
  33.     }
  35.     async getConfig(key) {
  36.         const result = await this.consul.kv.get(key);
  38.         if (!result) {
  39.             return Promise.reject(key + '不存在');
  40.         }
  42.         return JSON.parse(result.Value);
  43.     }
  45.     // 读取 user 配置简单封装
  46.     async getUserConfig(key) {
  47.         const result = await this.getConfig('develop/user');
  49.         if (!key) {
  50.             return result;
  51.         }
  53.         return result[key];
  54.     }
  56.     // 更新 user 配置简单封装
  57.     async setUserConfig(key, val) {
  58.         const user = await this.getConfig('develop/user');
  60.         user[key] = val;
  62.         return this.consul.kv.set('develop/user', JSON.stringify(user))
  63.     }
  64. }
  66. module.exports = ConsulConfig;

编写启动文件

  1. // app.js
  2. const http = require('http');
  3. const ConsulConfig = require('./consul');
  4. const consul = new ConsulConfig();
  6. http.createServer(async (req, res) => {
  7.     const {url, method} = req;
  9.     // 测试健康检查
  10.     if (url === '/health') {
  11.         res.end('OK!');
  12.     }
  14.     // 测试动态读取数据
  15.     if (method === 'GET' && url === '/user/info') {
  16.         const user = await consul.getUserConfig();
  17.         res.end(`你好，我是 ${user.name} 今年 ${user.age}`);
  18.     }
  20.     // 测试数据更新
  21.     if (method === 'POST' && url === '/user') {
  22.         try {
  23.             await consul.setUserConfig('age', 18) // 将 age 更改为 18
  24.             res.end('OK!');
  25.         } catch (err) {
  26.             console.error(err);
  27.             res.end('ERROR!');
  28.         }
  29.     }
  30. }).listen(3000, '192.168.20.193'); // 192.168.20.193 为我本地的内网 ip，通过 ifconfig 查看

接口测试

健康检查接口

该接口在服务启动后且向 Consul 配置中心注册后，根据 consul.js 文件配置的服务注册和健康检查信息进行自动调用。

  1. $ curl http://192.168.20.193:3000/health
  2. OK!

注册成功后展示我们服务的名称及健康检查结果如下：

图片描述图片描述获取配置信息接口

  1. $ curl http://192.168.20.193:3000/user/info
  2. 你好，我是 Jack 今年 20

更新配置信息接口

  1. $ curl -X POST http://192.168.20.193:3000/user
  2. OK!

更新之后重新获取配置

可以看到使用 Consul 做为配置中心之后，在我的项目没有重启的情况下也是可以实现数据动态变更的。

  1. $ curl http://192.168.20.193:3000/user/info
  2. 你好，我是 Jack 今年 18

本节源码 Github 地址：Node.js + Consul 实现服务注册、健康检查、配置中心 Demo

总结

总结起来本文主要讲解了 Consul 的三个功能点在 Node.js 中的应用，客户端进行服务注册成功之后，则可以在 Consul 管控台看到当前的服务列表。健康检查功能，可以检查接口的可用性，进一步还可以做运维监控报警，配置中心这个对于我们开发者是很实用的，有了它可以做一些运行时配置。

Consul 的应用并非只有上面介绍的三点，通过 Consul 还可以做负载均衡、分布式锁，有没有感觉很厉害 ing，这个功能是我之前在看 Spring Cloud Consul 的时候了解到的，欢迎关注「Nodejs技术栈 」公众号，关于这些后续实践之后也会进行分享。

阅读推荐