用户信息自动管理

大约 7 分钟

用户信息自动管理

功能说明

自 V4.20.0 起，环信即时通讯 IM 提供用户信息自动管理功能。开启该功能后，SDK 可自动维护用户信息的同步与内存更新，帮助开发者减少手动拉取、存储和更新用户信息的工作量。

该功能适用于会话列表、消息列表、群聊页面等需要展示用户昵称、头像、备注、群成员名片等信息的场景。

本文提及的用户信息指用于业务展示的用户相关信息，包括 用户属性、好友备注 和 群成员名片。

技术原理

用户信息自动管理功能由 EMOptions#enableUserInfo 控制。开启后，SDK 按以下流程处理用户信息同步与内存更新：

  1. 用户登录成功后，SDK 自动从服务端获取当前登录用户的信息，并写入本地内存。
  2. 当用户更新自身信息后，后续发送的消息会携带对应信息的更新时间。
  3. 接收方收到消息后，SDK 会解析消息中的发送方信息及更新时间。
  4. SDK 会将消息中的更新时间与本地内存中的时间戳进行比较。
  5. 如果消息中的更新时间晚于本地内存，SDK 会自动 从服务端拉取最新用户属性 或 群成员名片。
  6. 拉取成功后，SDK 会自动更新本地内存。
  7. 本地内存更新完成后，SDK 会通过事件通知上层应用，业务层可据此刷新 UI。

该功能的核心是：SDK 自动完成用户信息获取、更新检测、本地内存更新和变更通知。

内存更新流程如下：

img

前提条件

开始接入前，请确保满足以下条件：

  • 已将 SDK 升级至 v4.20.0 或以上版本。
  • 已完成 SDK 初始化。详见快速开始。
  • 已了解即时通讯 IM 的相关使用限制。详见使用限制。

开启用户信息自动管理

在 SDK 初始化前，将 EMOptions#enableUserInfo 设置为 true：

let options = EMOptions(appkey: "your_appkey")
options.enableUserInfo = true
EMClient.shared().initializeSDK(with: options)

提示

必须在调用 EMClient.shared().initializeSDK(with: options) 初始化 SDK 之前设置 EMOptions#enableUserInfo，否则该功能不会生效。

监听用户信息更新

SDK 提供 EMUserInfoManagerDelegate，用于监听用户信息更新事件，主要包括：

建议在业务初始化阶段完成监听注册，以便在登录后的初始同步、消息触发或主动拉取等场景中及时接收事件并刷新界面。

  • 添加监听：
EMClient.shared().userInfoManager?.add(self, delegateQueue: nil)
  • 实现监听用户信息更新事件：
extension YourViewController: EMUserInfoManagerDelegate {
    /// 当前登录用户信息更新事件
    func onSelfUserInfoUpdate(_ aUserInfo: EMUserInfo) {
        print("当前登录用户信息更新 - nickname:\(aUserInfo.nickname ?? ""), avatarUrl:\(aUserInfo.avatarUrl ?? "")")
    }

    /// 其他用户信息更新事件
    func onUserInfoUpdate(_ aUserInfos: [String : EMUserInfo]) {
        for (userId, userInfo) in aUserInfos {
            print("用户信息更新 - userId:\(userId), nickname:\(userInfo.nickname ?? ""), avatarUrl:\(userInfo.avatarUrl ?? "")")
        }
    }
}

通过消息获取发送方信息

开启用户信息自动管理后，接收到的消息中会包含发送方相关信息。你可以通过 EMChatMessage#senderInfo 获取当前可用的发送方信息，包括昵称、头像、备注和群成员名片。

func messagesDidReceive(_ aMessages: [EMChatMessage]) {
    for message in aMessages {
        if let senderInfo = message.senderInfo {
            let nickname = senderInfo.nickname ?? ""
            let avatarUrl = senderInfo.avatarUrl ?? ""
            let remark = senderInfo.remark ?? ""
            let namecard = senderInfo.groupNameCard ?? ""
            print("发送方信息 - nickname:\(nickname), avatarUrl:\(avatarUrl), remark:\(remark), namecard:\(namecard)")
        }
    }
}

提示

senderInfo 返回的是当前本地可用的发送方信息。如果消息触发了用户信息更新，最新数据会在 SDK 完成本地内存更新后，通过相关事件通知业务层。

从本地内存读取用户信息

如需直接从本地内存读取用户信息，可调用 EMUserInfoManager#getUserInfoByIds。该接口不会发起网络请求，适用于本地展示场景。

let result = EMClient.shared().userInfoManager?.getUserInfo(byIds: ["userId1", "userId2"])
if let userInfoMap = result {
    for (userId, userInfo) in userInfoMap {
        print("用户信息 - userId:\(userId), nickname:\(userInfo.nickname ?? ""), avatarUrl:\(userInfo.avatarUrl ?? "")")
    }
}

提示

该接口仅返回本地已内存的数据。如需主动从服务端获取最新用户信息，请调用 EMUserInfoManager#fetchUserInfoById 方法。详见 管理用户属性。

注意事项

  • EMOptions#enableUserInfo 必须在 SDK 初始化前设置。
  • 建议优先注册 EMUserInfoManagerDelegate，以便在本地内存更新后及时刷新业务界面。
  • EMChatMessage#senderInfo 表示当前本地可用的发送方信息，不保证一定是刚收到消息时的最终最新值。
  • 当消息中的更新时间晚于本地内存时，SDK 会自动从服务端拉取最新数据并更新本地内存。
  • EMUserInfoManager#getUserInfoByIds 仅查询本地内存，不会主动从服务端拉取最新数据。

常见问题

何时设置开启用户信息自动管理？

必须在调用 EMClient.shared().initializeSDK(with: options) 初始化 SDK 之前设置。若在 SDK 初始化完成后再设置，用户信息自动管理功能不会生效。

功能开启后，SDK 会自动执行哪些操作？

开启用户信息自动管理 EMOptions#enableUserInfo 后，SDK 会在登录成功后自动同步当前登录用户信息；在发送消息时自动附带发送方信息及更新时间；在接收消息后自动比较消息中的更新时间与本地内存；在检测到数据更新时自动从服务端拉取最新信息并更新本地内存，同时通过事件通知业务层。

EMChatMessage#senderInfo 一定最新？

不一定。EMChatMessage#senderInfo 返回的是当前本地可用的发送方信息。如果消息触发了用户信息更新，SDK 会先从服务端拉取最新数据并更新本地内存，随后通过相关事件通知业务层刷新界面。

为何建议尽早注册监听？

开启用户信息自动管理功能 后，SDK 可能在登录后的初始同步以及消息触发的用户信息更新场景中通知业务层。建议在业务初始化阶段完成注册监听 EMUserInfoManagerDelegate，以便及时接收事件并刷新界面。

本地读取和服务端获取有何区别？

EMUserInfoManager#getUserInfoByIds 仅查询本地内存，不会发起网络请求，适用于本地展示场景。如果业务需要获取最新的用户信息，应调用对应的服务端接口主动获取。

功能开启后需自己维护内存吗？

通常不需要。开启 EMOptions#enableUserInfo 后，SDK 会负责用户信息的自动同步、更新时间比较、本地内存更新和事件通知。业务层通常只需从本地内存读取数据，并在相关事件中刷新界面。

相关功能

管理群成员名片

启用用户信息自动管理后，SDK 也支持群成员名片的自动同步与更新。你可以进一步实现群成员名片的设置、查询和变更监听。详见 管理群成员名片。

用户属性与用户信息

  • 用户信息：指用于业务展示的用户相关信息，包括用户的 昵称、头像、备注 和 群成员名片。
  • 用户属性：指用户可设置和管理的资料字段，例如，用户昵称、头像、邮箱、电话号码等。你可通过相关接口对这些字段进行设置、更新和查询。详见 管理用户属性。例如，你可以通过 EMUserInfoManager#updateOwnUserInfo 设置当前登录用户的昵称、头像等资料。若用户信息自动管理功能开通（EMOptions#enableUserInfo 设置为 true），更新后的信息会在后续发送消息时自动参与同步。

通过消息同步的发送方信息

开启用户信息自动管理后，接收到的消息中会包含发送方相关信息，包括昵称、头像、备注和群成员名片。

上次编辑于:
环信 IM 文档
© 环信 2026