使用 Swift 5 字符串插值快速构建 AttributeString

一直以来,在 Cocoa 体系里构建富文本是一件很繁琐的事情,使用 Foundation 框架里的 NSAttributeString 来进行构建,有着要区分可变与不可变,传入需要查阅文档的参数字典,没有类型检查等种种别扭之处。Swift 5 出现的新字符串插值特性,让处理自定义字符串字面量成为可能。

Swift 5 的字符串插值

简单来说,这个特性能让开发者自己实现对字面量中插值的解析和逻辑实现。例如:

let string:CustomString = "\(num: 10)"

这样的字符串字面量,开发者可以通过实现类似 func appendInterpolation(num: Int) 这样的方法,实现对 num 的处理。要实现这样的效果,大概分为以下几个步骤:

  1. 自定义类型并遵循 ExpressibleByStringInterpolation
  2. 在类型中嵌套遵循 StringInterpolationProtocol 的插值类型
  3. 插值类型自定义一到多个不同参数的 func appenInterpolation(...) 重载方法,并处理对应参数的逻辑

这样通过字符串插值,理论上可以实现任意的功能,比如通过字符串构建成 SQL 操作,正则操作,生成 HTML 网页,甚至感觉可以实现一些运行时的黑科技。

实现 AttributeString 处理

首先自定义类型,并先实现 ExpressibleByStringLiteral 用于支持字符串字面量(ExpressibleByStringLiteralExpressibleByStringLiteral 的子协议)。这样我们就可以通过字符串字面量构建一个没有任何属性的 NSAttributedString

public struct EasyText {
    public let attributedString: NSAttributedString
}

extension EasyText: ExpressibleByStringLiteral {
    public init(stringLiteral: String) {
        attributedString = NSAttributedString(string: stringLiteral)
    }
}

接着实现 ExpressibleByStringInterpolation 协议,嵌套插值类型,并遵循 StringInterpolationProtocol。该插值构建完会通过 init(stringInterpolation: StringInterpolation) 方法来实现构建自定义类型。appendLiteral 方法用于正常的字符串类型的插值处理。

extension EasyText: ExpressibleByStringInterpolation {
    public init(stringInterpolation: StringInterpolation) {
        attributedString = NSAttributedString(attributedString: stringInterpolation.rawAttributedString)
    }
    
    public struct StringInterpolation:StringInterpolationProtocol {
        let rawAttributedString:NSMutableAttributedString
        
        public init(literalCapacity: Int, interpolationCount: Int) {
            rawAttributedString = NSMutableAttributedString()
        }
        
        public func appendLiteral(_ literal:String) {
            rawAttributedString.append(NSAttributedString(string: literal))
        }
      
    }
}

接下来实现一到多个 appendInterpolation 方法,例如让插值支持添加 NSTextAttachment

public struct StringInterpolation:StringInterpolationProtocol {
    // ...
        public func appendInterpolation(attachment:NSTextAttachment) {
            rawAttributedString.append(NSAttributedString(attachment: attachment))
    }
}

EasyText 使用

笔者将 NSAttributedString 里的属性都使用字符串插值进行了支持,实现了一个几百行的库。使用这个库,可以做到以下面简单的方式构建 NSAttributedString

let text:EasyText = "\("font is 30 pt and color is yellow", .font(.systemFont(ofSize: 20)), .color(.blue))"

textView.attributedText = text.attributedString

有以下特性:

  • 类型安全,所有支持的 NSAttributedString.Key 均有类型检查
  • 支持多平台,iOS/macOS
  • 支持大部分常用 NSAttributedString.Key,暂时没有支持的提供接口构建
  • 支持常用的运算符,如 ++=,以及与其他类型 StringNSAttributedString 的运算
  • 支持插入图片

更多使用方法详见 例子

最后

EasyText 已开源,可以通过 Cocoapods、Cathrage、SwiftPackageManager 进行集成。

如果您觉得有帮助,不妨给个 star 鼓励一下,有任何问题欢迎评论。

参考链接

StringInterpolation in Swift 5 — Introduction

StringInterpolation in Swift 5 — AttributedStrings

Fix ExpressibleByStringInterpolation

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

推荐阅读更多精彩内容