From 98c5b62d0d78776153a25209c2a2e7587beb0b66 Mon Sep 17 00:00:00 2001 From: Odboy Date: Sun, 8 Feb 2026 21:02:57 +0800 Subject: [PATCH] =?UTF-8?q?feat(client):=20=E6=B7=BB=E5=8A=A0=20Node.js=20?= =?UTF-8?q?=E5=AE=A2=E6=88=B7=E7=AB=AF=E5=8F=8A=E7=A4=BA=E4=BE=8B=E5=BA=94?= =?UTF-8?q?=E7=94=A8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 新增 nodejs-client 模块，提供 ConfigClient 配置拉取、定时同步、变更监听 - 使用 Node.js 内置 crypto 模块实现 AES 解密，零外部依赖 - 新增 nodejs-client-demo Express 示例应用，端口 8083 - 更新 README.md，补充 Python 和 Node.js 客户端使用说明 - 修复 fetchAllConfigs API 响应格式判断逻辑 --- README.md | 100 +++- nodejs-client-demo/app.js | 70 +++ nodejs-client-demo/config-cache.json | 14 + nodejs-client-demo/package-lock.json | 845 +++++++++++++++++++++++++++ nodejs-client-demo/package.json | 13 + nodejs-client/README.md | 99 ++++ nodejs-client/lib/cache.js | 25 + nodejs-client/lib/client.js | 160 +++++ nodejs-client/lib/config.js | 12 + nodejs-client/lib/crypto.js | 24 + nodejs-client/lib/index.js | 1 + nodejs-client/lib/listener.js | 19 + nodejs-client/package.json | 20 + 13 files changed, 1400 insertions(+), 2 deletions(-) create mode 100644 nodejs-client-demo/app.js create mode 100644 nodejs-client-demo/config-cache.json create mode 100644 nodejs-client-demo/package-lock.json create mode 100644 nodejs-client-demo/package.json create mode 100644 nodejs-client/README.md create mode 100644 nodejs-client/lib/cache.js create mode 100644 nodejs-client/lib/client.js create mode 100644 nodejs-client/lib/config.js create mode 100644 nodejs-client/lib/crypto.js create mode 100644 nodejs-client/lib/index.js create mode 100644 nodejs-client/lib/listener.js create mode 100644 nodejs-client/package.json diff --git a/README.md b/README.md index 14b9537..e01f4ca 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ - **后端**: Go + Gin + xorm + MySQL - **前端**: Vue 2 + Vite 5 + Element UI 2 -- **客户端**: Go / Java（Spring Boot 2.x & 3.x） +- **客户端**: Go / Java（Spring Boot 2.x & 3.x）/ Python / Node.js ## 项目结构 @@ -18,7 +18,11 @@ kenaito-conf/ ├── kenaito-conf-springboot2-client/ # Java Spring Boot 2.x 客户端 SDK（JDK 8+） ├── kenaito-conf-springboot2-client-demo/# Spring Boot 2.x 客户端示例（端口 8081） ├── kenaito-conf-springboot3-client/ # Java Spring Boot 3 客户端 SDK（JDK 11+，预留升级路径） -└── kenaito-conf-springboot3-client-demo/# Spring Boot 3 客户端示例（端口 8082，需 JDK 17+） +├── kenaito-conf-springboot3-client-demo/# Spring Boot 3 客户端示例（端口 8082，需 JDK 17+） +├── python-client/ # Python 客户端 SDK（Python 3.10+） +├── python-client-demo/ # Python 客户端示例（端口 8082） +├── nodejs-client/ # Node.js 客户端 SDK（Node.js 18+） +└── nodejs-client-demo/ # Node.js 客户端示例（端口 8083） ``` ## 快速开始 @@ -160,6 +164,98 @@ private String configValue; > **注意：** 升级到 Spring Boot 3 需先将编译目标改为 JDK 17，并更新 `spring-boot.version` 为 3.x、Spring Framework 为 6.x。 +### Python 客户端 + +适用于 Python 3.10+ 项目。 + +**1. 安装** + +```bash +cd python-client +pip3 install -e . +``` + +**2. 使用** + +```python +from kenaito_conf import Config, ConfigClient + +config = Config( + base_url="http://localhost:8080", + app_name="my-app", + env="daily", + sync_interval=30, +) + +client = ConfigClient(config) + +# 监听配置变更 +def on_change(changed): + for k, v in changed.items(): + print(f"config changed: {k} = {v}") + +client.on_change(on_change) + +# 启动客户端（拉取配置 + 开启定时同步） +client.start() + +# 获取配置 +value = client.get("database.host") +all_configs = client.get_all() + +# 停止 +client.stop() +``` + +### Node.js 客户端 + +适用于 Node.js 18+ 项目。 + +**1. 安装** + +```bash +cd nodejs-client +npm link +``` + +然后在你的项目中链接： + +```bash +npm link kenaito-conf +``` + +**2. 使用** + +```javascript +import { Config, ConfigClient } from 'kenaito-conf'; + +const config = new Config({ + baseUrl: 'http://localhost:8080', + appName: 'my-app', + env: 'daily', + syncInterval: 30, +}); + +const client = new ConfigClient(config); + +// 监听配置变更 +client.onChange((changed) => { + for (const [k, v] of Object.entries(changed)) { + console.log(`config changed: ${k} = ${v}`); + } +}); + +// 启动客户端（拉取配置 + 开启定时同步） +await client.start(); + +// 获取配置 +const value = client.get('database.host'); +const allConfigs = client.getAll(); + +// 停止 +client.stop(); +``` + ## API 概览 ### 管理端 API（需 JWT 认证） diff --git a/nodejs-client-demo/app.js b/nodejs-client-demo/app.js new file mode 100644 index 0000000..8a23a0f --- /dev/null +++ b/nodejs-client-demo/app.js @@ -0,0 +1,70 @@ +import express from 'express'; +import { Config, ConfigClient } from 'kenaito-conf'; + +const configValues = { + 'database.host': process.env.DATABASE_HOST || '192.168.1.1', + 'database.port': process.env.DATABASE_PORT || '8888', + 'database.name': process.env.DATABASE_NAME || 'xxxx', + 'database.user': process.env.DATABASE_USER || 'xxxx', + 'database.password': process.env.DATABASE_PASSWORD || 'xxxxxxxx', +}; + +let client = null; + +function onConfigChanged(changed) { + for (const [k, v] of Object.entries(changed)) { + if (k in configValues) { + configValues[k] = v; + console.log(`config updated: ${k} = ${v}`); + } + } +} + +async function createClient() { + const cfg = new Config({ + baseUrl: process.env.KENAITO_BASE_URL || 'http://localhost:8080', + appName: process.env.KENAITO_APP_NAME || 'kenaito-springboot-demo', + env: process.env.KENAITO_PROFILE || 'daily', + version: process.env.KENAITO_VERSION || 'latest', + token: process.env.KENAITO_TOKEN || '', + syncInterval: parseInt(process.env.KENAITO_SYNC_INTERVAL || '30', 10), + cacheDir: process.env.KENAITO_CACHE_DIR || '.', + }); + const c = new ConfigClient(cfg); + c.onChange(onConfigChanged); + await c.start(); + return c; +} + +const app = express(); + +app.get('/', (req, res) => { + res.type('application/json').send(JSON.stringify(configValues, null, 2)); +}); + +app.get('/health', (req, res) => { + res.send('OK'); +}); + +const port = parseInt(process.env.SERVER_PORT || '8083', 10); + +async function main() { + try { + client = await createClient(); + const remote = client.getAll(); + for (const k of Object.keys(configValues)) { + if (k in remote) { + configValues[k] = remote[k]; + } + } + console.info(`loaded ${Object.keys(remote).length} configs from remote`); + } catch (err) { + console.error('failed to init config client, using local defaults:', err); + } + + app.listen(port, '0.0.0.0', () => { + console.info(`server started on port ${port}`); + }); +} + +main(); diff --git a/nodejs-client-demo/config-cache.json b/nodejs-client-demo/config-cache.json new file mode 100644 index 0000000..06b7a46 --- /dev/null +++ b/nodejs-client-demo/config-cache.json @@ -0,0 +1,14 @@ +{ + "crypto.secretKey": "k9#mP2$vL7qR4xN8", + "database.host": "127.0.0.1", + "database.name": "kenaito_conf", + "database.password": "1234567", + "database.port": "3306", + "database.user": "root", + "jwt.expireHours": "24", + "jwt.secret": "kenaito-conf-jwt-secret-2026", + "kenaito.config.encrypt-secret": "c4c20a0c6e991b26c34b0cefe78252c8", + "kenaito.config.global-encrypt-secret": "6879c141d108fb37a24d547611c80095", + "latest.fetch.timestamp": "1792052626435", + "server.port": "8084" +} \ No newline at end of file diff --git a/nodejs-client-demo/package-lock.json b/nodejs-client-demo/package-lock.json new file mode 100644 index 0000000..1d22a71 --- /dev/null +++ b/nodejs-client-demo/package-lock.json @@ -0,0 +1,845 @@ +{ + "name": "kenaito-conf-demo", + "version": "1.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "kenaito-conf-demo", + "version": "1.0.0", + "dependencies": { + "express": "^4.18.0", + "kenaito-conf": "file:../nodejs-client" + } + }, + "../nodejs-client": { + "name": "kenaito-conf", + "version": "1.0.0", + "license": "MIT", + "engines": { + "node": ">=18.0.0" + } + }, + "node_modules/accepts": { + "version": "1.3.8", + "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.8.tgz", + "integrity": "sha512-PYAthTa2m2VKxuvSD3DPC/Gy+U+sOA1LAuT8mkmRuvw+NACSaeXEQ+NHcVF7rONl6qcaxV3Uuemwawk+7+SJLw==", + "license": "MIT", + "dependencies": { + "mime-types": "~2.1.34", + "negotiator": "0.6.3" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/array-flatten": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/array-flatten/-/array-flatten-1.1.1.tgz", + "integrity": "sha512-PCVAQswWemu6UdxsDFFX/+gVeYqKAod3D3UVm91jHwynguOwAvYPhx8nNlM++NqRcK6CxxpUafjmhIdKiHibqg==", + "license": "MIT" + }, + "node_modules/body-parser": { + "version": "1.20.8", + "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.20.8.tgz", + "integrity": "sha512-JNcyFQ64OiijEkPzUBTCe+hyPXUD/3LEldGQ6iF5LR1w00mx9o7xtDWHXBY2iItjdCFGoilOLNQbH943ut7pHA==", + "license": "MIT", + "dependencies": { + "bytes": "~3.1.2", + "content-type": "~1.0.5", + "debug": "2.6.9", + "depd": "2.0.0", + "destroy": "~1.2.0", + "http-errors": "~2.0.1", + "iconv-lite": "~0.4.24", + "on-finished": "~2.4.1", + "qs": "~6.16.0", + "raw-body": "~2.5.3", + "type-is": "~1.6.18", + "unpipe": "~1.0.0" + }, + "engines": { + "node": ">= 0.8", + "npm": "1.2.8000 || >= 1.4.16" + } + }, + "node_modules/bytes": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz", + "integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/call-bind-apply-helpers": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz", + "integrity": "sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/call-bound": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/call-bound/-/call-bound-1.0.4.tgz", + "integrity": "sha512-+ys997U96po4Kx/ABpBCqhA9EuxJaQWDQg7295H4hBphv3IZg0boBKuwYpt4YXp6MZ5AmZQnU/tyMTlRpaSejg==", + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.2", + "get-intrinsic": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/content-disposition": { + "version": "0.5.4", + "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-0.5.4.tgz", + "integrity": "sha512-FveZTNuGw04cxlAiWbzi6zTAL/lhehaWbTtgluJh4/E95DqMwTmha3KZN1aAWA8cFIhHzMZUvLevkw5Rqk+tSQ==", + "license": "MIT", + "dependencies": { + "safe-buffer": "5.2.1" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/content-type": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/content-type/-/content-type-1.0.5.tgz", + "integrity": "sha512-nTjqfcBFEipKdXCv4YDQWCfmcLZKm81ldF0pAopTvyrFGVbcR6P/VAAd5G7N+0tTr8QqiU0tFadD6FK4NtJwOA==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/cookie": { + "version": "0.7.2", + "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.7.2.tgz", + "integrity": "sha512-yki5XnKuf750l50uGTllt6kKILY4nQ1eNIQatoXEByZ5dWgnKqbnqmTrBE5B4N7lrMJKQ2ytWMiTO2o0v6Ew/w==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/cookie-signature": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/cookie-signature/-/cookie-signature-1.0.7.tgz", + "integrity": "sha512-NXdYc3dLr47pBkpUCHtKSwIOQXLVn8dZEuywboCOJY/osA0wFSLlSawr3KN8qXJEyX66FcONTH8EIlVuK0yyFA==", + "license": "MIT" + }, + "node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "license": "MIT", + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/depd": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/depd/-/depd-2.0.0.tgz", + "integrity": "sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/destroy": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/destroy/-/destroy-1.2.0.tgz", + "integrity": "sha512-2sJGJTaXIIaR1w4iJSNoN0hnMY7Gpc/n8D4qSCJw8QqFWXf7cuAgnEHxBpweaVcPevC2l3KpjYCx3NypQQgaJg==", + "license": "MIT", + "engines": { + "node": ">= 0.8", + "npm": "1.2.8000 || >= 1.4.16" + } + }, + "node_modules/dunder-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.1.tgz", + "integrity": "sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==", + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.1", + "es-errors": "^1.3.0", + "gopd": "^1.2.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/ee-first": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/ee-first/-/ee-first-1.1.1.tgz", + "integrity": "sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow==", + "license": "MIT" + }, + "node_modules/encodeurl": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-2.0.0.tgz", + "integrity": "sha512-Q0n9HRi4m6JuGIV1eFlmvJB7ZEVxu93IrMyiMsGC0lrMJMWzRgx6WGquyfQgZVb31vhGgXnfmPNNXmxnOkRBrg==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/es-define-property": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.1.tgz", + "integrity": "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-errors": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", + "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-object-atoms": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.2.tgz", + "integrity": "sha512-HWcBoN6NileqtSydK2FqHbS/LoDd2pqrnQHLyJzBj4kOp/ky2MWMN694xOfkK8/SnUsW2DH7EfyVlydKCsm1Zw==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/escape-html": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/escape-html/-/escape-html-1.0.3.tgz", + "integrity": "sha512-NiSupZ4OeuGwr68lGIeym/ksIZMJodUGOSCZ/FSnTxcrekbvqrgdUxlJOMpijaKZVjAJrWrGs/6Jy8OMuyj9ow==", + "license": "MIT" + }, + "node_modules/etag": { + "version": "1.8.1", + "resolved": "https://registry.npmjs.org/etag/-/etag-1.8.1.tgz", + "integrity": "sha512-aIL5Fx7mawVa300al2BnEE4iNvo1qETxLrPI/o05L7z6go7fCw1J6EQmbK4FmJ2AS7kgVF/KEZWufBfdClMcPg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/express": { + "version": "4.22.3", + "resolved": "https://registry.npmjs.org/express/-/express-4.22.3.tgz", + "integrity": "sha512-Bdcs4+3qlpVlx2NRn6fgX2Ue2/gGRaPeawebgclM0ERSCqDpA+owF1fdPwjJUTAJWMTuAaxjDf+hzb0/4eKvvw==", + "license": "MIT", + "dependencies": { + "accepts": "~1.3.8", + "array-flatten": "1.1.1", + "body-parser": "~1.20.5", + "content-disposition": "~0.5.4", + "content-type": "~1.0.4", + "cookie": "~0.7.1", + "cookie-signature": "~1.0.6", + "debug": "2.6.9", + "depd": "2.0.0", + "encodeurl": "~2.0.0", + "escape-html": "~1.0.3", + "etag": "~1.8.1", + "finalhandler": "~1.3.1", + "fresh": "~0.5.2", + "http-errors": "~2.0.0", + "merge-descriptors": "1.0.3", + "methods": "~1.1.2", + "on-finished": "~2.4.1", + "parseurl": "~1.3.3", + "path-to-regexp": "~0.1.13", + "proxy-addr": "~2.0.7", + "qs": "~6.16.0", + "range-parser": "~1.2.1", + "safe-buffer": "5.2.1", + "send": "~0.19.0", + "serve-static": "~1.16.2", + "setprototypeof": "1.2.0", + "statuses": "~2.0.1", + "type-is": "~1.6.18", + "utils-merge": "1.0.1", + "vary": "~1.1.2" + }, + "engines": { + "node": ">= 0.10.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/finalhandler": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-1.3.2.tgz", + "integrity": "sha512-aA4RyPcd3badbdABGDuTXCMTtOneUCAYH/gxoYRTZlIJdF0YPWuGqiAsIrhNnnqdXGswYk6dGujem4w80UJFhg==", + "license": "MIT", + "dependencies": { + "debug": "2.6.9", + "encodeurl": "~2.0.0", + "escape-html": "~1.0.3", + "on-finished": "~2.4.1", + "parseurl": "~1.3.3", + "statuses": "~2.0.2", + "unpipe": "~1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/forwarded": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/forwarded/-/forwarded-0.2.0.tgz", + "integrity": "sha512-buRG0fpBtRHSTCOASe6hD258tEubFoRLb4ZNA6NxMVHNw2gOcwHo9wyablzMzOA5z9xA9L1KNjk/Nt6MT9aYow==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/fresh": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/fresh/-/fresh-0.5.2.tgz", + "integrity": "sha512-zJ2mQYM18rEFOudeV4GShTGIQ7RbzA7ozbU9I/XBpm7kqgMywgmylMwXHxZJmkVoYkna9d2pVXVXPdYTP9ej8Q==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/function-bind": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", + "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-intrinsic": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.3.0.tgz", + "integrity": "sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ==", + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.2", + "es-define-property": "^1.0.1", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.1.1", + "function-bind": "^1.1.2", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "has-symbols": "^1.1.0", + "hasown": "^2.0.2", + "math-intrinsics": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/get-proto/-/get-proto-1.0.1.tgz", + "integrity": "sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g==", + "license": "MIT", + "dependencies": { + "dunder-proto": "^1.0.1", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/gopd": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz", + "integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-symbols": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.1.0.tgz", + "integrity": "sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/hasown": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.4.tgz", + "integrity": "sha512-T2UbfbBEF32wiepXIsMlTW9+dDYC6wMh/t/vYA4tuOMKqWz/n3vr1NFSxQiyP+zk2mXsoMA/i/7qV6LKut1t1A==", + "license": "MIT", + "dependencies": { + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/http-errors": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-2.0.1.tgz", + "integrity": "sha512-4FbRdAX+bSdmo4AUFuS0WNiPz8NgFt+r8ThgNWmlrjQjt1Q7ZR9+zTlce2859x4KSXrwIsaeTqDoKQmtP8pLmQ==", + "license": "MIT", + "dependencies": { + "depd": "~2.0.0", + "inherits": "~2.0.4", + "setprototypeof": "~1.2.0", + "statuses": "~2.0.2", + "toidentifier": "~1.0.1" + }, + "engines": { + "node": ">= 0.8" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/iconv-lite": { + "version": "0.4.24", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", + "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", + "license": "MIT", + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "license": "ISC" + }, + "node_modules/ipaddr.js": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-1.9.1.tgz", + "integrity": "sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g==", + "license": "MIT", + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/kenaito-conf": { + "resolved": "../nodejs-client", + "link": true + }, + "node_modules/math-intrinsics": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/math-intrinsics/-/math-intrinsics-1.1.0.tgz", + "integrity": "sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/media-typer": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", + "integrity": "sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/merge-descriptors": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-1.0.3.tgz", + "integrity": "sha512-gaNvAS7TZ897/rVaZ0nMtAyxNyi/pdbjbAwUpFQpN70GqnVfOiXpeUUMKRBmzXaSQ8DdTX4/0ms62r2K+hE6mQ==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/methods": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/methods/-/methods-1.1.2.tgz", + "integrity": "sha512-iclAHeNqNm68zFtnZ0e+1L2yUIdvzNoauKU4WBA3VvH/vPFieF7qfRlwUZU+DA9P9bPXIS90ulxoUoCH23sV2w==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz", + "integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==", + "license": "MIT", + "bin": { + "mime": "cli.js" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "license": "MIT", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "license": "MIT" + }, + "node_modules/negotiator": { + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.3.tgz", + "integrity": "sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/object-inspect": { + "version": "1.13.4", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.4.tgz", + "integrity": "sha512-W67iLl4J2EXEGTbfeHCffrjDfitvLANg0UlX3wFUUSTx92KXRFegMHUVgSqE+wvhAbi4WqjGg9czysTV2Epbew==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/on-finished": { + "version": "2.4.1", + "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.4.1.tgz", + "integrity": "sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg==", + "license": "MIT", + "dependencies": { + "ee-first": "1.1.1" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/parseurl": { + "version": "1.3.3", + "resolved": "https://registry.npmjs.org/parseurl/-/parseurl-1.3.3.tgz", + "integrity": "sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/path-to-regexp": { + "version": "0.1.13", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-0.1.13.tgz", + "integrity": "sha512-A/AGNMFN3c8bOlvV9RreMdrv7jsmF9XIfDeCd87+I8RNg6s78BhJxMu69NEMHBSJFxKidViTEdruRwEk/WIKqA==", + "license": "MIT" + }, + "node_modules/proxy-addr": { + "version": "2.0.8", + "resolved": "https://registry.npmjs.org/proxy-addr/-/proxy-addr-2.0.8.tgz", + "integrity": "sha512-5nnx0yGyVUcY6t9RnWcARWtwT9F1D8O9rt08htPvnd49W1IgZtmLkhu9WfMzQj1cFxjHIO6connUNVW5k7AVyQ==", + "license": "MIT", + "dependencies": { + "forwarded": "0.2.0", + "ipaddr.js": "1.9.1" + }, + "engines": { + "node": ">= 0.10" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/qs": { + "version": "6.16.1", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.16.1.tgz", + "integrity": "sha512-5Px6J7rfHBAGUhNQ3es4YzcOdBBw0SDcVtThJml4RdnKw4tKs2epA0kPZ+K8X+WiHktT93RHVcQ/3ym5aTCgtg==", + "license": "BSD-3-Clause", + "dependencies": { + "es-define-property": "^1.0.1", + "side-channel": "^1.1.1" + }, + "engines": { + "node": ">=0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/range-parser": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz", + "integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/raw-body": { + "version": "2.5.3", + "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-2.5.3.tgz", + "integrity": "sha512-s4VSOf6yN0rvbRZGxs8Om5CWj6seneMwK3oDb4lWDH0UPhWcxwOWw5+qk24bxq87szX1ydrwylIOp2uG1ojUpA==", + "license": "MIT", + "dependencies": { + "bytes": "~3.1.2", + "http-errors": "~2.0.1", + "iconv-lite": "~0.4.24", + "unpipe": "~1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/safe-buffer": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", + "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/safer-buffer": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", + "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", + "license": "MIT" + }, + "node_modules/send": { + "version": "0.19.2", + "resolved": "https://registry.npmjs.org/send/-/send-0.19.2.tgz", + "integrity": "sha512-VMbMxbDeehAxpOtWJXlcUS5E8iXh6QmN+BkRX1GARS3wRaXEEgzCcB10gTQazO42tpNIya8xIyNx8fll1OFPrg==", + "license": "MIT", + "dependencies": { + "debug": "2.6.9", + "depd": "2.0.0", + "destroy": "1.2.0", + "encodeurl": "~2.0.0", + "escape-html": "~1.0.3", + "etag": "~1.8.1", + "fresh": "~0.5.2", + "http-errors": "~2.0.1", + "mime": "1.6.0", + "ms": "2.1.3", + "on-finished": "~2.4.1", + "range-parser": "~1.2.1", + "statuses": "~2.0.2" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/send/node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "license": "MIT" + }, + "node_modules/serve-static": { + "version": "1.16.3", + "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-1.16.3.tgz", + "integrity": "sha512-x0RTqQel6g5SY7Lg6ZreMmsOzncHFU7nhnRWkKgWuMTu5NN0DR5oruckMqRvacAN9d5w6ARnRBXl9xhDCgfMeA==", + "license": "MIT", + "dependencies": { + "encodeurl": "~2.0.0", + "escape-html": "~1.0.3", + "parseurl": "~1.3.3", + "send": "~0.19.1" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/setprototypeof": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.2.0.tgz", + "integrity": "sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw==", + "license": "ISC" + }, + "node_modules/side-channel": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.1.1.tgz", + "integrity": "sha512-6x6dK6zJdpTzF4sQeNYxwtvBzf6Eg4GtlesS94HOvTudUeyK2WXAaIfmDgsyslYrRBeFIlsi54AYsFGUuhmvrQ==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "object-inspect": "^1.13.4", + "side-channel-list": "^1.0.1", + "side-channel-map": "^1.0.1", + "side-channel-weakmap": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-list": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/side-channel-list/-/side-channel-list-1.0.1.tgz", + "integrity": "sha512-mjn/0bi/oUURjc5Xl7IaWi/OJJJumuoJFQJfDDyO46+hBWsfaVM65TBHq2eoZBhzl9EchxOijpkbRC8SVBQU0w==", + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "object-inspect": "^1.13.4" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-map": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/side-channel-map/-/side-channel-map-1.0.1.tgz", + "integrity": "sha512-VCjCNfgMsby3tTdo02nbjtM/ewra6jPHmpThenkTYh8pG9ucZ/1P8So4u4FGBek/BjpOVsDCMoLA/iuBKIFXRA==", + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.5", + "object-inspect": "^1.13.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-weakmap": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/side-channel-weakmap/-/side-channel-weakmap-1.0.2.tgz", + "integrity": "sha512-WPS/HvHQTYnHisLo9McqBHOJk2FkHO/tlpvldyrnem4aeQp4hai3gythswg6p01oSoTl58rcpiFAjF2br2Ak2A==", + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.5", + "object-inspect": "^1.13.3", + "side-channel-map": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/statuses": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.2.tgz", + "integrity": "sha512-DvEy55V3DB7uknRo+4iOGT5fP1slR8wQohVdknigZPMpMstaKJQWhwiYBACJE3Ul2pTnATihhBYnRhZQHGBiRw==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/toidentifier": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.1.tgz", + "integrity": "sha512-o5sSPKEkg/DIQNmH43V0/uerLrpzVedkUh8tGNvaeXpfpuwjKenlSox/2O/BTlZUtEe+JG7s5YhEz608PlAHRA==", + "license": "MIT", + "engines": { + "node": ">=0.6" + } + }, + "node_modules/type-is": { + "version": "1.6.18", + "resolved": "https://registry.npmjs.org/type-is/-/type-is-1.6.18.tgz", + "integrity": "sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==", + "license": "MIT", + "dependencies": { + "media-typer": "0.3.0", + "mime-types": "~2.1.24" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/unpipe": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", + "integrity": "sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/utils-merge": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/utils-merge/-/utils-merge-1.0.1.tgz", + "integrity": "sha512-pMZTvIkT1d+TFGvDOqodOclx0QWkkgi6Tdoa8gC8ffGAAqz9pzPTZWAybbsHHoED/ztMtkv/VoYTYyShUn81hA==", + "license": "MIT", + "engines": { + "node": ">= 0.4.0" + } + }, + "node_modules/vary": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", + "integrity": "sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg==", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + } + } +} diff --git a/nodejs-client-demo/package.json b/nodejs-client-demo/package.json new file mode 100644 index 0000000..60c9384 --- /dev/null +++ b/nodejs-client-demo/package.json @@ -0,0 +1,13 @@ +{ + "name": "kenaito-conf-demo", + "version": "1.0.0", + "description": "Kenaito Config Center Node.js Demo", + "type": "module", + "scripts": { + "start": "node app.js" + }, + "dependencies": { + "kenaito-conf": "file:../nodejs-client", + "express": "^4.18.0" + } +} diff --git a/nodejs-client/README.md b/nodejs-client/README.md new file mode 100644 index 0000000..80fad24 --- /dev/null +++ b/nodejs-client/README.md @@ -0,0 +1,99 @@ +# Kenaito Config Center Node.js Client + +## 安装 + +### 安装到本地仓库（推荐） + +将包注册为全局符号链接，之后任意项目都可以通过 `npm link kenaito-conf` 引用： + +```bash +cd nodejs-client +npm link +``` + +在你的项目中使用： + +```bash +npm link kenaito-conf +``` + +### 直接引用 + +```bash +# 在你的项目 package.json 中 +"dependencies": { + "kenaito-conf": "file:../nodejs-client" +} +``` + +```bash +npm install +``` + +## 快速开始 + +```javascript +import { Config, ConfigClient } from 'kenaito-conf'; + +const config = new Config({ + baseUrl: 'http://localhost:8080', + appName: 'my-app', + env: 'daily', + syncInterval: 30, +}); + +const client = new ConfigClient(config); + +// 监听配置变更 +client.onChange((changed) => { + for (const [k, v] of Object.entries(changed)) { + console.log(`config changed: ${k} = ${v}`); + } +}); + +// 启动客户端（拉取配置 + 开启定时同步） +await client.start(); + +// 获取配置 +const value = client.get('database.host'); +const allConfigs = client.getAll(); + +// 停止 +client.stop(); +``` + +## 配置项 + +| 参数 | 说明 | 默认值 | +|------|------|--------| +| `baseUrl` | 配置中心地址 | 必填 | +| `appName` | 应用名称 | 必填 | +| `env` | 环境（dev/daily/prod） | `dev` | +| `version` | 配置版本 | `latest` | +| `token` | 认证令牌 | 空 | +| `syncInterval` | 同步间隔（秒） | `60` | +| `ignoreGlobal` | 是否忽略全局配置 | `false` | +| `cacheDir` | 本地缓存目录 | `.` | + +## Demo + +```bash +cd nodejs-client-demo +npm install +node app.js +``` + +Demo 默认监听 `8083` 端口，访问 `http://localhost:8083/` 查看配置。 + +环境变量覆盖： + +| 环境变量 | 说明 | 默认值 | +|----------|------|--------| +| `SERVER_PORT` | 服务端口 | `8083` | +| `KENAITO_BASE_URL` | 配置中心地址 | `http://localhost:8080` | +| `KENAITO_APP_NAME` | 应用名称 | `kenaito-nodejs-demo` | +| `KENAITO_PROFILE` | 环境 | `daily` | +| `KENAITO_VERSION` | 配置版本 | `latest` | +| `KENAITO_TOKEN` | 认证令牌 | 空 | +| `KENAITO_SYNC_INTERVAL` | 同步间隔（秒） | `30` | +| `KENAITO_CACHE_DIR` | 缓存目录 | `.` | diff --git a/nodejs-client/lib/cache.js b/nodejs-client/lib/cache.js new file mode 100644 index 0000000..7df4465 --- /dev/null +++ b/nodejs-client/lib/cache.js @@ -0,0 +1,25 @@ +import fs from 'node:fs'; +import path from 'node:path'; + +const CACHE_FILE = 'config-cache.json'; + +export class Cache { + constructor(cacheDir = '.') { + this.cacheDir = cacheDir; + } + + write(data) { + const filePath = path.join(this.cacheDir, CACHE_FILE); + fs.writeFileSync(filePath, JSON.stringify(data, null, 2), 'utf8'); + } + + read() { + const filePath = path.join(this.cacheDir, CACHE_FILE); + try { + const content = fs.readFileSync(filePath, 'utf8'); + return JSON.parse(content); + } catch { + return null; + } + } +} diff --git a/nodejs-client/lib/client.js b/nodejs-client/lib/client.js new file mode 100644 index 0000000..cee77a4 --- /dev/null +++ b/nodejs-client/lib/client.js @@ -0,0 +1,160 @@ +import { Config } from './config.js'; +import { Cache } from './cache.js'; +import { Listener } from './listener.js'; +import { decryptConfig } from './crypto.js'; + +export class ConfigClient { + constructor(config) { + this.config = config; + this.cache = new Cache(config.cacheDir); + this.listener = new Listener(); + this.configs = {}; + this.secret = ''; + this.globalSecret = ''; + this.lastTime = 0; + this.started = false; + this.timer = null; + } + + onChange(handler) { + this.listener.onChange(handler); + } + + get(key) { + return this.configs[key] ?? null; + } + + getAll() { + return { ...this.configs }; + } + + async start() { + if (this.started) { + return; + } + this.started = true; + + try { + await this.fetchAll(); + } catch (err) { + console.warn('[ConfigClient] fetch all configs error:', err.message, ', trying cache'); + const cached = this.cache.read(); + if (cached) { + this.applyConfigs(cached); + console.info('[ConfigClient] loaded', Object.keys(this.configs).length, 'configs from cache'); + } else { + throw new Error(`fetch configs failed and no cache: ${err.message}`); + } + } + + this.timer = setInterval(() => { + this.fetchChanged().catch((err) => { + console.error('[ConfigClient] sync error:', err); + }); + }, this.config.syncInterval * 1000); + } + + stop() { + if (this.timer) { + clearInterval(this.timer); + this.timer = null; + } + } + + async fetchAll() { + const url = `${this.config.baseUrl}/api/fetchAllConfigs?appName=${encodeURIComponent(this.config.appName)}&env=${encodeURIComponent(this.config.env)}&version=${encodeURIComponent(this.config.version)}&ignoreGlobal=${this.config.ignoreGlobal}`; + const resp = await fetch(url, { + headers: this.config.token ? { Authorization: `Bearer ${this.config.token}` } : {}, + signal: AbortSignal.timeout(10000), + }); + if (!resp.ok) { + throw new Error(`HTTP ${resp.status}`); + } + const data = await resp.json(); + if (data.code != null && data.code !== 0) { + throw new Error(`server error: ${data.msg || 'unknown'}`); + } + + const secret = data['kenaito.config.encrypt-secret']; + if (secret) { + this.secret = secret; + } + const globalSecret = data['kenaito.config.global-encrypt-secret']; + if (globalSecret) { + this.globalSecret = globalSecret; + } + const ts = data['latest.fetch.timestamp']; + if (ts) { + this.lastTime = parseInt(ts, 10); + } + + this.cache.write(data); + this.applyConfigs(data); + console.info('[ConfigClient] fetched', Object.keys(this.configs).length, 'configs'); + } + + async fetchChanged() { + const url = `${this.config.baseUrl}/api/fetchChangedConfigs`; + const payload = { + appName: this.config.appName, + env: this.config.env, + version: this.config.version, + lastTime: this.lastTime, + ignoreGlobal: this.config.ignoreGlobal, + }; + const resp = await fetch(url, { + method: 'POST', + headers: { + 'Content-Type': 'application/json', + ...(this.config.token ? { Authorization: `Bearer ${this.config.token}` } : {}), + }, + body: JSON.stringify(payload), + signal: AbortSignal.timeout(10000), + }); + if (!resp.ok) { + throw new Error(`HTTP ${resp.status}`); + } + const result = await resp.json(); + if (result.code !== 0) { + throw new Error(`server error code: ${result.code}`); + } + + const changedData = result.data || {}; + const ts = changedData['latest.fetch.timestamp']; + if (ts) { + this.lastTime = parseInt(ts, 10); + } + delete changedData['latest.fetch.timestamp']; + + const changed = {}; + for (const [k, v] of Object.entries(changedData)) { + changed[k] = this.tryDecrypt(v); + } + + Object.assign(this.configs, changed); + this.listener.notify(changed); + console.info('[ConfigClient]', Object.keys(changed).length, 'configs changed'); + } + + applyConfigs(data) { + for (const [k, v] of Object.entries(data)) { + if (k.startsWith('kenaito.') || k === 'latest.fetch.timestamp') { + continue; + } + if (typeof v !== 'string') { + continue; + } + this.configs[k] = this.tryDecrypt(v); + } + } + + tryDecrypt(value) { + let decrypted = decryptConfig(this.secret, value); + if (decrypted === value && this.globalSecret) { + decrypted = decryptConfig(this.globalSecret, value); + } + return decrypted; + } +} + +export { Config } from './config.js'; diff --git a/nodejs-client/lib/config.js b/nodejs-client/lib/config.js new file mode 100644 index 0000000..2c30069 --- /dev/null +++ b/nodejs-client/lib/config.js @@ -0,0 +1,12 @@ +export class Config { + constructor(options = {}) { + this.baseUrl = options.baseUrl || ''; + this.appName = options.appName || ''; + this.env = options.env || 'dev'; + this.version = options.version || 'latest'; + this.token = options.token || ''; + this.syncInterval = options.syncInterval || 60; + this.ignoreGlobal = options.ignoreGlobal || false; + this.cacheDir = options.cacheDir || '.'; + } +} diff --git a/nodejs-client/lib/crypto.js b/nodejs-client/lib/crypto.js new file mode 100644 index 0000000..2f0237e --- /dev/null +++ b/nodejs-client/lib/crypto.js @@ -0,0 +1,24 @@ +import crypto from 'node:crypto'; + +const CRYPT_PREFIX = '{Cipher}'; + +export function decryptConfig(secret, data) { + if (!data.startsWith(CRYPT_PREFIX)) { + return data; + } + const encrypted = data.slice(CRYPT_PREFIX.length); + return decryptWithAES(secret, encrypted); +} + +export function decryptWithAES(key, data) { + const md5Hash = crypto.createHash('md5').update(key).digest('hex'); + const aesKey = md5Hash.slice(16); + const cipherText = Buffer.from(data, 'base64'); + const iv = Buffer.alloc(16, 0); + const decipher = crypto.createDecipheriv('aes-128-cbc', aesKey, iv); + decipher.setAutoPadding(false); + let plainText = Buffer.concat([decipher.update(cipherText), decipher.final()]); + const padding = plainText[plainText.length - 1]; + plainText = plainText.slice(0, plainText.length - padding); + return plainText.toString('utf8'); +} diff --git a/nodejs-client/lib/index.js b/nodejs-client/lib/index.js new file mode 100644 index 0000000..02a61c2 --- /dev/null +++ b/nodejs-client/lib/index.js @@ -0,0 +1 @@ +export { ConfigClient, Config } from './client.js'; diff --git a/nodejs-client/lib/listener.js b/nodejs-client/lib/listener.js new file mode 100644 index 0000000..e035b74 --- /dev/null +++ b/nodejs-client/lib/listener.js @@ -0,0 +1,19 @@ +export class Listener { + constructor() { + this.handlers = []; + } + + onChange(handler) { + this.handlers.push(handler); + } + + notify(changed) { + for (const handler of this.handlers) { + try { + handler(changed); + } catch (err) { + console.error('[ConfigClient] change handler error:', err); + } + } + } +} diff --git a/nodejs-client/package.json b/nodejs-client/package.json new file mode 100644 index 0000000..229bdb1 --- /dev/null +++ b/nodejs-client/package.json @@ -0,0 +1,20 @@ +{ + "name": "kenaito-conf", + "version": "1.0.0", + "description": "Kenaito Config Center Node.js Client", + "type": "module", + "main": "lib/index.js", + "exports": { + ".": "./lib/index.js" + }, + "engines": { + "node": ">=18.0.0" + }, + "keywords": [ + "config", + "configuration", + "config-center" + ], + "author": "odboy", + "license": "MIT" +}