基于Telegram二次开发 --- 消息气泡:Message Bubbles

Bubbles(气泡)作为一种展示UI,几乎与我们工作生活密不可分;如果消息只是一段纯文本或一个图片,那就没什么可说的;但 Telegram 中的情况就很复杂,因为消息中的元素很多,比如文本、富文本、markdowm 文本、图片、相册、视频、文件、网页、位置等;因为一条消息可以包含多个任意类型的元素,所以它就显得更加复杂了。

本文将阐述 Telegram 如何在其异步 UI 框架上构建消息气泡。

1、Classes 概述

image.png

ChatControllerImpl 是管理用户消息聊天界面的核心控制器;它的内容控制器 ChatControllerNode 主要由以下 node 构成:

class ChatControllerNode: ASDisplayNode, UIScrollViewDelegate {
    ...
    let backgroundNode: WallpaperBackgroundNode  // background wallpaper
    let historyNode: ChatHistoryListNode // message list
    let loadingNode: ChatLoadingNode  // loading UI
    ...
    private var textInputPanelNode: ChatTextInputPanelNode? // text input
    private var inputMediaNode: ChatMediaInputNode? // media input
    
    let navigateButtons: ChatHistoryNavigationButtons // the navi button at the bottom right
}
  • ChatHistoryListNode 作为 ListView 的子类,负责渲染消息列表以及其他信息 nodes;它有两种 UI 模式:bubbleslistbubbles 模式用于普通聊天,list 用于在聊天消息详情页面按媒体、文件、语音等类型筛选出对应的历史聊天记录;本文仅讨论 bubbles 模式。
    作为其核心数据属性的 items 有三种类型的 ListViewItem 可供使用;每个 item 都实现 nodeConfiguredForParams 方法用来返回对应的 UI node
public protocol ListViewItem {
    ...
    func nodeConfiguredForParams(
        async: @escaping (@escaping () -> Void) -> Void, 
        params: ListViewItemLayoutParams, 
        synchronousLoads: Bool, 
        previousItem: ListViewItem?, 
        nextItem: ListViewItem?, 
        completion: @escaping (ListViewItemNode, @escaping () -> (Signal<Void, NoError>?, (ListViewItemApply) -> Void)) -> Void
    )
}

2、List 倒置

聊天消息列表将最新消息放在底部,垂直滚动指示器也从底部开始;实际上,它是 iOS 上很常见的 list UI 倒置;

Telegram 使用 AsyncDisplayKitASTableNode 类似的 UI 变换伎俩;ChatHistoryListNode 利用 ASDisplayNodetransform 属性旋转了 180° ,因此它所有的 content node 也要被旋转。

// rotate the list node
public final class ChatHistoryListNode: ListView, ChatHistoryNode {
    public init(...) {
        self.transform = CATransform3DMakeRotation(CGFloat.pi, 0.0, 0.0, 1.0)
    }
}
// rotate content nodes
public class ChatMessageItemView: ListViewItemNode {
    public init(...) {
        self.transform = CATransform3DMakeRotation(CGFloat.pi, 0.0, 0.0, 1.0)
    }
}
final class ChatMessageShadowNode: ASDisplayNode {
    override init() {
        self.transform = CATransform3DMakeRotation(CGFloat.pi, 0.0, 0.0, 1.0)
    }
}
final class ChatMessageDateHeaderNode: ListViewItemHeaderNode {
    init() {
        self.transform = CATransform3DMakeRotation(CGFloat.pi, 0.0, 0.0, 1.0)
    }
}
...

以下屏幕截图演示了应用逐步被旋转后的样子:

image.png

3、ListView Items

  • ChatBotInfoItem:如果 Peer 是 Telegram 机器人,则将机器人标识插入到 items 的第一个位置。
  • ChatUnreadItem:区分未读和已读消息的标识。
  • ChatMessageItem:它将聊天消息按以下建模:
public final class ChatMessageItem: ListViewItem, CustomStringConvertible {
    ...
    let chatLocation: ChatLocation
    let controllerInteraction: ChatControllerInteraction
    let content: ChatMessageItemContent
    ...
}

public enum ChatLocation: Equatable {
    case peer(PeerId)
}

public enum ChatMessageItemContent: Sequence {
    case message(
        message: Message, 
        read: Bool, 
        selection: ChatHistoryMessageSelection, 
        attributes: ChatMessageEntryAttributes)
    case group(
        messages: [(Message, Bool, ChatHistoryMessageSelection, ChatMessageEntryAttributes)])
}
  • ChatControllerInteraction 是一个维护了 ChatControllerImpl 96个操作回调数据类;它通过 items 传递,使它们能够在不引用控制器的情况下触发回调。
  • ChatMessageItemContent 的结构很有趣;它作为一个枚举,可以是一条或一组消息;在我看来,它可以被简化成 .group 用一个 .message 元素组来表示。
  • Message 通过 MessageAttributeMedia 两个协议描述消息中的内容元素。
public final class Message {
    ....
    public let author: Peer?
    public let text: String
    public let attributes: [MessageAttribute]
    public let media: [Media]
    ...
}

public protocol MessageAttribute: AnyObject, PostboxCoding { ... }

public protocol Media: AnyObject, PostboxCoding {
    var id: MediaId? { get }
    ...
}

Message 的实例始终有一个 text 条目和一些可选的 MessageAttribute;如果attributesTextEntitiesMessageAttribute 条目,则可以通过 stringWithAppliedEntities 构造属性字符串;然后可以在 bubble 中展示富文本。

// For example, this one states the entities inside a text
public class TextEntitiesMessageAttribute: MessageAttribute, Equatable {
    public let entities: [MessageTextEntity]
}

public struct MessageTextEntity: PostboxCoding, Equatable {
    public let range: Range<Int>
    public let type: MessageTextEntityType
}

public enum MessageTextEntityType: Equatable {
    public typealias CustomEntityType = Int32
    
    case Unknown
    case Mention
    case Hashtag
    case Url
    case Email
    case Bold
    case Italic
    case Code
    ...
    case Strikethrough
    case BlockQuote
    case Underline
    case BankCard
    case Custom(type: CustomEntityType)
}

协议 Media 及其类的实现描述了一组丰富的媒体类型,如 TelegramMediaImageTelegramMediaFileTelegramMediaMap 等。

总而言之,Message 基本上是带有几个媒体附件的属性字符串,而ChatMessageItem 实际上是一组 Message 实例;这种设计可以灵活地表达复杂的消息内容并轻松的保持向后兼容;例如,将 grouped album 表示为具有多个消息的 item,而每个消息的媒体为 TelegramMediaImage

4、Bubble Nodes

ChatMessageItem 实现 nodeConfiguredForParams 用数据匹配对应 bubble nodes;如果我们查看代码,会发现它对 item 结构有一些规定。

  • 如果第一条消息有一个小于 128 KB 的 Sticker 动画媒体文件,则选择 ChatMessageAnimatedStickerItemNode 渲染带有 Stickerbubble;该 item 中的其他消息和媒体数据将被忽略。
  • large emoji 在 app 中默认处于打开状态;如果一条消息只有一个 emoji 字符或所有字符都是 emoji,则使用 ChatMessageAnimatedStickerItemNode 或者 ChatMessageStickerItemNode大的效果渲染,而不是当成纯文本。
    image.png
  • 如果某条消息的第一条消息有即时视频文件,则选择 ChatMessageInstantVideoItemNode 来显示即时视频,其他内容将被忽略。
  • 另外,ChatMessageBubbleItemNode 负责处理结构化消息;ChatMessageBubbleItemNode 通过将数据映射到 ChatMessageBubbleContentNode 的 18 个子类来遍历 item 并构建 sub-nodescontentNodeMessagesAndClassesForItem 是维护其映射逻辑的核心函数:
private func contentNodeMessagesAndClassesForItem(_ item: ChatMessageItem) -> [(Message, AnyClass, ChatMessageEntryAttributes)] {
    var result: [(Message, AnyClass, ChatMessageEntryAttributes)] = []
    ...
    outer: for (message, itemAttributes) in item.content {
        inner: for media in message.media {
            if let _ = media as? TelegramMediaImage {
                result.append((message, ChatMessageMediaBubbleContentNode.self, itemAttributes))
            } else if {...}
        }
        
        var messageText = message.text
        if !messageText.isEmpty ... {
            result.append((message, ChatMessageTextBubbleContentNode.self, itemAttributes))
        }
    }
    ...
}

5、Layout

image.png

bubble 的布局由 ListView 的异步布局机制驱动;上图显示了重点布局方法的调用流程;需要注意的一件事是 ListView 不会缓存布局结果。

参考资料:

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,189评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,577评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,857评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,703评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,705评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,620评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,995评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,656评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,898评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,639评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,720评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,395评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,982评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,953评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,195评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,907评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,472评论 2 342

推荐阅读更多精彩内容