即时通讯技术MobileIMSDK：Server端开发指南

学习交流

• 讨论学习和资料区：点此进入 ^推荐
• 移动端即时通讯交流群： 215891622 ^推荐
• bug/建议发送至：jb2011@163.com
• 技术支持/合作/咨询请联系作者QQ：413980957
  

写在前面

MobileIMSDK的Server端Demo工程演示了一个简易即时通讯服务端，相关代码和最佳实践可参考之，它位于SDK完整下载包的 src_all/server/MobileIMSDKServer/ 目录下，这是一个完整的Eclipse工程。您也可以下载编译好的Demo安装包先行体验：它位于SDK完整下载包的 demos/server/ 目录下。

第一部分：集成准备

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

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

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

第2步：引用lib包

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

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

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

第二部分：编写代码

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

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

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

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

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

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

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

    // 通用数据实时发送失败后的回调函数定义（客户端发给客户端的（即接收user_id>0））
    // 开发者可在此方法中处理离线消息的保存等。详细请参见API文档说明。
    @Override
    public boolean onTransBuffer_C2C_RealTimeSendFaild_CallBack(int userId,
                int from_user_id, String dataContent, String fingerPring)
    {
        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
{
    private static ServerLauncherImpl instance = null;
        
    public static ServerLauncherImpl getInstance() throws IOException
    {
        if(instance == null)
        {
            // 设置AppKey
            ServerLauncher.appKey = "5418023dfd98c579b6001741";
            QoS4SendDaemonS2C.DEBUG = true;
            ServerLauncherImpl.PORT = 7901;
//          ServerLauncherImpl.setSenseMode(SenseMode.MODE_10S);
            instance = new ServerLauncherImpl();
        }
        return instance; 
    }
        
    public ServerLauncherImpl() throws IOException
    {
        super();
    }
        
    /**
     * 初始化消息处理事件监听者.
     */
    @Override
    protected void initListeners()
    {
        // ** 设置回调
        this.setServerEventListener(new ServerEventListenerImpl());
        this.setServerMessageQoSEventListener(new MessageQoSEventS2CListnerImpl());
    }
        
    public static void main(String[] args) throws IOException 
    {
        ServerLauncherImpl.getInstance().startup();
    }
}

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

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

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

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

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

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

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

附录2：如何自定义UserId的生成？

重写方法 ServerLauncher. initServerCoreHandler() 即可，以Demo中的代码为例：

public class ServerLauncherImpl extends ServerLauncher
{
    private static ServerLauncherImpl instance = null;
        
    public static ServerLauncherImpl getInstance() throws IOException
    {
        if(instance == null)
        {
            ServerLauncher.appKey = "5418023dfd98c579b6001741";
            QoS4SendDaemonS2C.DEBUG = true;
            ServerLauncherImpl.PORT = 7901;
            ServerLauncherImpl.setSenseMode(SenseMode.MODE_3S);

            instance = new ServerLauncherImpl(){
                 @Override
                 protected ServerCoreHandler initServerCoreHandler()
                 {
                      return new ServerCoreHandler(){
                           // 【注意】：重写此方法来实现您自已的user id生成算法哦^_^！
                           @Override
                           protected int getNextUserId(PLoginInfo loginInfo)
                           {
                              return UserProcessor.nextUserId(loginInfo);
                           }
                      };
                  }
             };
        }
        return instance; 
    }
        
    public ServerLauncherImpl() throws IOException
    {
        super();
    }
        
    @Override
    protected void initListeners()
    {
        this.setServerEventListener(new ServerEventListenerImpl());
        this.setServerMessageQoSEventListener(new MessageQoSEventS2CListnerImpl());
    }
        
    public static void main(String[] args) throws IOException 
    {
        ServerLauncherImpl.getInstance().startup();
    }
}

补充说明：重新实现以上代码中的第 23 行即可哦。

捐助作者，得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（服务端库）精编注释版：https://item.taobao.com/item.htm?id=534986485062

     
     

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

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

感谢楼主分享

感谢楼主分享

感谢楼主分享