我和极光的那些事 | 超简单使用即时通讯会话组件

之前写过一个即时通讯的项目，使用的是极光的 JMessage ，但是在使用会话输入组件的时候遇到了键盘高度的问题，解决无果。

项目也有段时间没更新了，但是已经实现了基本的聊天会话，好友列表，在线离线，添加删除等功能。

正好极光举办这次活动，抽空又尝试把会话组件集成了进来。

这次使用已经没有了之前的问题。可以看效果图

UI 组件仓库： https://github.com/jpush/aurora-imui

一、基本使用

在 App 下的 build.gradle 引入即可

compile 'cn.jiguang.imui:chatinput:0.5.7'

然后布局中使用

初始化控件

ChatInputView chatInputView = (ChatInputView) findViewById(R.id.chat_input);
chatInputView.setMenuContainerHeight(softInputHeight);

这里需要给组件设置高度，一般使用软键盘弹起时的高度。官方文档建议是在上个界面通过 onSizeChanged 方法获取，这里具体可以自己测试。

获取软键盘高度的方法

  int heightDifference = 0;

    /*获取键盘的高度*/
    private void editTextHeight() {
        mChatInput.getViewTreeObserver().addOnGlobalLayoutListener(new ViewTreeObserver.OnGlobalLayoutListener() {
            @Override
            public void onGlobalLayout() {
                Rect r = new Rect();
                //获取当前界面可视部分
                ChatMsgActivity.this.getWindow().getDecorView().getWindowVisibleDisplayFrame(r);
                //获取屏幕的高度
                int screenHeight = ChatMsgActivity.this.getWindow().getDecorView().getRootView().getHeight();
                //此处就是用来获取键盘的高度的， 在键盘没有弹出的时候 此高度为0 键盘弹出的时候为一个正数
                if (screenHeight - r.bottom > 0) {
                    heightDifference = screenHeight - r.bottom;
                }
//                LogUtils.e(heightDifference + "");
            }
        });
    }

如果上设置都没问题之后，那么就可以直接开启会话组件的监听了。

chatInput.setMenuClickListener(new OnMenuClickListener() {
    @Override
    public boolean onSendTextMessage(CharSequence input) {
          sendMessage(charSequence.toString());
         // 输入框输入文字后，点击发送按钮事件
    }

    @Override
    public void onSendFiles(List list) {
        // 选中文件或者录制完视频后，点击发送按钮触发此事件
    }

    @Override
    public boolean switchToMicrophoneMode() {
        // 点击语音按钮触发事件，显示录音界面前触发此事件
        // 返回 true 表示使用默认的界面，若返回 false 应该自己实现界面
        return true;
    }

    @Override
    public boolean switchToGalleryMode() {
        // 点击图片按钮触发事件，显示图片选择界面前触发此事件
        // 返回 true 表示使用默认的界面
        return true;
    }

    @Override
    public boolean switchToCameraMode() {
        // 点击拍照按钮触发事件，显示拍照界面前触发此事件
        // 返回 true 表示使用默认的界面
        return true;
    }
});

二、开始发送一条消息

发送消息需要创建消息，并且指定消息类型。
发送消息包括两方面，一个是本地端，另一个服务端。
本地的用于消息的即时展示，服务端用于消息的转发。

创建一条本地消息：

本地消息需要制定展示的位置，用于 List 识别是发送的消息还是接收的消息，方便位置的展示。

final MyMessage myMessage = new MyMessage(string, SEND_TEXT);
        myMessage.setMessage(message1);
        myMessage.setTimeString(TimeUtils.ms2date("MM-dd HH:mm", message1.getCreateTime()));
        myMessage.setUserInfo(new DefaultUser(JMessageClient.getMyInfo().getUserName(), "DeadPool", imgSend));
  

如果仅仅是本地展示不需要经过服务端通讯那么直接调用 mAdapter.addToStart(myMessage, true); 方法将消息追加到消息列表就完成了。

但是对方是接收不到消息的。所以在创建本地消息的同时，也需要把消息推送到服务端，当服务端处理并且返回成功的时候本地再展示。

创建一条消息发送到服务端:

TextContent content = new TextContent(string);
        Message message1 = conversation.createSendMessage(content);

TextContent 是创建的文本消息，
要创建其它类型的消息比如语音就是 VoiceContent 。
VoiceContent content1 = new VoiceContent(new File("/11111.mp3", 0));

Image 消息 ImageContent content1 = new ImageContent(new File(""));

目前已经支持的消息类型:

    text,
    image,
    voice,
    location,
    video,
    eventNotification,
    custom,
    unknown,
    file,
    prompt;

创建完成之后需要将消息添加到 Message ，初始化发送消息事件。

Message message1 = conversation.createSendMessage(content);

下面是发送消息的重点

gotResult 是发送消息的回调，只有 = 1 的情况下才是发送成功的状态，所以需要在发送成功的时候将消息追加到消息列表。
注意这里追加的消息就是创建的本地消息。

message1.setOnSendCompleteCallback(new BasicCallback() {
            @Override
            public void gotResult(int i, String s) {
                if (i == 0) {
                    mAdapter.addToStart(myMessage, true);
                    mChatEt.setText("");
                } else {
                }
            }
        });
        JMessageClient.sendMessage(message1);

但是这里有个小问题就是，如果在无网络的情况下，重复点击发送事件，消息就会被重复添加到待发送队列，当连接网络后会一次性把所以的消息都发送出去。

所以在这里需要要对发送失败的消息做处理。

完整代码

  /*发送消息，当前版本只能发送文本*/
    private void sendMessage(String msg) {
        TextContent content = new TextContent(msg);
        Message message1 = conversation.createSendMessage(content);
        final MyMessage myMessage = new MyMessage(msg, SEND_TEXT);
        myMessage.setMessage(message1);
        myMessage.setTimeString(TimeUtils.ms2date("MM-dd HH:mm", message1.getCreateTime()));
        myMessage.setUserInfo(new DefaultUser(JMessageClient.getMyInfo().getUserName(), "DeadPool", imgSend));

        message1.setOnSendCompleteCallback(new BasicCallback() {
            @Override
            public void gotResult(int i, String s) {
                if (i == 0) {
                    mAdapter.addToStart(myMessage, true);
                    mChatEt.setText("");
                } else {
                }
            }
        });
        JMessageClient.sendMessage(message1);
//        EventBus.getDefault().post(new MessageEvent(1,"",message1));
        if (mData != null) {
            mData.clear();
        }
    }

三、接收消息

在使用 JMessage 接收消息，都需要先在当前页面注册消息接收

注册接收者

如果用过 EventBus 那么很容易理解即时通讯的消息传递机制。

        JMessageClient.registerEventReceiver(this);
        conversations = JMessageClient.getConversationList();

接收事件解绑

  @Override
    protected void onDestroy() {
        JMessageClient.unRegisterEventReceiver(this);
        JMessageClient.exitConversation();
        super.onDestroy();
        
    }

消息处理

当收到消息后，所有注册过消息接收事件的页面都会收到通知，然后我们可以对收到的消息进行处理。

常用消息事件

• MessageEvent 消息事件
• MessageRetractEvent 撤回消息事件
• ContactNotifyEvent 好友通知事件
• ConversationRefreshEvent 消息漫游事件
• OfflineMessageEvent 离线消息事件

消息事件

这里需要注意的是同上面发送消息的方法类似，由于 SDK 和 UI 组件的消息 Bean 不一致，所以需要对 SDK 返回的消息解析到ui组件（MessageList）。
然后就是对视图的处理

final Message message = event.getMessage();

        runOnUiThread(new Runnable() {
            @Override
            public void run() {
                //创建一个消息对象
                myMessage = new MyMessage(((TextContent) message.getContent()).getText(), IMessage.MessageType.RECEIVE_TEXT);
                myMessage.setMessage(message);
                myMessage.setMsgID(message.getServerMessageId());
                myMessage.setText(((TextContent) message.getContent()).getText() + "");
                myMessage.setTimeString(TimeUtils.ms2date("MM-dd HH:mm", message.getCreateTime()));
                myMessage.setUserInfo(new DefaultUser(JMessageClient.getMyInfo().getUserName(), "DeadPool", imgRecrive));

                if (message.getContentType() == ContentType.text || message.getContentType().equals("text")) {
                    mAdapter.addToStart(myMessage, true);
                    mAdapter.notifyDataSetChanged();
                }
                //收到消息时，添加到集合
                list.add(myMessage);
            }

        });

撤回消息的事件

 /*接收到撤回的消息*/
    public void onEvent(MessageRetractEvent event) {
        final Message message = event.getRetractedMessage();
        runOnUiThread(new Runnable() {
            @Override
            public void run() {
                Log.e("dataSize", mData.size() + "," + list.size());
                for (int i = 0; i <= list.size(); i++) {
                    Log.e("messageRetract", "message:" + message + "\nMymessage:" + list.get(i));
                    if (list.get(i).getMsgID() == message.getServerMessageId()) {
                        mAdapter.delete(list.get(i));
                        MyMessage message1 = new MyMessage("[对方撤回了一条消息]", IMessage.MessageType.RECEIVE_TEXT);
                        mAdapter.addToStart(message1, true);
                        mAdapter.notifyDataSetChanged();
                        mAdapter.updateMessage(message1);
                    }
                }
            }

        });

    }

这里只是简单介绍 imui 结合 MessageList 的基本使用，关于更详细，更多功能请参考官方文档说明。
关于使用中遇到的问题可以参考 demo ，或者去极光技术社区提问。

Demo地址：Android-IM

JMessage 相关文章

• Android-IM从零开始开发一个即时通讯项目
• Android-IM给即时通讯添加一个自动聊天机器人
• Android-IM消息接收事件之EventBus的应用
• Android-IM即时通讯关于消息撤回的处理

---

「本文系极光征文 | 写写文章就能赢 Filco，岂不美滋滋的参赛文章」