Aurora IMUI 消息列表组件使用指南

Aurora IMUI 消息列表组件使用指南

aurora-imui General IM UI components. Android/iOS/RectNative ready. 通用 IM 聊天 UI 组件，已经同时支持 Android/iOS/RN。 项目地址: https://gitcode.com/gh_mirrors/au/aurora-imui

前言

Aurora IMUI 是一个功能强大的即时通讯 UI 组件库，其中的 MessageList 组件是聊天界面的核心部分，用于展示各种类型的消息。本文将详细介绍如何在 Android 应用中集成和使用 MessageList 组件。

组件集成

依赖添加

MessageList 支持多种依赖管理工具，开发者可以根据项目需求选择合适的方式：

1. Gradle 方式（推荐）

implementation 'cn.jiguang.imui:messagelist:0.8.0'

2. Maven 方式

<dependency>
  <groupId>cn.jiguang.imui</groupId>
  <artifactId>messagelist</artifactId>
  <version>0.8.0</version>
</dependency>

基础使用

布局文件配置

在 XML 布局文件中添加 MessageList 组件：

<cn.jiguang.imui.messages.MessageList
    android:id="@+id/msg_list"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    app:avatarHeight="50dp"
    app:avatarWidth="50dp"
    app:bubbleMaxWidth="0.70"
    app:dateTextSize="14sp"
    app:receiveBubblePaddingLeft="20dp"
    app:receiveBubblePaddingRight="10dp"
    app:receiveTextColor="#ffffff"
    app:receiveTextSize="18sp"
    app:sendBubblePaddingLeft="10dp"
    app:sendBubblePaddingRight="20dp"
    app:sendTextColor="#7587A8"
    app:sendTextSize="18sp" />

下拉刷新功能

如果需要实现下拉刷新功能，可以使用 PullToRefreshLayout 包裹 MessageList：

<cn.jiguang.imui.messages.ptr.PullToRefreshLayout
    android:id="@+id/pull_to_refresh_layout"
    android:layout_width="match_parent"
    android:layout_height="match_parent">
    
    <cn.jiguang.imui.messages.MessageList
        android:id="@+id/msg_list"
        android:layout_width="match_parent"
        android:layout_height="match_parent"/>
</cn.jiguang.imui.messages.ptr.PullToRefreshLayout>

然后在代码中配置刷新逻辑：

PtrDefaultHeader header = new PtrDefaultHeader(getContext());
ptrLayout.setHeaderView(header);
ptrLayout.addPtrUIHandler(header);
ptrLayout.setPtrHandler(new PtrHandler() {
    @Override
    public void onRefreshBegin(PullToRefreshLayout layout) {
        // 加载更多消息
        loadNextPage();
        ptrLayout.refreshComplete();
    }
});

适配器配置

MessageList 需要配置适配器才能正常工作：

MsgListAdapter adapter = new MsgListAdapter<MyMessage>(
    "0", // 发送者ID
    holdersConfig, // ViewHolder配置
    imageLoader // 头像加载器
);
messageList.setAdapter(adapter);

数据模型

消息模型实现

需要实现 IMessage 接口来定义消息模型：

public class MyMessage implements IMessage {
    private String id;
    private String text;
    private IUser user;
    
    // 必须实现的方法
    @Override
    public String getMsgId() { return id; }
    
    @Override
    public IUser getFromUser() { return user; }
    
    @Override
    public String getText() { return text; }
    // 其他方法...
}

用户模型实现

需要实现 IUser 接口来定义用户模型：

public class DefaultUser implements IUser {
    private String id;
    private String displayName;
    
    @Override
    public String getId() { return id; }
    
    @Override
    public String getDisplayName() { return displayName; }
    // 其他方法...
}

数据管理

消息操作

1. 添加消息

// 在底部添加单条消息
adapter.addToStart(message, true);

// 在顶部添加多条历史消息
adapter.addToEnd(messages);

2. 删除消息

// 按ID删除
adapter.deleteById(messageId);

// 删除所有消息
adapter.clear();

3. 更新消息

// 更新单条消息
adapter.update(message);

// 替换消息
adapter.update(oldId, newMessage);

事件处理

MessageList 提供了丰富的事件监听：

// 消息点击事件
adapter.setOnMsgClickListener(message -> {
    // 处理点击逻辑
});

// 头像点击事件
adapter.setOnAvatarClickListener(message -> {
    // 处理头像点击
});

// 消息长按事件
adapter.setMsgLongClickListener((view, message) -> {
    // 处理长按操作
});

// 消息状态点击事件
adapter.setMsgStatusViewClickListener(message -> {
    // 重发或下载消息
});

高级配置

显示名称控制

可以通过代码动态控制是否显示发送者/接收者名称：

messageList.setShowSenderDisplayName(true);
messageList.setShowReceiverDisplayName(false);

禁用下拉刷新

messageList.forbidScrollToRefresh(true);

性能优化

Proguard 配置

如果需要代码混淆，请添加以下规则：

-keep class cn.jiguang.imui.** { *; }

结语

Aurora IMUI 的 MessageList 组件提供了高度可定制的聊天界面解决方案，通过本文的介绍，开发者可以快速集成并使用该组件构建功能完善的聊天功能。组件支持多种消息类型、丰富的交互事件以及灵活的数据管理方式，能够满足大多数即时通讯场景的需求。

aurora-imui General IM UI components. Android/iOS/RectNative ready. 通用 IM 聊天 UI 组件，已经同时支持 Android/iOS/RN。 项目地址: https://gitcode.com/gh_mirrors/au/aurora-imui