项目简介
Configly是现代的配置/静态数据键值存储系统,本项目为其Node.js和JavaScript客户端库。它为开发者提供便捷方式获取和管理Configly后端的静态配置数据,开发者可将文案、样式和配置值等静态数据存于Configly,通过该库在应用中获取。非技术人员能在Web界面直接修改数据,应用程序近乎实时接收更新,无需等待应用部署或应用商店审核。
项目的主要特性和功能
- 数据获取API:可从Configly后端获取字符串、JSON数据、布尔值和数字。
- Web界面管理:通过Web界面(Configulator)修改配置值,查看更改历史,无需部署代码。
- 高性能后端:具备高可用性、高吞吐量和低延迟特点。
- 智能缓存:客户端库采用智能缓存机制,减少对服务器的请求。
- 多语言支持:支持多种语言,客户端库不断扩展。
- 类型丰富:支持字符串、数字、布尔值和JSON数据等多种数据类型。
安装使用步骤
安装
假设已下载项目源码文件,在新文件夹中运行以下命令安装客户端库:
sh
npm install configly-js
使用
1. 获取API密钥
需有Configly账户,访问https://www.config.ly/signup注册。注册后,从https://www.config.ly/config获取API密钥。
2. 创建第一个配置
在https://www.config.ly/config中,通过“Add”按钮创建新配置。例如,创建名为greetings
的JSON Object or Array
配置,值为['hello', 'hola', '你好', 'नमस्ते']
,并点击“Send to Clients”保存。
3. 初始化库
在JavaScript文件中初始化Configly库:
js
const API_KEY = 'YOUR_API_KEY';
const Configly = require('configly-js').Configly;
const configly = Configly.init(API_KEY);
4. 获取配置
使用以下代码获取配置: ```js (async () => { try { const greetings = await configly.get('greetings'); if (!greetings) { console.log("Cannot find key on Configly's server! Wrong API Key?"); return; } console.log("To you, Config.ly says:"); greetings.forEach( (v) => console.log(v) );
} catch (error) {
const { status, message, originalError } = error;
console.log(Sorry something went wrong: ${status}: ${message}
);
}
})();
运行该文件:
sh
node file.js
```
在浏览器中使用
可通过npm下载SDK并在网站中引入,也可通过以下URL访问库:https://cdn.jsdelivr.net/npm/configly-js@2.0.4/dist/config.js 在页面中引入脚本后,使用以下代码加载配置: ```html
```
错误处理
当get()
方法遇到错误时,会返回一个拒绝的Promise,包含status
、message
和originalError
属性。可根据status
的值进行相应的错误处理:
js
Configly.getInstance().get('best_star_wars_movie')
.then((movie) => {
doSomethingMagical(movie);
}).catch((error) => {
if (error.status == 'CONNECTION_ERROR') {
// Place retry code here
} else {
console.log(error.status, error.message, error.originalError);
}
});
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】