feat: 新增 8 个语言客户端 SDK
- PHP 客户端 (kenaito-conf-php-client) - .NET 客户端 (kenaito-conf-dotnet-client) - C 客户端 (kenaito-conf-c-client) - C++ 客户端 (kenaito-conf-cpp-client) - Lua 客户端 (kenaito-conf-lua-client) - Kotlin 客户端 (kenaito-conf-kotlin-client) - Rust 客户端 (kenaito-conf-rust-client) - Ruby 客户端 (kenaito-conf-ruby-client) 每个客户端包含完整的 SDK 实现和 demo 示例,支持: - 配置拉取(全量/增量) - AES-128-CBC 解密 - 本地缓存 - 变更回调 - Token 认证 更新根目录 README.md: - 技术栈列表新增 8 种语言 - 项目结构新增 16 个目录 - 客户端接入章节新增 8 个使用示例
This commit is contained in:
@@ -6,7 +6,7 @@
|
||||
|
||||
- **后端**: Go + Gin + xorm + MySQL
|
||||
- **前端**: Vue 2 + Vite 5 + Element UI 2
|
||||
- **客户端**: Go / Java(Spring Boot 2.x & 3.x)/ Python / Node.js
|
||||
- **客户端**: Go / Java(Spring Boot 2.x & 3.x)/ Python / Node.js / PHP / .NET / C / C++ / Lua / Kotlin / Rust / Ruby
|
||||
|
||||
## 项目结构
|
||||
|
||||
@@ -23,7 +23,23 @@ kenaito-conf/
|
||||
├── kenaito-conf-python-client/ # Python 客户端 SDK(Python 3.10+)
|
||||
├── kenaito-conf-python-client-demo/ # Python 客户端示例(端口 8082)
|
||||
├── kenaito-conf-nodejs-client/ # Node.js 客户端 SDK(Node.js 18+)
|
||||
└── kenaito-conf-nodejs-client-demo/ # Node.js 客户端示例(端口 8083)
|
||||
├── kenaito-conf-nodejs-client-demo/ # Node.js 客户端示例(端口 8083)
|
||||
├── kenaito-conf-php-client/ # (待测试)PHP 客户端 SDK(PHP 8.0+)
|
||||
├── kenaito-conf-php-client-demo/ # (待测试)PHP 客户端示例
|
||||
├── kenaito-conf-dotnet-client/ # (待测试).NET 客户端 SDK(.NET 6.0+)
|
||||
├── kenaito-conf-dotnet-client-demo/ # (待测试).NET 客户端示例
|
||||
├── kenaito-conf-c-client/ # (待测试)C 客户端 SDK(libcurl + OpenSSL)
|
||||
├── kenaito-conf-c-client-demo/ # (待测试)C 客户端示例
|
||||
├── kenaito-conf-cpp-client/ # (待测试)C++ 客户端 SDK(libcurl + OpenSSL)
|
||||
├── kenaito-conf-cpp-client-demo/ # (待测试)C++ 客户端示例
|
||||
├── kenaito-conf-lua-client/ # (待测试)Lua 客户端 SDK(Lua 5.3+)
|
||||
├── kenaito-conf-lua-client-demo/ # (待测试)Lua 客户端示例
|
||||
├── kenaito-conf-kotlin-client/ # (待测试)Kotlin 客户端 SDK(Kotlin 1.9+)
|
||||
├── kenaito-conf-kotlin-client-demo/ # (待测试)Kotlin 客户端示例
|
||||
├── kenaito-conf-rust-client/ # (待测试)Rust 客户端 SDK(Rust 1.70+)
|
||||
├── kenaito-conf-rust-client-demo/ # (待测试)Rust 客户端示例
|
||||
├── kenaito-conf-ruby-client/ # (待测试)Ruby 客户端 SDK(Ruby 2.7+)
|
||||
└── kenaito-conf-ruby-client-demo/ # (待测试)Ruby 客户端示例
|
||||
```
|
||||
|
||||
## 快速开始
|
||||
@@ -257,6 +273,224 @@ const allConfigs = client.getAll();
|
||||
client.stop();
|
||||
```
|
||||
|
||||
### PHP 客户端
|
||||
|
||||
适用于 PHP 8.0+ 项目。
|
||||
|
||||
**1. 安装**
|
||||
|
||||
```bash
|
||||
cd kenaito-conf-php-client
|
||||
composer install
|
||||
```
|
||||
|
||||
**2. 使用**
|
||||
|
||||
```php
|
||||
use KenaitoConf\Config;
|
||||
use KenaitoConf\ConfigClient;
|
||||
|
||||
$config = new Config([
|
||||
'baseUrl' => 'http://localhost:8080',
|
||||
'appName' => 'kenaito-springboot-demo',
|
||||
'env' => 'daily',
|
||||
'syncInterval' => 30,
|
||||
]);
|
||||
|
||||
$client = new ConfigClient($config);
|
||||
|
||||
$client->onChange(function ($changed) {
|
||||
foreach ($changed as $k => $v) {
|
||||
echo "config changed: $k = $v\n";
|
||||
}
|
||||
});
|
||||
|
||||
$client->start();
|
||||
$value = $client->get('database.host');
|
||||
$all = $client->getAll();
|
||||
```
|
||||
|
||||
### .NET 客户端
|
||||
|
||||
适用于 .NET 6.0+ 项目。
|
||||
|
||||
**1. 引入依赖**
|
||||
|
||||
```xml
|
||||
<ProjectReference Include="..\kenaito-conf-dotnet-client\KenaitoConf.csproj" />
|
||||
```
|
||||
|
||||
**2. 使用**
|
||||
|
||||
```csharp
|
||||
using KenaitoConf;
|
||||
|
||||
var config = new Config
|
||||
{
|
||||
BaseUrl = "http://localhost:8080",
|
||||
AppName = "kenaito-springboot-demo",
|
||||
Env = "daily",
|
||||
SyncInterval = 30,
|
||||
};
|
||||
|
||||
var client = new ConfigClient(config);
|
||||
client.OnChange(changed => {
|
||||
foreach (var kv in changed)
|
||||
Console.WriteLine($"config changed: {kv.Key} = {kv.Value}");
|
||||
});
|
||||
|
||||
await client.StartAsync();
|
||||
var value = client.Get("database.host");
|
||||
```
|
||||
|
||||
### C 客户端
|
||||
|
||||
适用于嵌入式或高性能场景,依赖 libcurl + OpenSSL。
|
||||
|
||||
**编译**
|
||||
|
||||
```bash
|
||||
gcc -o demo kenaito-conf-c-client/main.c -lcurl -lssl -lcrypto
|
||||
```
|
||||
|
||||
### C++ 客户端
|
||||
|
||||
依赖 libcurl + OpenSSL,C++17。
|
||||
|
||||
**编译**
|
||||
|
||||
```bash
|
||||
g++ -std=c++17 -o demo kenaito-conf-cpp-client/main.cpp -lcurl -lssl -lcrypto -lpthread
|
||||
```
|
||||
|
||||
### Lua 客户端
|
||||
|
||||
适用于 Lua 5.3+ 项目(如 OpenResty/Nginx 网关)。
|
||||
|
||||
**1. 安装**
|
||||
|
||||
```bash
|
||||
cd kenaito-conf-lua-client
|
||||
luarocks install kenaito-conf-client-1.0.0-1.rockspec
|
||||
```
|
||||
|
||||
**2. 使用**
|
||||
|
||||
```lua
|
||||
local ConfigClient = require("kenaito-conf")
|
||||
|
||||
local config = {
|
||||
baseUrl = "http://localhost:8080",
|
||||
appName = "kenaito-springboot-demo",
|
||||
env = "daily",
|
||||
syncInterval = 30,
|
||||
}
|
||||
|
||||
local client = ConfigClient.new(config)
|
||||
client:on_change(function(changed)
|
||||
for k, v in pairs(changed) do
|
||||
print("config changed: " .. k .. " = " .. v)
|
||||
end
|
||||
end)
|
||||
client:start()
|
||||
```
|
||||
|
||||
### Kotlin 客户端
|
||||
|
||||
适用于 Kotlin 1.9+ 项目。
|
||||
|
||||
**1. 编译**
|
||||
|
||||
```bash
|
||||
cd kenaito-conf-kotlin-client
|
||||
./gradlew build
|
||||
```
|
||||
|
||||
**2. 使用**
|
||||
|
||||
```kotlin
|
||||
import kenait.conf.Config
|
||||
import kenait.conf.ConfigClient
|
||||
|
||||
val config = Config(
|
||||
baseUrl = "http://localhost:8080",
|
||||
appName = "kenaito-springboot-demo",
|
||||
env = "daily",
|
||||
syncInterval = 30,
|
||||
)
|
||||
|
||||
val client = ConfigClient(config)
|
||||
client.onChange { changed ->
|
||||
changed.forEach { (k, v) -> println("config changed: $k = $v") }
|
||||
}
|
||||
client.start()
|
||||
val value = client.get("database.host")
|
||||
```
|
||||
|
||||
### Rust 客户端
|
||||
|
||||
适用于 Rust 1.70+ 项目。
|
||||
|
||||
**1. 在 Cargo.toml 中添加**
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
kenaito-conf = { path = "../kenaito-conf-rust-client" }
|
||||
```
|
||||
|
||||
**2. 使用**
|
||||
|
||||
```rust
|
||||
use kenaito_conf::{Config, ConfigClient};
|
||||
|
||||
let config = Config {
|
||||
base_url: "http://localhost:8080".to_string(),
|
||||
app_name: "kenaito-springboot-demo".to_string(),
|
||||
env: "daily".to_string(),
|
||||
sync_interval: 30,
|
||||
..Default::default()
|
||||
};
|
||||
|
||||
let client = ConfigClient::new(config);
|
||||
client.on_change(|changed| {
|
||||
for (k, v) in changed { println!("config changed: {} = {}", k, v); }
|
||||
});
|
||||
client.start().await.unwrap();
|
||||
let value = client.get("database.host");
|
||||
```
|
||||
|
||||
### Ruby 客户端
|
||||
|
||||
适用于 Ruby 2.7+ 项目。
|
||||
|
||||
**1. 安装**
|
||||
|
||||
```bash
|
||||
cd kenaito-conf-ruby-client
|
||||
gem build kenaito-conf.gemspec
|
||||
gem install kenaito-conf-1.0.0.gem
|
||||
```
|
||||
|
||||
**2. 使用**
|
||||
|
||||
```ruby
|
||||
require 'kenaito_conf'
|
||||
|
||||
config = KenaitoConf::Config.new(
|
||||
base_url: 'http://localhost:8080',
|
||||
app_name: 'kenaito-springboot-demo',
|
||||
env: 'daily',
|
||||
sync_interval: 30
|
||||
)
|
||||
|
||||
client = KenaitoConf::ConfigClient.new(config)
|
||||
client.on_change do |changed|
|
||||
changed.each { |k, v| puts "config changed: #{k} = #{v}" }
|
||||
end
|
||||
client.start
|
||||
value = client.get('database.host')
|
||||
```
|
||||
|
||||
## API 概览
|
||||
|
||||
### 管理端 API(需 JWT 认证)
|
||||
|
||||
Reference in New Issue
Block a user