初识 iOS 文本高亮库 Highlighter:为什么一行代码就能高亮任意控件的文本?
初识 iOS 文本高亮库 Highlighter:为什么一行代码就能高亮任意控件的文本?
如果你正在开发带搜索功能的 iOS 应用,多半遇到过这样的需求:用户输入关键词后,需要把列表中匹配的文本"标黄"显示。Highlighter 是一个专为 iOS 打造的文本高亮库(口号是 "Highlight whatever you want!"),它能自动找出 UILabel、UITextView、UITextField、UIButton 等控件,并对其中匹配的文本应用高亮样式——整个过程只需要一行代码。下面带你初识这个轻量级 Swift 库,并看懂它"一行代码"背后的魔法。
先认识 Highlighter:它解决了什么痛点 🖍️
手动实现文本高亮,通常要经历这几步:
- 取出控件的原始文本
- 用正则或
range(of:)找到关键词位置 - 把普通文本和命中片段分别拼成
NSAttributedString - 再把结果写回控件
而 Highlighter 把这些封装成了统一的 highlight(text:normal:highlight:) 方法,直接调用即可:
cell.highlight(text: "Foo", normal: nil, highlight: [.backgroundColor: UIColor.yellow])
对 UITableViewCell 这类容器,它还能自动发现内部存储的受支持控件并逐个高亮,无需你手动遍历子视图。
核心原理:为什么一行代码就够了?✨
"一行代码"的底气来自三个简洁的设计,源码总量不到 150 行,非常适合新手通读。
1️⃣ 统一协议:让所有控件都会"高亮"
核心是 Highlightable 协议(见 Highlightable.swift),它只要求实现者提供两样东西:
textValue:当前文本内容attributedTextValue:可设置的富文本属性
库通过扩展为四种常见控件提供了实现(见 Highlightables.swift),例如 UIButton 会自动处理 titleLabel 的取文本与回写。协议还附带了默认高亮实现(Highlightable.swift):找到所有匹配范围 → 生成带样式的富文本 → 一步写回控件。
💡 这意味着你只需让自己的控件 conform 协议并提供两个属性,就能接入高亮能力,扩展成本极低。
2️⃣ Mirror 反射:自动找到容器里的控件
"自动发现"的魔法在 HighlightableContainer.swift:
- 库通过 Swift 的
Mirror反射容器对象的存储属性 - 把其中符合
Highlightable协议的属性挑出来,逐个高亮 - 可选传入
type参数,只处理某一类控件
需要注意:它检查的是容器属性中直接存储的控件,不会递归遍历 UIView.subviews。所以推荐把 UILabel 等控件声明为 cell 的属性(这也是常见做法),而不是散落在复杂视图层级里。
3️⃣ 精准定位 + 样式拼装
- String+Extensions.swift 中的
ranges(of:)会找出关键词全部出现位置(默认忽略大小写),因此一段文字命中多处也能全部标出 - NSAttributedString+Extensions.swift 负责把文本按命中位置切段:命中片段应用
highlight样式,其余部分应用normal样式,最后拼成完整的富文本
快速上手:安装与使用步骤 🚀
环境要求
| 项目 | 要求 |
|---|---|
| Swift | 6.0 |
| iOS | 15.0 及以上 |
| 包管理 | Swift Package Manager / CocoaPods |
一键安装步骤
Swift Package Manager:在 Xcode 中选择 File ▸ Add Package Dependencies…,填入仓库地址即可;或在 Package.swift 中添加依赖声明(参考 Package.swift 查看库自身的包定义)。
CocoaPods:在 Podfile 中添加一行:
pod 'Highlighter', '2.0.0'
库的版本信息可参见 Highlighter.podspec 与 CHANGELOG.md。
最快使用方法
方式一:直接高亮单个控件
label.highlight(text: "Foo", normal: nil, highlight: [.backgroundColor: .yellow])
text:要高亮的关键词normal:未命中文本的属性(传nil即保持原样)highlight:命中文本的属性,可组合backgroundColor、foregroundColor等
方式二:高亮容器内所有受支持控件
view.highlight(text: "Foo", normal: normalAttributes, highlight: highlightedAttributes)
方式三:只处理指定类型的控件
view.highlight(text: "Foo", normal: nil, highlight: [.backgroundColor: .yellow], type: UIButton.self)
典型场景:搜索列表关键词高亮 🔍
最经典的用法就是搜索高亮。README 中给出的示例来自一个搜索列表:
func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
guard let cell = tableView.dequeueReusableCell(withIdentifier: "Cell", for: indexPath) as? SearchViewCell else { return UITableViewCell() }
if let changedText = ynSearchTextFieldText {
cell.highlight(text: changedText, normal: nil, highlight: [.backgroundColor: UIColor.yellow])
}
return cell
}
用户每修改一次搜索框文本,cell 中的匹配词就自动带上黄色背景,效果类似系统"查找"功能——而你只写了一行 highlight 调用。
项目文件地图:读码路线图 📚
| 文件 | 作用 |
|---|---|
| Highlightable.swift | 核心协议与默认高亮实现 |
| Highlightables.swift | 四种控件的协议实现 |
| HighlightableContainer.swift | 基于 Mirror 的容器自动发现 |
| String+Extensions.swift | 关键词多位置定位 |
| NSAttributedString+Extensions.swift | 富文本样式拼装 |
| HighlighterTests.swift | 单元测试,可对照行为预期 |
配合 README.md 的完整说明和 LICENSE(MIT 协议),这个项目是学习"用协议 + 扩展做能力注入"设计思路的优质入门材料。
小结 📝
- 一行代码高亮:
highlight(text:normal:highlight:)把定位、拼装、回写全包了 - 自动发现控件:
Mirror反射容器属性,省去手动遍历 - 易扩展:为自己的控件 conform
Highlightable即可接入 - 零依赖:仅依赖 Foundation 与 UIKit,体积极小,放心引入
无论是搜索过滤、关键词标记还是重点提示,Highlighter 都能用最少的心智负担,让 iOS 界面里的任意文本"亮"起来。