即时通讯框架MobileIMSDK的开发指南：Server端

其它资料链接请回到详细介绍页↘：http://www.52im.net/thread-52-1-1.html

* 本贴最新更新于20240509日，增加了IDEA相关的配置截图。

写在前面

友情提示：在着手基于MobileIMSDK开发自已的即时通讯应用前，建议以Demo工程为脚手架，快速上手MobileIMSDK！

Demo工程主要用于演示SDK的API调用等，它位于SDK完整下载包的如下目录：


如上图目录demo_src/Server/所示，这是一个完整的Eclipse工程（含完整的可运行Demo源码）。

如果你只是想看看Demo的话，可以下载编译好的Demo包立即体验：它位于SDK完整下载包的 demo_binary/server/ 目录下。

第一部分：集成准备

第1步：下载SDK并找到lib包

① 马上下载：
最新版打包下载 点此进入，或者前往 MobileIMSDK的Github自行同步代码。

② 找到lib包：
位于SDK完整下载包的 sdl_binary/Server/ 目录下：

第2步：引用lib包和依赖库

提示：MobileIMSDK的Server端lib包支持Java 1.7（含）及以上版本。

2.1引用lib包（IDEA工程，本地jar方式）

① IDEA中如何引用第3方本地jar包？
跟所有Java工程一样引用jar包很简单，如果没试过，请查看：IDEA引入本地jar包的两种方法 或自行百度查找资料。

② 以MobileIMSDK Server的Demo工程为例，结果如下图：

2.2引用lib包（IDEA工程，Maven方式）

① IDEA中如何在pom.xml中引用本地jar包和依赖库？

在pom.xml加入以下配置：（以下配置参考自IM产品 RainbowChat）

  <dependencies>
    
    <!-- 依赖的开源JSON库Gson -->
    <dependency>
      <groupId>com.google.code.gson</groupId>
      <artifactId>gson</artifactId>
      <version>2.8.9</version>
    </dependency>

    <!-- 依赖的log4j日志框架的实用组合 -->
    <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-api</artifactId>
      <version>2.23.1</version>
    </dependency>
    <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-core</artifactId>
      <version>2.23.1</version>
    </dependency>
    <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-slf4j-impl</artifactId>
      <version>2.23.1</version>
    </dependency>

    <!-- 依赖的RabbitMQ中间件的java客户端库，用于与MobileIMSDK-Web产品进行消息互通时 -->
    <dependency>
      <groupId>com.rabbitmq</groupId>
      <artifactId>amqp-client</artifactId>
      <version>5.20.0</version>
    </dependency>

    <!-- 依赖的netty库 -->
    <dependency>
      <groupId>io.netty</groupId>
      <artifactId>netty-all</artifactId>
      <version>4.1.67.Final</version>
    </dependency>

    <!-- MobileIMSDK的核心库（此jar没有上传到mave中央库，请注意本地引用路径哦） -->
    <dependency>
      <groupId>com.x52im</groupId>
      <artifactId>mobileimsdk-server</artifactId>
      <version>6.5</version>
      <scope>system</scope>
      <systemPath>${project.basedir}/src/main/webapp/WEB-INF/lib/MobileIMSDKServer.jar</systemPath>
    </dependency>

  </dependencies>

② 以RainbowChat的Server工程为例，示例如下图：

2.3引用lib包（Eclipse工程）

① Eclipse中如何引用第3方jar包？
跟所有Java工程一样引用jar包很简单，如果没试过，请查看：Eclipse中导入外部jar包 或 Eclipse下导入外部jar包的3种方式。

② 以MobileIMSDK Server的Demo工程为例，结果如下图：

第二部分：编写代码

第1步：准备回调通知的实现类

① 框架基本事件回调实现类：

public class ServerEventListenerImpl implements ServerEventListener
{    
    // 用户身份验证回调方法定义
    // 服务端的应用层可在本方法中实现用户登陆验证。详细请参见API文档说明。
    @Override
    public int onUserLoginVerify(String userId, String token, String extra, Channel session)
    {
        System.out.println("正在调用回调方法：OnVerifyUserCallBack...");
        return 0;
    }

    // 用户登录验证成功后的回调方法定义
    // 服务端的应用层通常可在本方法中实现用户上线通知等。详细请参见API文档说明。
    @Override
    public void onUserLoginSucess(String userId, String extra, Channel session)
    {
        System.out.println("正在调用回调方法：OnUserLoginAction_CallBack...");
    }

    // 用户退出登录回调方法定义。
    // 服务端的应用层通常可在本方法中实现用户下线通知等。详细请参见API文档说明。
    @Override
    public void onUserLogout(String userId, Object obj, Channel session)
    {
        System.out.println("正在调用回调方法：OnUserLogoutAction_CallBack...");
    }

    // 通用数据回调方法定义（客户端发给服务端的（即接收user_id=0））
    // 上层通常可在本方法中实现如：添加好友请求等业务实现。详细请参见API文档说明。
    @Override
    public boolean onTransferMessage4C2S(Protocal p, Channel session)
    {
        System.out.println("收到了客户端"+from_user_id+"发给服务端的消息：str="+dataContent);
        return true;
    }

    // 通道数据回调函数定义（客户端发给客户端的（即接收user_id>0））。详细请参见API文档说明。
    // 上层通常可在本方法中实现用户聊天信息的收集，以便后期监控分析用户的行为等^_^。
    @Override
    public void onTransferMessage4C2C(Protocal p)
    {
        System.out.println("收到了客户端"+from_user_id+"发给客户端"+userId+"的消息：str="+dataContent);
    }

    // 通用数据实时发送失败后的回调函数定义（客户端发给客户端的（即接收user_id>0））
    // 开发者可在此方法中处理离线消息的保存等。详细请参见API文档说明。
    @Override
    public boolean onTransferMessage_RealTimeSendFaild(Protocal p)
    {
        System.out.println("客户端"+from_user_id+"发给客户端"+userId+"的消息：str="+dataContent
                        +"因实时发送没有成功，需要上层应用作离线处理哦，否则此消息将被丢弃.");
        return false;
    }
}

② 服务端主动发起消息的QoS回调通知实现类：

public class MessageQoSEventS2CListnerImpl implements MessageQoSEventListenerS2C
{        
    // 消息无法完成实时送达的通知
    @Override
    public void messagesLost(ArrayList<;Protocal> lostMessages)
    {
        System.out.println("【QoS_S2C事件】收到系统的未实时送达事件通知，当前共有"
                        +lostMessages.size()+"个包QoS保证机制结束，判定为【无法实时送达】！");
    }

    // 接收方已成功收到消息的通知
    @Override
    public void messagesBeReceived(String theFingerPrint)
    {
        if(theFingerPrint != null)
        {
            System.out.println("【QoS_S2C事件】收到对方已收到消息事件的通知，fp="+theFingerPrint);
        }
    }
}

第2步：服务端最终配置和实现

public class ServerLauncherImpl extends ServerLauncher
{
    /**
      * 静态类方法：进行一些全局配置设置。
      */
    static
    {
        // 设置MobileIMSDK服务端的UDP网络监听端口
        GatewayUDP.PORT = 7901;
        // 设置MobileIMSDK服务端的TCP网络监听端口
        GatewayTCP.PORT = 8901;

        // 设置MobileIMSDK服务端仅支持UDP协议
//         ServerLauncher.supportedGateways = Gateway.SUPPORT_UDP;
        // 设置MobileIMSDK服务端仅支持TCP协议
//        ServerLauncher.supportedGateways = Gateway.SUPPORT_TCP;
        // 设置MobileIMSDK服务端同时支持UDP、TCP两种协议
        ServerLauncher.supportedGateways = Gateway.SUPPORT_UDP | Gateway.SUPPORT_TCP;

        // 开/关Demog日志的输出
        QoS4SendDaemonS2C.getInstance().setDebugable(true);
        QoS4ReciveDaemonC2S.getInstance().setDebugable(true);
        ServerLauncher.debug = true;

        // 与客户端协商一致的心跳频率模式设置
//        ServerToolKits.setSenseModeUDP(SenseModeUDP.MODE_15S);
//        ServerToolKits.setSenseModeTCP(SenseModeTCP.MODE_15S);

        // 关闭与Web端的消息互通桥接器（其实SDK中默认就是false）
        ServerLauncher.bridgeEnabled = false;
        // TODO 跨服桥接器MQ的URI（本参数只在ServerLauncher.bridgeEnabled为true时有意义）
//        BridgeProcessor.IMMQ_URI = "amqp://js:19844713@192.168.0.190";

        // 设置最大TCP帧内容长度（不设置则默认最大是 6 * 1024字节）
//        GatewayTCP.TCP_FRAME_MAX_BODY_LENGTH = 60 * 1024;
    }

    /**
      * 实例构造方法。
      *
      * @throws IOException
      */
    public ServerLauncherImpl() throws IOException
    {
        super();
    }

    /**
      * 初始化消息处理事件监听者.
          */
    @Override
    protected void initListeners()
    {
        // ** 设置各种回调事件处理实现类
        this.setServerEventListener(new ServerEventListenerImpl());
        this.setServerMessageQoSEventListener(new MessageQoSEventS2CListnerImpl());
    }

    public static void main(String[] args) throws Exception
    {
        // 实例化后记得startup哦，单独startup()的目的是让调用者可以延迟决定何时真正启动IM服务
        final ServerLauncherImpl sli = new ServerLauncherImpl();

        // 启动MobileIMSDK服务端的Demo
        sli.startup();

        // 加一个钩子，确保在JVM退出时释放netty的资源
        Runtime.getRuntime().addShutdownHook(new Thread() {
            @Override
            public void run() {
                sli.shutdown();
            }
        });
    }
}

第三部分：常见开发问题附录

附录1：可以让客户端更省电吗？

为了配合Android、iOS客户端，Server端也需要进行设置。

请调用以下API进行设置即可（框架默认工作在SenseMode.MODE_15S模式下）：

// MobileIMSDK核心IM框架的服务端敏感度模式设置
ServerLauncherImpl.setSenseMode(SenseMode.MODE_15S);

MobileIMSDK预定义了多种模式，详细API说明：点此进入。

特别说明：为了保证算法的一致性，以上设置需所有平台客户端和服务端都保持一致，否则将发生不可预测问题。

附录2：服务端如何向客户端推送/发送数据（或消息）？

服务端使用 LocalSendHelper 类中的sendData系列方法即可，详见下图：


API文档在线地址：http://docs.52im.net/extend/docs/api/mobileimsdk/server_tcp/

附录3：核心库工程与Demo演示工程的关系说明

如下图所示：从 Github 或 淘宝 得到的核心库工程和Demo演示工程

（▲ 左边为MobileIMSDK的各平台核心库工程，右边为各平台的Demo演示工程）

* 什么是核心库工程？
核心库工程就是MobileIMSDK的所有框架源码，它只是个lib库，它的作用就像Spring boot、Struts、log4j这些第3库lib库一样：是打成jar包放到您的工程里使用的，您调用它就能实现它提供的功能，它自已本身并不能自已运行（你不可能让log4j或Spring boot能双击就运行吧？）

* 什么是Demo演示工程？
正如“什么是核心库工程？”一节所说，MobileIMSDK的核心库是不能直接运行的，它需要打成jar包被您的工程引用并调用后，才能发挥它的作用，所以MobileIMSDK的Demo演示工程的目的就是为了告诉你：如何引用MobileIMSDK的核心库jar包、如何调用MobileIMSDK的API，读Demo代码就知道如何使用它了（所以Demo代码唯一的意义就是为您演示库的调用，别无他用）！

* “我”的工程中使用使用核心库工程？
为了方便日后的升级，建议使用MobileIMSDK编译好的核心库jar包，当然您也可以直接把MobileIMSDK核心库源库放到您的工程中（而不是使用编译好的jar包）。

* 您可以在MobileIMSDK的Github如下目录中找到打包编译好的jar包：

附录4：如何开启SSL/TLS传输加密

1您需要准备一个SSL/TLS证书（支持自签名证书）

可以使用正规CA机构签发的证书，也可以使用自签名证书，如何生成自签名证书可自行百度，这方面资料很丰富。

证书文件就像这样：


注：如果你不想买证书，也不知道如何生成自签名证书，可以跟着这篇文章自已做《手把手教你为基于Netty的IM生成自签名SSL/TLS证书》。

2代码中启用SSL/TLS加密

* 将准备好的证书放置到服务端工程的此目录下（以MobileIMSDK的服务端Demo工程为例）：




* 启用SSL/TLS配置（取消此行代码注释即可）：


* 启用SSL/TLS后的运行效果（服务端控制台log中出现此字样即表示SSL/TLS启用成功！）：

捐助作者，得MobileIMSDK精编注释版

点击以下链接，前往淘宝下单，付款后发货到您的指定邮箱：

• ① MobileIMSDK（Android客户端库）精编注释版：https://item.taobao.com/item.htm?id=534778878908
• ② MobileIMSDK（Java客户端库）精编注释版：https://item.taobao.com/item.htm?id=534874027509
• ③ MobileIMSDK（iOS客户端库）精编注释版：https://item.taobao.com/item.htm?id=534918179776
• ④ MobileIMSDK（H5客户端库）精编注释版：https://item.taobao.com/item.htm?id=653944004776
• ⑤ MobileIMSDK（微信小程序端）精编注释版：https://item.taobao.com/item.htm?id=709976084872
• ⑥ MobileIMSDK（Uniapp端）精编注释版：https://item.taobao.com/item.htm?id=717960807229
• ⑦ MobileIMSDK（服务端库）精编注释版：https://item.taobao.com/item.htm?id=534986485062
  

（更多详情请进入：http://www.52im.net/thread-411-1-1.html）

补充说明一下：
【附录2】里给出的方法，可以让开发者实现自已的user id策略（MobileIMSDK默认是生成一个递增的整数），而开发者可以根据用户名等信息返回固定值（比如存放于DB中的id主键）等，总之API可以灵活使用，就看怎么去构思了。

感谢楼主分享

感谢楼主分享

感谢楼主分享

感谢楼主分享
这两天在学习服务端中,有个问题是:设置的AppKey应该没有用吧
这个是准备预留做客户端的AppKey校验吗?

引用：1726013735 发表于 2017-09-01 11:53
感谢楼主分享
这两天在学习服务端中,有个问题是:设置的AppKey应该没有用吧
这个是准备预留做客户端的AppK ...

AppKey暂时只是保留字段，你不用理会它就好了。

楼主您好，这个MobileIMSDK数据传输协议Protocal里面的dataContent是字符型，传文件什么的要改这个协议吧？实时音视频可以直接用这个服务端的SDK吗？

引用：1536155320 发表于 2018-01-24 17:31
楼主您好，这个MobileIMSDK数据传输协议Protocal里面的dataContent是字符型，传文件什么的要改这个协议吧？ ...

现在谁还用实时通道来传文件啊，你看看这个帖子，里面讨论了现在移动端im的文件上传和下载实现方法：
《请问有人知道语音留言聊天的主流实现方式吗？》

感谢感谢，学习了

精编版的 demo  netty  提示无法加载主类是什么情况，门外汉多包涵

引用：jqshan 发表于 2018-11-13 16:58
精编版的 demo  netty  提示无法加载主类是什么情况，门外汉多包涵

你至少要能在你的电脑上跑一个最普通的java hello world吧。

附录2的自定义生成用户id的方法getNextUserId不存在啊

引用：xiaoweiqb 发表于 2018-12-28 01:48
附录2的自定义生成用户id的方法getNextUserId不存在啊

这个方法是MobileIMSDK V2版里的，V3版已经不存在这个方法了，也不需要这个方法。

楼主请问，这个服务端MobileIMSDK 可以部署多个并进行连接吗，并且跨集群行吗

引用：小小搬码工 发表于 2019-02-26 14:58
楼主请问，这个服务端MobileIMSDK 可以部署多个并进行连接吗，并且跨集群行吗

默认是不行的。

引用：JackJiang 发表于 2019-02-26 15:05
默认是不行的。

那改下代码就可以的吗

引用：JackJiang 发表于 2019-02-26 15:05
默认是不行的。

是有预留这方方面的实现吗

引用：小小搬码工 发表于 2019-02-26 15:13
是有预留这方方面的实现吗

代码里跟MobileIMSDK-Web互通的部分，其实相当于集群的雏形。但要开发完整的集群，显示代码只是一方面。不过MobileIMDDK以后会有集群版。

你是打算开发什么应用？用户量很大吗？你可以看看MobileIMSDK的性能报告：http://www.52im.net/thread-57-1-1.html，一般的应用规模足够用了

引用：JackJiang 发表于 2019-02-26 16:31
代码里跟MobileIMSDK-Web互通的部分，其实相当于集群的雏形。但要开发完整的集群，显示代码只是一方面。 ...

其实主要应用的范围比较广，就是差不多是全球的，一台服务器有些范围覆盖不到，通信会差，所以打算在不同地区部署几台，进行连接