Tencent Cloud IM Server SDK Java版技术文档

1. 安装指南

环境要求

• JDK 1.8或更高版本
• Maven项目管理工具(可选)

Maven安装方式

在项目的pom.xml文件中添加以下依赖配置：

<dependency>
  <groupId>io.github.doocs</groupId>
  <artifactId>im-server-sdk-java</artifactId>
  <version>0.4.19</version>
</dependency>

手动安装方式

1. 访问Maven中央仓库
2. 下载最新版本的JAR文件
3. 将JAR文件添加到项目的classpath中

2. 项目使用说明

初始化客户端

使用前需要先创建ImClient实例：

// SDK应用ID
long appId = 1400554812;

// 管理员用户ID
String userId = "test";

// 应用密钥
String key = "60c6c5925f3ae52c7325ac5a8ec78e44c056d1dd84d54e12ffa39911267a2a70";

// 创建ImClient实例
ImClient client = ImClient.getInstance(appId, userId, key);

基本功能示例

以下是一个账号导入的示例：

AccountImportRequest request = new AccountImportRequest("doocs");
request.setFaceUrl("https://avatars.githubusercontent.com/u/43716716?s=200&v=4");
request.setNick("Doocs Community");
try {
    AccountImportResult result = client.account.accountImport(request);
    // 处理返回结果
} catch (IOException e) {
    // 处理异常
}

3. 项目API使用文档

账号管理API

• accountImport: 导入单个账号
• multiAccountImport: 批量导入账号
• accountDelete: 删除账号
• accountCheck: 检查账号是否存在

用户资料API

• portraitGet: 获取用户资料
• portraitSet: 设置用户资料

关系链管理API

• friendAdd: 添加好友
• friendDelete: 删除好友
• friendGetAll: 获取所有好友
• friendGetList: 获取指定好友列表

消息管理API

• sendMsg: 发送单聊消息
• batchSendMsg: 批量发送单聊消息
• importMsg: 导入单聊消息

4. 项目安装方式详解

方式一：Maven项目集成

1. 确保项目使用Maven构建
2. 在pom.xml中添加依赖配置
3. 执行mvn clean install命令

方式二：Gradle项目集成

在build.gradle文件中添加：

implementation 'io.github.doocs:im-server-sdk-java:0.4.19'

方式三：手动导入

1. 下载JAR文件
2. 在IDE中右键项目 -> Build Path -> Add External Archives
3. 选择下载的JAR文件

验证安装

创建简单的测试类，尝试初始化ImClient实例，如无报错则说明安装成功。

注意事项

1. 请妥善保管应用密钥，避免泄露
2. 所有API调用都应进行异常处理
3. 生产环境建议使用连接池管理客户端实例
4. 定期检查SDK版本更新，获取最新功能和修复