Skip to content

Commit

Permalink
Merge pull request #396 from haoxiuwen/doc-v2
Browse files Browse the repository at this point in the history
Modify java_server_sdk for REST
  • Loading branch information
haoxiuwen authored Aug 25, 2023
2 parents 08e05c2 + be1e6ed commit dc9e63c
Showing 1 changed file with 38 additions and 1 deletion.
39 changes: 38 additions & 1 deletion docs/document/server-side/java_server_sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ public class Config {

## 参考

- [Server SDK 的 API 文档](https://easemob.github.io/easemob-im-server-sdk/)
- [Server SDK 的 API 文档](https://easemob.github.io/easemob-im-server-sdk/)
- [Server SDK 开源地址](https://github.com/easemob/easemob-im-server-sdk)

## 常见问题
Expand All @@ -146,6 +146,37 @@ logging.level.com.easemob.im.http=debug
logging.level.com.easemob.im.shaded.io.netty=error
```

### 使用问题

目前有开发者在使用 Server SDK 有遇到 `Connection reset by peer` 异常的情况,由于 Server SDK 使用的 Netty 来发送请求,该异常是由 Netty 抛出来的,Netty 官方有相关问题的 issue 并有一些[解决方案](https://github.com/reactor/reactor-netty/issues/1774),不过要依赖于对 Netty 的 `ConnectionProvider` 进行配置,因此 Server SDK 在 `EMProperties` 中增加与之对应的配置项,来让开发者针对自己的使用场景进行对 Netty 的 `ConnectionProvider` 进行配置。比如设置连接数量、连接空闲时间等,如果使用 Server SDK 请求量较大,那可以把连接数设置大一些。

示例:

```java
@Configuration
public class Config {

@Bean
public EMService service() {

EMProperties properties = EMProperties.builder()
.setBaseUri("https://Your privatized address name")
.setAppkey("Appkey")
.setClientId("Client ID")
.setClientSecret("Client Secret")
.setHttpConnectionPoolSize(500)
.setHttpConnectionMaxIdleTime(20000)
.setHttpConnectionMaxLifeTime(60000)
.setHttpConnectionPendingAcquireTimeout(60000)
.setHttpConnectionEvictInBackground(120000)
.setServerTimezone("+8")
.build();

return new EMService(properties);
}
}
```

## 注意事项

1. Server SDK 是对环信 IM [REST API](overview.html) 的封装,但并没有封装所有的 API,只封装了开发者常用的 API,点击 [这里](#使用) 查看 Server SDK API。
Expand Down Expand Up @@ -204,6 +235,12 @@ EMProperties properties = EMProperties.builder()

## 更新日志

### V0.7.5 2023-08-24

1.`EMProperties` 中增加对 `ConnectionProvider` 的配置项,用于解决 Netty 请求连接问题。
2.支持修改群组公开或私有属性。
以上更新内容请到 `EMProperties``GroupApi` 中查看。

### V0.7.3 2023-07-05

- 发送聊天室消息增加 `chatroom_msg_level` 选项。
Expand Down

0 comments on commit dc9e63c

Please sign in to comment.