===== Java Server SDK =====


更新时间：2021-12-31 该文档已不再维护，请看新版 3.X 文档。

新版文档地址：[[ccim:rest:javaserversdk|Java Server SDK]]
==== 介绍 ====
Server SDK 是对环信 IM [[http://docs-im.easemob.com/im/server/ready/intro | 服务端 API]] 的封装，这样做是为了节省服务器端开发者对接环信 API 的时间，只需要配置自己的 appkey 相关信息即可使用。

==== 功能 ====
Server SDK 提供了用户、消息、群组、聊天室等资源的操作管理能力。

==== 依赖 ====
  * Java 1.8
  * [[https://projectreactor.io | Reactor]](io.projectreactor:reactor-bom:2020.0.4)

==== 安装 ====
如果你的项目使用 Maven 构建，在 pom.xml 中添加下面代码：
<code>
<dependency>
    <groupId>com.easemob.im</groupId>
    <artifactId>im-sdk-core</artifactId>
    <version>0.5.2</version>
</dependency>
</code>

如果你的项目使用 Gradle 构建，可以在 build.grade 中添加下面代码：
<code>implementation 'com.easemob.im:im-sdk-core:0.5.2'</code>

==== 准备 ====
在使用 Server SDK 之前，需要准备环信 appkey、Client ID、ClientSecre。

如果你有环信管理后台账号并创建过应用，请先登录环信管理后台，点击[[https://console.easemob.com/user/login | 这里]]，然后到"应用列表" -> 点击"查看"即可获取到 appkey、Client ID、ClientSecret。

如果你没有环信管理后台账号，请先注册账号，点击[[https://console.easemob.com/user/register | 这里]]，注册成功后请登录，然后点击"添加应用"，添加成功后点击"查看"即可获取到 appkey、Client ID、ClientSecret。



==== 使用 ====
[[https://easemob.github.io/easemob-im-server-sdk/com/easemob/im/server/EMService.html | EMService]]是所有API的入口，可以这样初始化：

1. 使用 Easemob App Credentials 的情况
<code>
建议写到配置类中，示例如下：
@Configuration
public class Config {

    @Bean
    public EMService service() {
        
        EMProperties properties = EMProperties.builder()
                .setAppkey("Appkey")
                .setClientId("Client ID")
                .setClientSecret("ClientSecret")
                .build();

        return new EMService(properties);
    }
}
</code>

根据业务资源，API 分为：
  * [[https://easemob.github.io/easemob-im-server-sdk/com/easemob/im/server/api/attachment/AttachmentApi.html | Attachment]] 用于上传下载附件
  * [[https://easemob.github.io/easemob-im-server-sdk/com/easemob/im/server/api/block/BlockApi.html | Block]] 用于限制访问(将用户加入黑名单、群组/聊天室禁言等)
  * [[https://easemob.github.io/easemob-im-server-sdk/com/easemob/im/server/api/contact/ContactApi.html | Contact]] 用于管理联系人(添加好友等)
  * [[https://easemob.github.io/easemob-im-server-sdk/com/easemob/im/server/api/group/GroupApi.html | Group]] 用于管理群组
  * [[https://easemob.github.io/easemob-im-server-sdk/com/easemob/im/server/api/message/MessageApi.html | Message]] 用于发送消息
  * [[https://easemob.github.io/easemob-im-server-sdk/com/easemob/im/server/api/user/UserApi.html | User]] 用于管理用户
  * [[https://easemob.github.io/easemob-im-server-sdk/com/easemob/im/server/api/metadata/MetadataApi.html | UserMetadata]] 用于管理用户属性
  * [[https://easemob.github.io/easemob-im-server-sdk/com/easemob/im/server/api/push/PushApi.html | Push]] 用于管理用户推送(设置推送免打扰等)
  * [[https://easemob.github.io/easemob-im-server-sdk/com/easemob/im/server/api/token/TokenApi.html | Token]] 用于获取用户Token
  * [[https://easemob.github.io/easemob-im-server-sdk/com/easemob/im/server/api/room/RoomApi.html | Room]] 用于管理聊天室
    
每个业务资源对应一个方法，例如，用户相关的 API，都可以在 .user() 找到。

举个例子，我们要注册一个用户，就可以这样写：
<code>
@Service
public class UserService {

    @Autowired
    private EMService service;

    private void createUser() {
        try {
            EMUser user = service.user().create("username", "password").block();
        } catch (EMException e) {
            e.getErrorCode();
            e.getMessage();
        }
        
    }
}
</code>
API的返回值是响应式的，如果希望阻塞，可以使用上面例子中的 .block()。

''注意：如果你的项目不是响应式的编程，那么请在调用的 Server SDK API 的结尾添加 .block()''

''对使用的 api 添加 try/catch ，如果使用的 api 没有抛出异常，代表请求成功，反之则请求失败，通过异常EMException对象的 getErrorCode()/getMessage() 拿到错误码以及错误描述''



==== 参考 ====
Server SDK 的 api 文档在[[https://easemob.github.io/easemob-im-server-sdk/ | 这里]] 。


Server SDK 开源地址在[[https://github.com/easemob/easemob-im-server-sdk | 这里]]。

----


==== 常见问题 ====

=== 集成问题 ===
如果你想看 Server SDK 的请求与响应，可以在配置文件中添加:
<code>
logging.level.com.easemob.im.http=debug
</code>






==== 注意事项 ====
1.Server SDK 是对环信 IM [[http://docs-im.easemob.com/im/server/ready/intro | 服务端 API]] 的封装，但并没有封装所有的 API，只封装了开发者常用的 API，点击[[http://docs-im.easemob.com/im/server/ready/sdk#%E4%BD%BF%E7%94%A8 | 这里]] 查看 Server SDK API。

对于注册环信id的规则，Server SDK 有自己的限制, 正则为 ''^[a-z][0-9a-z-]{1,32}$''，这点与[[http://docs-im.easemob.com/im/server/ready/user#%E7%8E%AF%E4%BF%A1_id_%E4%BD%BF%E7%94%A8%E8%A7%84%E5%88%99 | 官网文档]] 中说明的环信 id 规则是有区别的，这样做是因为目前环信 id 注册的限制范围比较广，Server SDK 考虑缩小环信 id 注册的限制范围使其更加规范，在此说明一下。

如果不想使用 Server SDK 注册环信 id 的限制，可以在初始化配置时添加 'turnOffUserNameValidation()' （sdk 需要使用 0.3.5 以上的版本）

''强烈建议不要使用纯数字或者有规律的字符串来注册环信 id，否则自己的用户可能会遭受到攻击、垃圾消息等后果。''
<code>
EMProperties properties = EMProperties.builder()
        .setAppkey("appkey")
        .setClientId("Client ID")
        .setClientSecret("ClientSecret")
        .turnOffUserNameValidation()
        .build();
</code>

2.使用代理的情况

''前提需要你的代理支持 CONNECT 方法，确保你的代理配置文件中有 connectport 80 存在。''

如果你使用的代代理不需要认证，那么需要传入自己的ip、端口。

<code>
EMProxy proxy = EMProxy.builder()
                .setIP("ip")
                .setPort(80)
                .build();

EMProperties properties = EMProperties.builder()
        .setProxy(proxy)
        .setAppkey("appkey")
        .setClientId("Client ID")
        .setClientSecret("ClientSecret")
        .build();                
</code>

如果你使用的代理需要认证，那么需要传入自己的ip、端口、账号以及密码。

<code>
EMProxy proxy = EMProxy.builder()
                .setIP("ip")
                .setPort(80)
                .setUsername("username")
                .setPassword("password")
                .build();

EMProperties properties = EMProperties.builder()
        .setProxy(proxy)
        .setAppkey("appkey")
        .setClientId("Client ID")
        .setClientSecret("ClientSecret")
        .build();                
</code>

==== 更新日志 ====
===V0.5.2===
  * 修改群组信息方法增加custom参数。
  * 新增群组转让方法。
以上更新内容请到GroupApi中查看。