devbox
不正经
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

SpringBoot集成开源IM框架MobileIMSDK，实现即时通讯IM聊天功能_im聊天开源框架

作者：不正经 | 2024-03-02 02:40:44

赞

踩

im聊天开源框架

一、前言

MobileIMSDK 是什么？

MobileIMSDK  是一套专门为移动端开发的开源IM即时通讯框架，超轻量级、高度提炼，一套API优雅支持UDP 、TCP 、WebSocket 三种协议，支持iOS、Android、H5、标准Java平台，服务端基于Netty编写。

工程地址是：

本文将实现：

  • 1）基于springboot 集成 MobileIMSDK；
  • 2）开发IM服务端；
  • 3）开发客户端；
  • 4）实现Java客户端与客户端之间的通信。

* 补充说明：本文所示Demo源码，请从文末“本文小结”的最后链接中下载！

二、SpringBoot 集成 MobileIMSDK 准备

2.1 MobileIMSDK下载

MobileIMSDK下载地址：

需要用到的lib包：

  • 1）服务端所需jar包： sdk_binary/Server/
  • 2）客服端所需jar包： sdk_binary/Client_TCP/java/

如下图所示：

2.2 pom.xml中引入相关依赖

由于这里是maven项目，其中一部分jar包可通过maven仓库直接引入，而其余的则通过外部jar包引入方式使用即可~

如下4个需作为外部jar包在pom.xml中引入 ：

  1. <!-- [url=https://mvnrepository.com/artifact/com.google.code.gson/gson]https://mvnrepository.com/artifact/com.google.code.gson/gson[/url] -->
  2.  
  3. <dependency>
  4.  
  5.     <groupId>com.google.code.gson</groupId>
  6.  
  7.     <artifactId>gson</artifactId>
  8.  
  9.     <version>2.8.5</version>
  10.  
  11. </dependency>
  12.  
  13.  
  14.  
  15. <!-- MobileIMSDK所需jar包依赖[注：这里是在本地lib中引入，maven中央仓库中暂无此jar包]，要与<includeSystemScope>true</includeSystemScope>配合使用-->
  16.  
  17. <dependency>
  18.  
  19.     <groupId>com.zhengqing</groupId>
  20.  
  21.     <artifactId>MobileIMSDK4j</artifactId>
  22.  
  23.     <scope>system</scope>
  24.  
  25.     <systemPath>${project.basedir}/src/main/resources/lib/MobileIMSDK4j.jar</systemPath>
  26.  
  27. </dependency>
  28.  
  29. <dependency>
  30.  
  31.     <groupId>com.zhengqing</groupId>
  32.  
  33.     <artifactId>MobileIMSDKServerX_meta</artifactId>
  34.  
  35.     <scope>system</scope>
  36.  
  37.     <systemPath>${project.basedir}/src/main/resources/lib/MobileIMSDKServerX_meta.jar</systemPath>
  38.  
  39. </dependency>
  40.  
  41. <dependency>
  42.  
  43.     <groupId>com.zhengqing</groupId>
  44.  
  45.     <artifactId>swing-worker-1.2(1.6-)</artifactId>
  46.  
  47.     <scope>system</scope>
  48.  
  49.     <systemPath>${project.basedir}/src/main/resources/lib/swing-worker-1.2(1.6-).jar</systemPath>
  50.  
  51. </dependency>
  52.  
  53. <dependency>
  54.  
  55.     <groupId>com.zhengqing</groupId>
  56.  
  57.     <artifactId>MobileIMSDKServerX_netty</artifactId>
  58.  
  59.     <scope>system</scope>
  60.  
  61.     <systemPath>${project.basedir}/src/main/resources/lib/MobileIMSDKServerX_netty.jar</systemPath>
  62.  
  63. </dependency>
  1. <plugins>
  2.  
  3.     <!-- maven打包插件 -> 将整个工程打成一个 fatjar -->
  4.  
  5.     <plugin>
  6.  
  7.         <groupId>org.springframework.boot</groupId>
  8.  
  9.         <artifactId>spring-boot-maven-plugin</artifactId>
  10.  
  11.         <!-- 作用:项目打成jar，同时把本地jar包也引入进去 -->
  12.  
  13.         <configuration>
  14.  
  15.             <includeSystemScope>true</includeSystemScope>
  16.  
  17.         </configuration>
  18.  
  19.     </plugin>
  20.  
  21. </plugins>

三、开发服务端

3.1 与客服端的所有数据交互事件（实现ServerEventListener类）

  1. public class ServerEventListenerImpl implements ServerEventListener {
  2.  
  3.     private static Logger logger = LoggerFactory.getLogger(ServerEventListenerImpl.class);
  4.  
  5.  
  6.  
  7.     /**
  9.      * 用户身份验证回调方法定义.
  11.      * <p>
  13.      * 服务端的应用层可在本方法中实现用户登陆验证。
  15.      * <br>
  17.      * 注意：本回调在一种特殊情况下——即用户实际未退出登陆但再次发起来登陆包时，本回调是不会被调用的！
  19.      * <p>
  21.      * 根据MobileIMSDK的算法实现，本方法中用户验证通过（即方法返回值=0时）后
  23.      * ，将立即调用回调方法 {@link #onUserLoginAction_CallBack(int, String, IoSession)}。
  25.      * 否则会将验证结果（本方法返回值错误码通过客户端的 ChatBaseEvent.onLoginMessage(int dwUserId, int dwErrorCode)
  27.      * 方法进行回调）通知客户端）。
  29.      *
  31.      * @param userId  传递过来的准一id，保证唯一就可以通信，可能是登陆用户名、也可能是任意不重复的id等，具体意义由业务层决定
  33.      * @param token   用于身份鉴别和合法性检查的token，它可能是登陆密码，也可能是通过前置单点登陆接口拿到的token等，具体意义由业务层决定
  35.      * @param extra   额外信息字符串。本字段目前为保留字段，供上层应用自行放置需要的内容
  37.      * @param session 此客户端连接对应的 netty “会话”
  39.      * @return 0 表示登陆验证通过，否则可以返回用户自已定义的错误码，错误码值应为：>=1025的整数
  41.      */
  42.  
  43.     @Override
  44.  
  45.     public int onVerifyUserCallBack(String userId, String token, String extra, Channel session) {
  46.  
  47.         logger.debug("【DEBUG_回调通知】正在调用回调方法：OnVerifyUserCallBack...(extra="+ extra + ")");
  48.  
  49.         return 0;
  50.  
  51.     }
  52.  
  53.  
  54.  
  55.     /**
  57.      * 用户登录验证成功后的回调方法定义（可理解为上线通知回调）.
  59.      * <p>
  61.      * 服务端的应用层通常可在本方法中实现用户上线通知等。
  63.      * <br>
  65.      * 注意：本回调在一种特殊情况下——即用户实际未退出登陆但再次发起来登陆包时，回调也是一定会被调用。
  67.      *
  69.      * @param userId  传递过来的准一id，保证唯一就可以通信，可能是登陆用户名、也可能是任意不重复的id等，具体意义由业务层决定
  71.      * @param extra   额外信息字符串。本字段目前为保留字段，供上层应用自行放置需要的内容。为了丰富应用层处理的手段，在本回调中也把此字段传进来了
  73.      * @param session 此客户端连接对应的 netty “会话”
  75.      */
  76.  
  77.     @Override
  78.  
  79.     public void onUserLoginAction_CallBack(String userId, String extra, Channel session) {
  80.  
  81.         logger.debug("【IM_回调通知OnUserLoginAction_CallBack】用户："+ userId + " 上线了！");
  82.  
  83.     }
  84.  
  85.  
  86.  
  87.     /**
  89.      * 用户退出登录回调方法定义（可理解为下线通知回调）。
  91.      * <p>
  93.      * 服务端的应用层通常可在本方法中实现用户下线通知等。
  95.      *
  97.      * @param userId  下线的用户user_id
  99.      * @param obj
  101.      * @param session 此客户端连接对应的 netty “会话”
  103.      */
  104.  
  105.     @Override
  106.  
  107.     public void onUserLogoutAction_CallBack(String userId, Object obj, Channel session) {
  108.  
  109.         logger.debug("【DEBUG_回调通知OnUserLogoutAction_CallBack】用户："+ userId + " 离线了！");
  110.  
  111.     }
  112.  
  113.  
  114.  
  115.     /**
  117.      * 通用数据回调方法定义（客户端发给服务端的（即接收user_id="0"））.
  119.      * <p>
  121.      * MobileIMSDK在收到客户端向user_id=0(即接收目标是服务器)的情况下通过
  123.      * 本方法的回调通知上层。上层通常可在本方法中实现如：添加好友请求等业务实现。
  125.      *
  127.      * <p style="background:#fbf5ee;border-radius:4px;">
  129.      * <b><font color="#ff0000">【版本兼容性说明】</font></b>本方法用于替代v3.x中的以下方法：<br>
  131.      * <code>public boolean onTransBuffer_CallBack(String userId, String from_user_id
  133.      * , String dataContent, String fingerPrint, int typeu, Channel session);
  135.      * </code>
  137.      *
  139.      * @param userId       接收方的user_id（本方法接收的是发给服务端的消息，所以此参数的值肯定==0）
  141.      * @param from_user_id 发送方的user_id
  143.      * @param dataContent  数据内容（文本形式）
  145.      * @param session      此客户端连接对应的 netty “会话”
  147.      * @return true表示本方法已成功处理完成，否则表示未处理成功。此返回值目前框架中并没有特殊意义，仅作保留吧
  149.      * @since 4.0
  151.      */
  152.  
  153.     @Override
  154.  
  155.     public boolean onTransBuffer_C2S_CallBack(Protocal p, Channel session) {
  156.  
  157.         // 接收者uid
  158.  
  159.         String userId = p.getTo();
  160.  
  161.         // 发送者uid
  162.  
  163.         String from_user_id = p.getFrom();
  164.  
  165.         // 消息或指令内容
  166.  
  167.         String dataContent = p.getDataContent();
  168.  
  169.         // 消息或指令指纹码（即唯一ID）
  170.  
  171.         String fingerPrint = p.getFp();
  172.  
  173.         // 【重要】用户定义的消息或指令协议类型（开发者可据此类型来区分具体的消息或指令）
  174.  
  175.         inttypeu = p.getTypeu();
  176.  
  177.  
  178.  
  179.         logger.debug("【DEBUG_回调通知】[typeu="+ typeu + "]收到了客户端"+ from_user_id + "发给服务端的消息：str="+ dataContent);
  180.  
  181.         returntrue;
  182.  
  183.     }
  184.  
  185.  
  186.  
  187.     /**
  189.      * 通道数据回调函数定义（客户端发给客户端的（即接收方user_id不为“0”的情况））.
  191.      * <p>
  193.      * <b>注意：</b>本方法当且仅当在数据被服务端成功在线发送出去后被回调调用.
  195.      * <p>
  197.      * 上层通常可在本方法中实现用户聊天信息的收集，以便后期监控分析用户的行为等^_^。
  199.      * <p>
  201.      * 提示：如果开启消息QoS保证，因重传机制，本回调中的消息理论上有重复的可能，请以参数 #fingerPrint
  203.      * 作为消息的唯一标识ID进行去重处理。
  205.      *
  207.      * <p style="background:#fbf5ee;border-radius:4px;">
  209.      * <b><font color="#ff0000">【版本兼容性说明】</font></b>本方法用于替代v3.x中的以下方法：<br>
  211.      * <code>public void onTransBuffer_C2C_CallBack(String userId, String from_user_id
  213.      * , String dataContent, String fingerPrint, int typeu);
  215.      *
  217.      * @param userId       接收方的user_id（本方法接收的是客户端发给客户端的，所以此参数的值肯定>0）
  219.      * @param from_user_id 发送方的user_id
  221.      * @param dataContent
  223.      * @since 4.0
  225.      */
  226.  
  227.     @Override
  228.  
  229.     public void onTransBuffer_C2C_CallBack(Protocal p) {
  230.  
  231.         // 接收者uid
  232.  
  233.         String userId = p.getTo();
  234.  
  235.         // 发送者uid
  236.  
  237.         String from_user_id = p.getFrom();
  238.  
  239.         // 消息或指令内容
  240.  
  241.         String dataContent = p.getDataContent();
  242.  
  243.         // 消息或指令指纹码（即唯一ID）
  244.  
  245.         String fingerPrint = p.getFp();
  246.  
  247.         // 【重要】用户定义的消息或指令协议类型（开发者可据此类型来区分具体的消息或指令）
  248.  
  249.         inttypeu = p.getTypeu();
  250.  
  251.  
  252.  
  253.         logger.debug("【DEBUG_回调通知】[typeu="+ typeu + "]收到了客户端"+ from_user_id + "发给客户端"+ userId + "的消息：str="+ dataContent);
  254.  
  255.     }
  256.  
  257.  
  258.  
  259.     /**
  261.      * 通用数据实时发送失败后的回调函数定义（客户端发给客户端的（即接收方user_id不为“0”的情况））.
  263.      * <p>
  265.      * 注意：本方法当且仅当在数据被服务端<u>在线发送</u>失败后被回调调用.
  267.      * <p>
  269.      * <b>此方法存的意义何在？</b><br>
  271.      * 发生此种情况的场景可能是：对方确实不在线（那么此方法里就可以作为离线消息处理了）、
  273.      * 或者在发送时判断对方是在线的但服务端在发送时却没有成功（这种情况就可能是通信错误
  275.      * 或对方非正常通出但尚未到达会话超时时限）。<br><u>应用层在此方法里实现离线消息的处理即可！</u>
  277.      *
  279.      * <p style="background:#fbf5ee;border-radius:4px;">
  281.      * <b><font color="#ff0000">【版本兼容性说明】</font></b>本方法用于替代v3.x中的以下方法：<br>
  283.      * <code>public boolean onTransBuffer_C2C_RealTimeSendFaild_CallBack(String userId
  285.      * , String from_user_id, String dataContent, String fingerPrint, int typeu);
  287.      * </code>
  289.      *
  291.      * @param userId       接收方的user_id（本方法接收的是客户端发给客户端的，所以此参数的值肯定>0），此id在本方法中不一定保证有意义
  293.      * @param from_user_id 发送方的user_id
  295.      * @param dataContent  消息内容
  297.      * @param fingerPrint  该消息对应的指纹（如果该消息有QoS保证机制的话），用于在QoS重要机制下服务端离线存储时防止重复存储哦
  299.      * @return true表示应用层已经处理了离线消息（如果该消息有QoS机制，则服务端将代为发送一条伪应答包
  301.      * （伪应答仅意味着不是接收方的实时应答，而只是存储到离线DB中，但在发送方看来也算是被对方收到，只是延
  303.      * 迟收到而已（离线消息嘛））），否则表示应用层没有处理（如果此消息有QoS机制，则发送方在QoS重传机制超时
  305.      * 后报出消息发送失败的提示）
  307.      * @see #onTransBuffer_C2C_CallBack(Protocal)
  309.      * @since 4.0
  311.      */
  312.  
  313.     @Override
  314.  
  315.     public boolean onTransBuffer_C2C_RealTimeSendFaild_CallBack(Protocal p) {
  316.  
  317.         // 接收者uid
  318.  
  319.         String userId = p.getTo();
  320.  
  321.         // 发送者uid
  322.  
  323.         String from_user_id = p.getFrom();
  324.  
  325.         // 消息或指令内容
  326.  
  327.         String dataContent = p.getDataContent();
  328.  
  329.         // 消息或指令指纹码（即唯一ID）
  330.  
  331.         String fingerPrint = p.getFp();
  332.  
  333.         // 【重要】用户定义的消息或指令协议类型（开发者可据此类型来区分具体的消息或指令）
  334.  
  335.         inttypeu = p.getTypeu();
  336.  
  337.  
  338.  
  339.         logger.debug("【DEBUG_回调通知】[typeu="+ typeu + "]客户端"+ from_user_id + "发给客户端"+ userId + "的消息：str="+ dataContent
  340.  
  341.                 + "，因实时发送没有成功，需要上层应用作离线处理哦，否则此消息将被丢弃.");
  342.  
  343.         returnfalse;
  344.  
  345.     }
  346.  
  347. }

3.2 服务端主动发起消息的QoS回调通知（实现MessageQoSEventListenerS2C类）

  1. public class MessageQoSEventS2CListnerImpl implements MessageQoSEventListenerS2C {
  2.  
  3.     private static Logger logger = LoggerFactory.getLogger(MessageQoSEventS2CListnerImpl.class);
  4.  
  5.  
  6.  
  7.     @Override
  8.  
  9.     public void messagesLost(ArrayList<Protocal> lostMessages) {
  10.  
  11.         logger.debug("【DEBUG_QoS_S2C事件】收到系统的未实时送达事件通知，当前共有"
  12.  
  13.                 + lostMessages.size() + "个包QoS保证机制结束，判定为【无法实时送达】！");
  14.  
  15.     }
  16.  
  17.  
  18.  
  19.     @Override
  20.  
  21.     public void messagesBeReceived(String theFingerPrint) {
  22.  
  23.         if(theFingerPrint != null) {
  24.  
  25.             logger.debug("【DEBUG_QoS_S2C事件】收到对方已收到消息事件的通知，fp="+ theFingerPrint);
  26.  
  27.         }
  28.  
  29.     }
  30.  
  31. }

3.3 服务端配置

  1. public class ServerLauncherImpl extends ServerLauncher {
  2.  
  3.     // 静态类方法：进行一些全局配置设置
  4.  
  5.     static{
  6.  
  7.         // 设置MobileIMSDK服务端的网络监听端口
  8.  
  9.         ServerLauncherImpl.PORT = 7901;
  10.  
  11.  
  12.  
  13.         // 开/关Demog日志的输出
  14.  
  15.         QoS4SendDaemonS2C.getInstance().setDebugable(true);
  16.  
  17.         QoS4ReciveDaemonC2S.getInstance().setDebugable(true);
  18.  
  19.         ServerLauncher.debug = true;
  20.  
  21.  
  22.  
  23.         // TODO 与客户端协商一致的心跳敏感模式设置
  24.  
  25. //      ServerToolKits.setSenseMode(SenseMode.MODE_10S);
  26.  
  27.  
  28.  
  29.         // 关闭与Web端的消息互通桥接器（其实SDK中默认就是false）
  30.  
  31.         ServerLauncher.bridgeEnabled = false;
  32.  
  33.         // TODO 跨服桥接器MQ的URI（本参数只在ServerLauncher.bridgeEnabled为true时有意义）
  34.  
  35. //     BridgeProcessor.IMMQ_URI = "amqp://js:19844713@192.168.31.190";
  36.  
  37.     }
  38.  
  39.  
  40.  
  41.     // 实例构造方法
  42.  
  43.     public ServerLauncherImpl() throws IOException {
  44.  
  45.         super();
  46.  
  47.     }
  48.  
  49.  
  50.  
  51.     /**
  53.      * 初始化消息处理事件监听者.
  55.      */
  56.  
  57.     @Override
  58.  
  59.     protected void initListeners() {
  60.  
  61.         // ** 设置各种回调事件处理实现类
  62.  
  63.         this.setServerEventListener(newServerEventListenerImpl());
  64.  
  65.         this.setServerMessageQoSEventListener(newMessageQoSEventS2CListnerImpl());
  66.  
  67.     }
  68.  
  69. }

3.4 服务端启动类

温馨小提示：这里由于小编将服务端和客户端集成在同一个项目中，因此如下配置：

  • SpringBoot的CommandLineRunner接口主要用于实现在服务初始化后，去执行一段代码块逻辑（run方法），这段初始化代码在整个应用生命周期内只会执行一次！
  • @Order(value = 1) ：按照一定的顺序去执行，value值越小越先执行
  1. @Slf4j
  2.  
  3. @Component
  4.  
  5. @Order(value = 1)
  6.  
  7. public class ChatServerRunner implements CommandLineRunner {
  8.  
  9.     @Override
  10.  
  11.     public void run(String... strings) throws Exception {
  12.  
  13.         log.info("================= ↓↓↓↓↓↓ 启动MobileIMSDK服务端 ↓↓↓↓↓↓ =================");
  14.  
  15.         // 实例化后记得startup哦，单独startup()的目的是让调用者可以延迟决定何时真正启动IM服务
  16.  
  17.         final ServerLauncherImpl sli = new ServerLauncherImpl();
  18.  
  19.         // 启动MobileIMSDK服务端的Demo
  20.  
  21.         sli.startup();
  22.  
  23.  
  24.  
  25.         // 加一个钩子，确保在JVM退出时释放netty的资源
  26.  
  27.         Runtime.getRuntime().addShutdownHook(newThread(sli::shutdown));
  28.  
  29.     }
  30.  
  31. }

如果服务端与客户端不在同一个项目 ，服务端可直接通过如下方式启动即可~

四、开发客户端

4.1 客户端与IM服务端连接事件

  1. @Slf4j
  2.  
  3. public class ChatBaseEventImpl implements ChatBaseEvent {
  4.  
  5.  
  6.  
  7.     @Override
  8.  
  9.     public void onLoginMessage(int dwErrorCode) {
  10.  
  11.         if(dwErrorCode == 0) {
  12.  
  13.             log.debug("IM服务器登录/连接成功！");
  14.  
  15.         } else{
  16.  
  17.             log.error("IM服务器登录/连接失败，错误代码："+ dwErrorCode);
  18.  
  19.         }
  20.  
  21.     }
  22.  
  23.  
  24.  
  25.     @Override
  26.  
  27.     public void onLinkCloseMessage(int dwErrorCode) {
  28.  
  29.         log.error("与IM服务器的网络连接出错关闭了，error："+ dwErrorCode);
  30.  
  31.     }
  32.  
  33. }

4.2 接收消息事件

  1. @Slf4j
  2.  
  3. public class ChatTransDataEventImpl implements ChatTransDataEvent {
  4.  
  5.  
  6.  
  7.     @Override
  8.  
  9.     public void onTransBuffer(String fingerPrintOfProtocal, String userid, String dataContent, inttypeu) {
  10.  
  11.         log.debug("[typeu="+ typeu + "]收到来自用户"+ userid + "的消息:"+ dataContent);
  12.  
  13.     }
  14.  
  15.  
  16.  
  17.     @Override
  18.  
  19.     public void onErrorResponse(int errorCode, String errorMsg) {
  20.  
  21.         log.debug("收到服务端错误消息，errorCode="+ errorCode + ", errorMsg="+ errorMsg);
  22.  
  23.     }
  24.  
  25. }

4.3 消息是否送达事件

  1. @Slf4j
  2.  
  3. public class MessageQoSEventImpl implements MessageQoSEvent {
  4.  
  5.  
  6.  
  7.     @Override// 对方未成功接收消息的回调事件 lostMessages：存放消息内容
  8.  
  9.     public void messagesLost(ArrayList<Protocal> lostMessages) {
  10.  
  11.         log.debug("收到系统的未实时送达事件通知，当前共有"+ lostMessages.size() + "个包QoS保证机制结束，判定为【无法实时送达】！");
  12.  
  13.     }
  14.  
  15.  
  16.  
  17.     @Override// 对方成功接收到消息的回调事件
  18.  
  19.     public void messagesBeReceived(String theFingerPrint) {
  20.  
  21.         if(theFingerPrint != null) {
  22.  
  23.             log.debug("收到对方已收到消息事件的通知，fp="+ theFingerPrint);
  24.  
  25.         }
  26.  
  27.     }
  28.  
  29. }

4.4 MobileIMSDK初始化配置

  1. public class IMClientManager {
  2.  
  3.     private static IMClientManager instance = null;
  4.  
  5.  
  6.  
  7.     /**
  9.      * MobileIMSDK是否已被初始化. true表示已初化完成，否则未初始化.
  11.      */
  12.  
  13.     privatebooleaninit = false;
  14.  
  15.  
  16.  
  17.     public static IMClientManager getInstance() {
  18.  
  19.         if(instance == null) {
  20.  
  21.             instance = new IMClientManager();
  22.  
  23.         }
  24.  
  25.         return instance;
  26.  
  27.     }
  28.  
  29.  
  30.  
  31.     private IMClientManager() {
  32.  
  33.         initMobileIMSDK();
  34.  
  35.     }
  36.  
  37.  
  38.  
  39.     public void initMobileIMSDK() {
  40.  
  41.         if(!init) {
  42.  
  43.             // 设置服务器ip和服务器端口
  44.  
  45.             ConfigEntity.serverIP = "127.0.0.1";
  46.  
  47.             ConfigEntity.serverPort = 8901;
  48.  
  49.  
  50.  
  51.             // MobileIMSDK核心IM框架的敏感度模式设置
  52.  
  53. //           ConfigEntity.setSenseMode(SenseMode.MODE_10S);
  54.  
  55.  
  56.  
  57.             // 开启/关闭DEBUG信息输出
  58.  
  59.             ClientCoreSDK.DEBUG = false;
  60.  
  61.  
  62.  
  63.             // 设置事件回调
  64.  
  65.             ClientCoreSDK.getInstance().setChatBaseEvent(newChatBaseEventImpl());
  66.  
  67.             ClientCoreSDK.getInstance().setChatTransDataEvent(newChatTransDataEventImpl());
  68.  
  69.             ClientCoreSDK.getInstance().setMessageQoSEvent(newMessageQoSEventImpl());
  70.  
  71.  
  72.  
  73.             init = true;
  74.  
  75.         }
  76.  
  77.     }
  78.  
  79. }

4.5 连接IM服务端，发送消息

服务类：

  1. public interface IChatService {
  2.  
  3.  
  4.  
  5.     /**
  7.      * 登录连接IM服务器请求
  9.      *
  11.      * @param username: 用户名
  13.      * @param password: 密码
  15.      * @return: void
  17.      */
  18.  
  19.     void loginConnect(String username, String password);
  20.  
  21.  
  22.  
  23.     /**
  25.      * 发送消息
  27.      *
  29.      * @param friendId: 接收消息者id
  31.      * @param msg:      消息内容
  33.      * @return: void
  35.      */
  36.  
  37.     void sendMsg(String friendId, String msg);
  38.  
  39. }

服务实现类：

  1. @Slf4j
  2.  
  3. @Service
  4.  
  5. @Transactional(rollbackFor = Exception.class)
  6.  
  7. public class ChatServiceImpl implements IChatService {
  8.  
  9.     @Override
  10.  
  11.     public void loginConnect(String username, String password) {
  12.  
  13.         // 确保MobileIMSDK被初始化哦（整个APP生生命周期中只需调用一次哦）
  14.  
  15.         // 提示：在不退出APP的情况下退出登陆后再重新登陆时，请确保调用本方法一次，不然会报code=203错误哦！
  16.  
  17.         IMClientManager.getInstance().initMobileIMSDK();
  18.  
  19.  
  20.  
  21.         // * 异步提交登陆名和密码
  22.  
  23.         new LocalUDPDataSender.SendLoginDataAsync(username, password) {
  24.  
  25.             /**
  27.              * 登陆信息发送完成后将调用本方法（注意：此处仅是登陆信息发送完成，真正的登陆结果要在异步回调中处理哦）。
  29.              * @param code 数据发送返回码，0 表示数据成功发出，否则是错误码
  31.              */
  32.  
  33.             protected void fireAfterSendLogin(int code) {
  34.  
  35.                 if(code == 0) {
  36.  
  37.                     log.debug("数据发送成功！");
  38.  
  39.                 } else{
  40.  
  41.                     log.error("数据发送失败。错误码是："+ code);
  42.  
  43.                 }
  44.  
  45.             }
  46.  
  47.         }.execute();
  48.  
  49.     }
  50.  
  51.  
  52.  
  53.     @Override
  54.  
  55.     public void sendMsg(String friendId, String msg) {
  56.  
  57.         // 发送消息（异步提升体验，你也可直接调用LocalUDPDataSender.send(..)方法发送）
  58.  
  59.         new LocalUDPDataSender.SendCommonDataAsync(msg, friendId) {
  60.  
  61.             @Override
  62.  
  63.             protected void onPostExecute(Integer code) {
  64.  
  65.                 if(code == 0) {
  66.  
  67.                     log.debug("数据已成功发出！");
  68.  
  69.                 } else{
  70.  
  71.                     log.error("数据发送失败。错误码是："+ code + "！");
  72.  
  73.                 }
  74.  
  75.             }
  76.  
  77.         }.execute();
  78.  
  79.     }
  80.  
  81. }

五、编写Controller进行测试

  1. @RestController
  2.  
  3. @RequestMapping("/api")
  4.  
  5. @Api(tags = "聊天测试-接口")
  6.  
  7. public class ChatController {
  8.  
  9.     @Autowired
  10.  
  11.     private IChatService chatService;
  12.  
  13.  
  14.  
  15.     @PostMapping(value = "/loginConnect", produces = Constants.CONTENT_TYPE)
  16.  
  17.     @ApiOperation(value = "登陆请求", httpMethod = "POST", response = ApiResult.class)
  18.  
  19.     public ApiResult loginConnect(@RequestParamString username, @RequestParamString password) {
  20.  
  21.         chatService.loginConnect(username, password);
  22.  
  23.         return ApiResult.ok();
  24.  
  25.     }
  26.  
  27.  
  28.  
  29.     @PostMapping(value = "/sendMsg", produces = Constants.CONTENT_TYPE)
  30.  
  31.     @ApiOperation(value = "发送消息", httpMethod = "POST", response = ApiResult.class)
  32.  
  33.     public ApiResult sendMsg(@RequestParam String friendId, @RequestParam String msg) {
  34.  
  35.         chatService.sendMsg(friendId, msg);
  36.  
  37.         return ApiResult.ok();
  38.  
  39.     }
  40.  
  41. }

启动项目，访问：http://127.0.0.1:8080/swagger-ui.html

1） loginConnect接口：

任意输入一个账号密码登录连接IM服务端：

控制台日志如下：

2）sendMsg接口：

给指定用户发送消息：这里由于只有一个客户端，上一步登录了一个admin账号，因此小编给admin账号(也就是自己) 发送消息

控制台日志如下：

六、本文小结

关于集成可参考MobileIMSDK给出的文档一步一步实现。

该开源工程对应的官方文档比较齐全，需要哪个端，就去看对应端的手册就好了。

1）Demo安装和使用

2）开发者指南

3）API文档

另外：作者给出了通过Java GUI编程实现的一个小demo，我们可以先将其运行起来，先体验一下功能，代码量也不是太多，我们可以通过debug方式查看执行流程。

清楚执行流程之后我们就可以将demo中的代码移植到我们自己的项目中加以修改运用于自己的业务中，切勿拿起就跑，否则一旦运气不好，将浪费更多的时间去集成，这样很不好！

最后：案例demo中相关代码注释都有，这里就简单说下整个流程吧：

  • 1）首先启动IM服务端
  • 2）用户在客户端登录一个用户与服务端建立连接保持通信（ 客户端ChatServiceImpl中loginConnect方法为登录连接服务端事件；服务端ServerEventListenerImpl中onUserLoginVerify方法为服务端接收的上线通知事件）；
  • 3）客户端通过 ChatServiceImpl中sendMsg方法发送一条消息，如果对方在线能接收消息则走服务端ServerEventListenerImpl中onTransferMessage4C2C方法，否则走onTransferMessage_RealTimeSendFaild方法；如果对方成功接收到消息，客户端将走MessageQoSEventImpl中messagesBeReceived事件，否则走messagesLost事件；
  • 4）客户端通过ChatMessageEvent中onRecieveMessage回调事件接收消息。

附：本文案例demo源码下载：

附录：更多IM聊天新手实践代码

  1. 《跟着源码学IM(一)：手把手教你用Netty实现心跳机制、断线重连机制》
  2. 《跟着源码学IM(二)：自已开发IM很难？手把手教你撸一个Andriod版IM》
  3. 《跟着源码学IM(三)：基于Netty，从零开发一个IM服务端》
  4. 《跟着源码学IM(四)：拿起键盘就是干，教你徒手开发一套分布式IM系统》
  5. 《跟着源码学IM(五)：正确理解IM长连接、心跳及重连机制，并动手实现》
  6. 《跟着源码学IM(六)：手把手教你用Go快速搭建高性能、可扩展的IM系统》
  7. 《跟着源码学IM(七)：手把手教你用WebSocket打造Web端IM聊天》
  8. 《跟着源码学IM(八)：万字长文，手把手教你用Netty打造IM聊天》
  9. 《跟着源码学IM(九)：基于Netty实现一套分布式IM系统》
  10. 《跟着源码学IM(十)：基于Netty，搭建高性能IM集群（含技术思路+源码）》
声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/不正经/article/detail/178583
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号