即时通讯框架MobileIMSDK的开发指南：Java客户端

学习交流↘

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

相关资料↘

• 即时通讯框架MobileIMSDK：快速入门 ^推荐
• 有关MobileIMSDK的疑问及解答 ^推荐
• MobileIMSDK性能测试报告
• MobileIMSDK客户端Demo安装和使用帮助(Android) [1]
• MobileIMSDK客户端Demo安装和使用帮助(iOS) [2]
• MobileIMSDK客户端Demo安装和使用帮助(Java) [3]
• MobileIMSDK服务端Demo安装和使用帮助 [4]
• IM应用案例RainbowChat体验版 ^推荐
• IM应用案例RainbowChat体验版截图预览
• IM应用案例某Chat的部分非敏感运营数据
  

开发文档↘

• MobileIMSDK客户端开发指南(Android)
• MobileIMSDK客户端开发指南(iOS)
• MobileIMSDK客户端开发指南(Java)
• MobileIMSDK服务端开发指南
• MobileIMSDK客户端SDK API文档(Android)
• MobileIMSDK客户端SDK API文档(iOS)
• MobileIMSDK客户端SDK API文档(Java)
• MobileIMSDK服务端SDK API文档(基于Mina框架)
• MobileIMSDK服务端SDK API文档(基于Netty框架)
  

资源下载↘

• MobileIMSDK最新版打包下载 ^推荐
• MobileIMSDK的Github地址
  

相关技术↘
  ① Web端即时通讯框架：MobileIMSDK-Web
  ② 移动端实时音视频框架：RainbowAV
  ③ 全功能产品级IM案例：RainbowChat
  ④ Web端产品级IM案例：RainbowChat-Web

写在前面

MobileIMSDK的Java客户端Demo工程演示了一个精心编写的简易即时通讯客户端，相关代码和最佳实践可参考之，它位于SDK完整下载包的 src_all/client/java/MobileIMSDK4j/ 目录下，这是一个完整的Eclipse工程。您也可以下载编译好的Demo安装包先行体验：点此进入。

第一部分：集成准备

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

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

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

第2步：引用lib包

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

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

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

第二部分：编写代码

第1步：基本配置

// 设置AppKey
ConfigEntity.appKey = "5418023dfd98c579b6001741";

// 设置服务器ip和服务器端口
ConfigEntity.serverIP = 您的IM服务器IP地址或域名;
ConfigEntity.serverUDPPort = 7901;

第2步：回调设置

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

public class ChatBaseEventImpl implements ChatBaseEvent
{        
    // 登陆/掉线重连结果通知
    @Override
    public void onLoginMessage(int dwUserId, int dwErrorCode)
    {
        if (dwErrorCode == 0) 
            System.out.println("登录成功，当前分配的user_id="+dwUserId);
        else 
            System.out.println("登录失败，错误代码：" + dwErrorCode);
    }

    // 掉线事件通知
    @Override
    public void onLinkCloseMessage(int dwErrorCode)
    {
        System.out.println("网络连接出错关闭了，error：" + dwErrorCode);
    }
}

② 实时消息事件回调实现类：

public class ChatTransDataEventImpl implements ChatTransDataEvent
{
    // 收到即时通讯消息通知
    @Override
    public void onTransBuffer(String fingerPrintOfProtocal, int dwUserid, String dataContent)
    {
        System.out.println("收到来自用户"+dwUserid+"的消息:"+dataContent);
    }

    // 收到服务端反馈的错误信息通知
    @Override
    public void onErrorResponse(int errorCode, String errorMsg)
    {
        System.out.println("收到服务端错误消息，errorCode="+errorCode+", errorMsg="+errorMsg);
    }
}

③ QoS相关事件回调实现类：

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

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

* 设置好事件回调通知监听：

ClientCoreSDK.getInstance().setChatBaseEvent(new ChatBaseEventImpl());
ClientCoreSDK.getInstance().setChatTransDataEvent(new ChatTransDataEventImpl());
ClientCoreSDK.getInstance().setMessageQoSEvent(new MessageQoSEventImpl());

第3步：登陆请求

new LocalUDPDataSender.SendLoginDataAsync(用户名, 密码){
    @Override
    protected void fireAfterSendLogin(int code)
    {
        if(code == 0)
            System.out.println("数据发送成功！");
        else
            System.out.println("数据发送失败。错误码是："+code+"！");
    }
}.execute();

第4步： 发送消息

new LocalUDPDataSender.SendCommonDataAsync("这是一条测试信息...", 对方的userId, true){
    @Override
    protected void onPostExecute(Integer code)
    {
        if(code == 0)
            System.out.println("数据已成功发出！");
        else
            System.out.println("数据发送失败。错误码是："+code+"！");
    }
}.execute();

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

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

当然，因为MobileIMSDK的Java客户端是运行于PC平台，因而是否省电的问题是无需考虑的。但为了配合Android、iOS客户端以及服务端，Java端也需要进行设置。

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

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

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

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

附录2：登陆请求结果为何是异步收到的？应用层如何处理体验更佳？

鉴于UDP通信的无连接特性，MobileIMSDK的服务端反馈回来的登陆结果自然也是异步到达，但这对开发者来说，只要代码处理得当，实现起来同样简单：即登陆请求发起前设置一个登陆结果观察者需可。

最佳实践详见Java客户端Demo代码 LoginGUI.doLoginImpl()：

附录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包：

捐助作者，得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）

感谢楼主分享