初始版本

Author: shuhua718

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 网易云信
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,62 @@
+# yunxin-server-sdk
+
+![GitHub](https://img.shields.io/badge/license-MIT-blue.svg)
+![GitHub release](https://img.shields.io/github/release/netease-im/yunxin-im-server-sdk.svg)
+![java_language](https://img.shields.io/badge/java--language-1.8-blue.svg)
+
+## 核心特性
+
+* 封装了云信服务器api的sdk
+* 支持重试，支持配置不同的重试策略，也支持自定义重试策略
+* 支持多域名高可用，故障自动切换
+* 支持多域名服务器调度，故障切换快速生效
+* 支持trace-id，方便问题排查
+* 支持metrics，支持prometheus格式输出
+* 支持使用raw-client直接发起请求，也支持使用面向对象的client发起请求
+* 支持云信以下功能模块的api：即时通讯（IM）、实时音视频（RTC）、短信（SMS）、直播（LIVE）、点播（VOD）、房间组件（NEROOM）、会议（MEETING）
+* 支持云信私有化环境使用
+
+## 架构图
+
+<img src="docs/img.png" width="60%" height="60%">
+
+## 引入依赖
+
+```
+require (
+    github.com/netease-im/yunxin-server-sdk-golang v0.0.1
+)
+```
+
+## 更新日志
+
+具体见：[更新日志](update.md)
+
+
+## 快速开始
+
+具体见：[快速开始](docs/quick_start.md)
+
+
+## 关于重试
+
+具体见：[retry](docs/retry.md)
+
+
+## 关于多域名
+
+具体见：[endpoint](docs/endpoint.md)
+
+
+## 关于监控
+
+具体见：[metrics](docs/metrics.md)
+
+
+## 关于私有化
+
+具体见：[privatization](docs/privatization.md)
+
+## 其他
+
+具体见：[others](docs/others.md)

docs/endpoint.md

@@ -0,0 +1,40 @@
+
+
+## 多域名切换机制
+
+* 内置了多个api域名，并且会定时从云信服务器更新最新api域名列表
+* sdk会定时探测各个api域名
+* sdk会根据各个api域名的请求结果和探测结果来动态调度（选择延迟最低、成功率最高的api域名）
+* 默认切换机制参考：`DynamicEndpointSelector`，你也可以自定义
+
+```go
+package main
+
+import (
+	"time"
+
+	"github.com/netease-im/yunxin-server-sdk-golang/src/core"
+	"github.com/netease-im/yunxin-server-sdk-golang/src/core/base"
+	"github.com/netease-im/yunxin-server-sdk-golang/src/core/endpoint"
+)
+
+func main() {
+	// 初始化
+	appkey := "xx"
+	appsecret := "xx"
+	timeoutMillis := 5000 * time.Millisecond
+
+	// EndpointSelector可以自定义
+	endpointFetcher := endpoint.NewDynamicEndpointFetcher(base.BizIM, appkey)
+	endpointSelector := endpoint.NewDynamicEndpointSelector(base.BizIM, endpointFetcher)
+
+	// 创建客户端
+	client := core.NewYunxinApiHttpClientBuilder(base.BizIM, appkey, appsecret).
+		TimeoutMillis(timeoutMillis).
+		EndpointSelector(endpointSelector).
+		Build()
+
+	// 使用client进行API调用
+	_ = client
+}
+```

docs/img.png

@@ -0,0 +1 @@
+<mxfile host="Electron" modified="2025-06-17T09:58:58.102Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/15.7.3 Chrome/91.0.4472.164 Electron/13.6.1 Safari/537.36" etag="rGVqDZyBwlRk8sXcez0K" version="15.7.3" type="device"><diagram id="NSgs6cozZJK3MAMpw4jA" name="第 1 页">1Vptk6I4EP41qbr74BQQXpKP4MvuVu3c7p13+/IRISg3KG6Io86v3wSCAsnM3I3oqmWVSSc05Hk6ne5GAIfL3Tsarhf3eUwyYBnxDsARsCwTQ8h/hGRfSTzXqwRzmsZy0lEwTZ+IFBpSukljUrQmsjzPWLpuC6N8tSIRa8lCSvNte1qSZ+27rsM5UQTTKMxU6dc0ZotKiizvKH9P0vmivrPp4mpkGdaT5UqKRRjn24YIjgEc0jxnVWu5G5JMgFfjUl03eWb08GCUrNh/uWC/Ru+LT/6nezvZO8HXP364/0wHUstjmG3kguXDsn2NAM03q5gIJQaAwXaRMjJdh5EY3XLOuWzBlhnvmbypPlR9B0IZ2TVE8iHfkXxJGN3zKXJ0YCKJmDQZy5P9bYMA5FSyRQN8p54YStLnB+VHXHhDQqOH6c/Rv9vVjy/L5CmLcvNxU0D3+8BVYNpvVrt0NSgI5SsbFPHDabgJeFJudX6WzldcNssZy5d8IEmzbJhnOS2VwgRFJIq4vGA0fyCNkRlybMfohwLstAgQersE2DoCLPtcBHjPEbBgbD2IslQs9jIMJImlZyB2Z67j9sOAaXQo0OwB29VQYJ6NAqS6irEDAh9waxENEyAu8UAwAtgsGwHAw3oOPwbcjD9jMKO8NRet3/IHwV5F3u+nsdchKXYIim0dSciaQbcvkqy2o7KRhqSajyZJ7rk4whqOMEAeQCMwRsCfgHpr9wQ0xpMJxucG2oJtoB2NQzINDdBn2wym5uDklu7bAPuigSfiKxpGib0DEBI8jF3R9U88ZX8JCV1rvwISLIUERgVmtwcutK8OXKiAKxSnUXGD8B4imJfgNS8Kr63A++G+V2QNY8I/2kDFwzOjp1Cx6xVcSxOsXxRYRwH2r7+HN4jsIQW+GmTVLGh6P71BZKFxbciq6c3HD1/GtwgtvjZo1bTlrvzcILg2+nXgaqtHavwFxjYIkAyCkQ98U+QdAQ+CoUgJsQ18JIJg7IIA90pBHBKUaPNyN0JklvRUGWkz4NV1wGbGhy9JgRqlKaiSVeyLSijvRVlYFGnUBrKNOtml7Jto3zmy970xMto1O3vZeRbYIt/QiLxuQSRuVWFV+Bv4Ohp4axklWcjSx3btVoe5vMPnPBV1o+e8l2N0aKvWI6+yGrXWriLYLt+4uKOIhXROmKKoNIHDst9uFepJLeoAuMw8q6RUlGgcURDg21DsULPcqjw7HQO/rOegCfChakucqI/hjGRtEwpl0SziBkCoppq2TONY6AgoKdKncFbqE6azFhCUoDgBcEZaY3rR8Ltb9/AqQN4ENKvt2nqzcQdh/ZqiLjn3Yk6DttKalVpBniQFOQv9am6hq0kc/HJZofPd0i8P63JF6bv7dNDEjB3i6Rw0dj0Y9pTpDbqZnq2ekYecpe+anJYMNR/py0M3/fPBW+s9NAeU7r9JdWWncZXoHi8re//Ls79YIas83evGeiVHgNUtxLz1COiGCocSxIWOADWlONXsahMy7jyM2maEMXzFkMreZ0JTvi5xQnRiDQ83jJl7ZMN6xZ55p6vt5CikaaovvYW6ElO1PbdlYZ51o6aqpmg03NYv9W4pJqn3XD8xCULt8ME8zWrq0KZzxVuiEN49/m+hmn789wcc/wQ=</diagram></mxfile>

docs/infra.drawio

@@ -0,0 +1,58 @@
+
+
+## metrics
+
+* 默认开启，可以关闭
+* 支持配置统计周期
+* 有2个维度，一个是endpoint维度，一个是uri维度，统计了请求的成功/失败数量，耗时的平均、最大、分位数（p50/p75/p90/p99/p999）
+* 支持以prometheus格式输出，也支持自定义输出
+* 可以定时获取数据，也可以使用MetricsCallback主动接受数据推送
+* 数据字段参考 `Stats` 结构体和 `PrometheusConverter` 相关代码
+
+```go
+package main
+
+import (
+	"encoding/json"
+	"fmt"
+	"time"
+
+	"github.com/netease-im/yunxin-server-sdk-golang/src/core"
+	"github.com/netease-im/yunxin-server-sdk-golang/src/core/base"
+	"github.com/netease-im/yunxin-server-sdk-golang/src/core/metrics"
+)
+
+func main() {
+	// 初始化
+	appkey := "xx"
+	appsecret := "xx"
+	timeoutMillis := 5000 * time.Millisecond
+
+	// 定义metrics回调函数
+	metricsCallback := func(stats *metrics.Stats) {
+		fmt.Println("receive stats callback")
+		jsonBytes, _ := json.MarshalIndent(stats, "", "  ")
+		fmt.Println(string(jsonBytes))
+	}
+
+	// 创建客户端
+	client := core.NewYunxinApiHttpClientBuilder(base.BizIM, appkey, appsecret).
+		TimeoutMillis(timeoutMillis).
+		MetricEnable(true). // 默认true
+		MetricCollectIntervalSeconds(60). // 默认60s
+		MetricsCallback(metricsCallback). // 设置回调
+		Build()
+
+	// 你可以60s调用一次GetStats方法获取数据，也可以用MetricsCallback获取数据
+
+	// 获取统计数据，可以自定义格式输出到监控系统
+	stats := client.GetStats()
+	jsonBytes, _ := json.MarshalIndent(stats, "", "  ")
+	fmt.Println(string(jsonBytes))
+
+	// 转换为prometheus格式
+	prometheusStr := metrics.ConvertToPrometheus(stats)
+	fmt.Println(prometheusStr)
+}
+```
+