YunXin Server SDK for PHP

✨ 核心特性

🚀 高性能与高可用

🔧 开发体验优化

📱 全业务模块覆盖

🏢 企业级部署支持

📋 系统要求

PHP 版本支持详情

🔧 安装

使用 Composer 安装

composer require yunxin/server-sdk-php

手动安装

git clone https://github.com/netease-im/yunxin-server-sdk-php.git
cd yunxin-server-sdk-php
composer install

🚀 快速开始

基础用法 - 面向对象客户端

<?php
require_once 'vendor/autoload.php';
use YunxinServerSdk\Core\BizName;
use YunxinServerSdk\Core\YunxinApiHttpClient;
use YunxinServerSdk\Im\V2\YunxinV2ApiServices;
use YunxinServerSdk\Im\V2\Account\Request\CreateAccountRequestV2;
// 1. 创建 HTTP 客户端
$client = YunxinApiHttpClient::builderWithBizName(
 BizName::im(), 
 'your-app-key', 
 'your-app-secret'
)
->timeoutMillis(5000)
->build();
// 2. 创建业务服务
$v2Services = new YunxinV2ApiServices($client);
$accountService = $v2Services->getAccountV2Service();
// 3. 创建用户请求
$request = new CreateAccountRequestV2();
$request->setUsername('test_user_001');
$request->setNickname('测试用户');
// 4. 发起 API 调用
$result = $accountService->createAccount($request);
if ($result->isSuccess()) {
 $response = $result->getResponse();
 echo "用户创建成功,AccountId: " . $response->getAccountId() . "\n";
} else {
 echo "创建失败: " . $result->getMsg() . "\n";
}

基础用法 - Raw 客户端

<?php
use YunxinServerSdk\Core\Http\HttpMethod;
// 使用 Raw 客户端直接发送 HTTP 请求
$requestData = json_encode([
 'username' => 'test_user_001',
 'nickname' => '测试用户'
]);
$response = $client->executeJsonSimple(
 HttpMethod::POST,
 '/im/v2/accounts',
 null,
 $requestData
);
$data = json_decode($response->getData(), true);
echo "响应: " . json_encode($data, JSON_PRETTY_PRINT) . "\n";

📚 详细文档

快速开始指南

业务模块文档

高级配置

🛠️ 开发与测试

环境准备

# 克隆项目
git clone https://github.com/netease-im/yunxin-server-sdk-php.git
cd yunxin-server-sdk-php
# 安装依赖
composer install
# 复制配置文件
cp phpunit.xml.dist phpunit.xml
# 编辑 .env 文件,填入测试用的 AppKey 和 AppSecret

运行测试

# 运行所有测试
composer test
# 运行指定测试
./vendor/bin/phpunit tests/BasicFunctionalityTest.php
# 生成测试覆盖率报告
composer test-coverage

代码质量检查

# 代码格式化 (PSR-12)
composer format
# 代码风格检查
composer lint
# 静态分析 (PHPStan Level 7)
composer analyze

目录结构

src/YunxinServerSdk/
├── Core/ # 核心功能
│ ├── BizName.php # 业务类型定义
│ ├── YunxinApiHttpClient.php # HTTP 客户端
│ ├── Endpoint/ # 端点管理
│ ├── Metrics/ # 监控指标
│ └── Exception/ # 异常处理
├── Im/ # 即时通讯
│ ├── V1/ # IM V1 API
│ └── V2/ # IM V2 API 
├── Sms/ # 短信服务
├── Rtc/ # 实时音视频
├── Vod/ # 点播服务
├── Live/ # 直播服务
├── Meeting/ # 会议服务
└── Neroom/ # 房间组件

🔧 高级用法

自定义端点配置

use YunxinServerSdk\Core\EndpointConfig;
use YunxinServerSdk\Core\Endpoint\FixedEndpointSelector;
$endpointConfig = new EndpointConfig();
$endpointConfig->setEndpointSelector(
 new FixedEndpointSelector('https://your-private-api.example.com')
);
$client = YunxinApiHttpClient::builderWithBizName(BizName::im(), $appkey, $appsecret)
 ->endpointConfig($endpointConfig)
 ->build();

自定义重试策略

use YunxinServerSdk\Core\Endpoint\RetryPolicy;
use YunxinServerSdk\Core\Endpoint\RetryAction;
class CustomRetryPolicy implements RetryPolicy 
{
 public function shouldRetry(int $httpCode, int $attempt): RetryAction 
 {
 if ($attempt >= 3) {
 return RetryAction::noRetry();
 }
 
 if ($httpCode >= 500) {
 return RetryAction::retry(1000 * $attempt); // 递增延迟重试
 }
 
 return RetryAction::noRetry();
 }
}

Metrics 监控集成

use YunxinServerSdk\Core\Metrics\MetricsConfig;
$metricsConfig = new MetricsConfig();
$metricsConfig->setEnabled(true);
$metricsConfig->setCallback(function($metrics) {
 // 自定义指标处理逻辑
 error_log("API Metrics: " . json_encode($metrics));
});
$client = YunxinApiHttpClient::builderWithBizName(BizName::im(), $appkey, $appsecret)
 ->metricsConfig($metricsConfig)
 ->build();

🔍 故障排查

启用调试模式

// 方法 1: 环境变量
putenv('YUNXIN_SDK_DEBUG=true');
// 方法 2: 配置日志
use Monolog\Logger;
use Monolog\Handler\StreamHandler;
$logger = new Logger('yunxin-sdk');
$logger->pushHandler(new StreamHandler('php://stdout', Logger::DEBUG));
$client = YunxinApiHttpClient::builderWithBizName(BizName::im(), $appkey, $appsecret)
 ->logger($logger)
 ->build();

常见问题

$client = YunxinApiHttpClient::builderWithBizName(BizName::im(), $appkey, $appsecret)
 ->timeoutMillis(10000) // 10秒超时
 ->build();

📈 性能与测试

🤝 贡献指南

提交 Issue

提交 Pull Request

开发规范

📄 许可证

🔗 相关链接