轻量富文本异步绘制框架

前言

若是遇到上面一个需求, 你会怎么处理, 若干个 UILabel + UIImageView? NSAttributedString拼接? CoreText?

我相信不管是哪一种方式代码量都不小, 而且难以复用, 其余语言写富文本是那么轻松, Android 天生支持简单 HTML, RN(JS) 标签套标签, 而只要用过 iOS 中的富文本都会以为难用... 目前业界功能强大、较为好用的是 YYText, 但设计思想是尽量与 UILabel、UITextView 类似, 因此相对使用也不是特别简单, 并且框架较重. 基于现状开发了一套轻量的框架, 知足大部分富文本需求, 而且提供了手势响应、 绘制回调、 图文对齐、 CoreText 属性扩展、 支持网络图片、 异步绘制性能优化, 最重要的是使用简单, 经过链式语法轻松写出一篇图文混排文本.

示例说明

如图所示一片图文混排, 涉及到字体, 颜色, 字间距, 行间距, 图片对齐, 文字对齐, 描边等等属性, 还有网络图片与本地图片混排, 手势响应等需求, 使用本框架能够下面这样实现:

//...省略常量声明

TextBuild
.append(title).font(titleFont).color(titleColor).onClicked(titleOnClicked).onLayout(titleOnLayout)
.append(firstPara).color(firstParaColor).align(@0)
.append(webImage).font(separateLineFont).minLineHeight(@100)
.append(separateLine).font(separateLineFont).strokeColor(separateLineColor).strokeWidth(@1).horizontalOffset(@30)
.append(locolImage).horizontalOffset(@30)
.append(lastPara).font(lastParaFont).align(@1).maxLineHeight(@20)
.append(bookName).font(bookNameFont).color(bookNameColor).onClicked(bookOnClicked).align(@1)
.append(lineLayer).attachSize(lineLayerSize)
.append(quote).color(quoteColor).letterSpace(@0).minLineSpace(@8).align(@0)
.append(buyButton).attachSize(buyButtonSize).attachAlign(@0)
//设置全局默认属性, 优先级低于指定属性
.entire().maxSize(maxSize).align(@2).letterSpace(@3).minLineHeight(@20).attachAlign(@1).onClicked(textOnClicked).attachSize(attachSize).shadow(shadow).cornerRadius(@50).backgroundLayer(gradientLayer).horizontalMargin(@10).preferHeight(@(preferHeight))
//绘制View
.drawView(^(UIView *drawView) {
    [self.view addSubview:drawView];
});
复制代码

而在实际需求中也能够根据不一样条件对 NSString 进行组合, 最后绘制:

//...省略常量声明

//拼接文章
//标题
NSString *titleString = TextBuild.append(title).font(titleFont).color(titleColor).onClicked(titleOnClicked).onLayout(titleOnLayout);
//首段
NSString *firstParaString = TextBuild.append(firstPara).color(firstParaColor).align(@0);
//图片须要用一个空字符串起头
NSString *webImageString = TextBuild.append(webImage).font(separateLineFont).minLineHeight(@100);
//分割线
NSString *separateLineString = TextBuild.append(separateLine).font(separateLineFont).strokeColor(separateLineColor).strokeWidth(@1).horizontalOffset(@30);
//本地图片
NSString *locolImageString = TextBuild.append(locolImage).horizontalOffset(@30);
//最后一段
NSString *lastParaString = TextBuild.append(lastPara).font(lastParaFont).align(@1).maxLineHeight(@20);
//书名
NSString *bookNameString = TextBuild.append(bookName).font(bookNameFont).color(bookNameColor).onClicked(bookOnClicked).align(@1).maxLineHeight(@20);
//引用线Layer
NSString *lineLayerString = TextBuild.append(lineLayer).attachSize(lineLayerSize);
//引用
NSString *quoteString = TextBuild.append(quote).color(quoteColor).letterSpace(@0).minLineSpace(@8).align(@0);
//按钮
NSString *buttonString = TextBuild.append(buyButton).attachSize(buyButtonSize).attachAlign(@0);

//设置全局默认属性, 优先级低于指定属性
NSString *defaultAttributes = TextBuild.entire()
.maxSize(maxSize).align(@2).letterSpace(@3).minLineHeight(@20).attachAlign(@1).onClicked(textOnClicked).attachSize(attachSize).shadow(shadow).cornerRadius(@50).backgroundLayer(gradientLayer).horizontalMargin(@10).preferHeight(@(preferHeight));

//拼接
TextBuild
.append(titleString)
.append(firstParaString)
.append(webImageString)
.append(separateLineString)
.append(locolImageString)
.append(lastParaString)
.append(bookNameString)
.append(lineLayerString)
.append(quoteString)
.append(buttonString)
//设置默认属性
.append(defaultAttributes)
//绘制Layer
.drawLayer(^(CALayer *drawLayer) {
    [self.view.layer addSublayer:drawLayer];
});
复制代码

核心方法与属性

对 NSString 的扩展, 操做字符串生成绘制对应视图

核心方法

• append(id content)

  拼接
    content 能够是文本(NSString)、图片(UIImage)、图片连接(NSURL)(必须指定attachSize属性)、视图(CALayer/UIView)
  复制代码

• entire()

  设置整段富文本
    优先级低于指定属性, 较为重要的属性 maxSize 设置绘制约束, 部分段落属性只在整段中设置生效
  复制代码

• drawLayer(^(CALayer *drawLayer)completion)

  绘制layer, 没法响应手势, 当有UIView混排建议使用 drawView
  复制代码

• drawView(^(UIView *drawView)completion)

  绘制View, 可响应手势, 建议使用此API
  复制代码

属性

通用属性

• verticalOffset 垂直偏移
• horizontalOffset 水平方向偏移
• onClicked 点击回调
• onLayout 展现回调
• cacheFrame 缓存该段文本绘制位置
• minLineSpace 最小行间距
• maxLineSpace 最大行间距
• minLineHeight 最小行高
• maxLineHeight 最小行高
• align 对齐, 整形, 0为默认靠左 1为靠右 2为居中, 参考 CTTextAlignment
• lineBreakMode 对齐, 整形, 参考 NSLineBreakMode

字符串属性

• font 字体: 文字字体/图片居中对齐字体
• color 颜色
• letterSpace 字间距
• strokeWidth 描边宽度, 整数为镂空, Color不生效; 负数Color生效
• strokeColor 描边颜色
• verticalForm 文字绘制随文字书写方向, 默认 否(0), 是(非0)
• underline 下划线类型, 整形, 0为none, 1为细线 2为加粗 9为双条 参考 CTUnderlineStyle(仅枚举了三种, 其余值也有不一样效果)

图片属性

• attachSize 图片尺寸, 默认为图片自己尺寸, 会根据图片缩放(2x 3x)自动调整
• attachAlign 图片对齐模式, 0为默认, 基准线对齐. 1为居中对齐至特定字体大小 参看 ZJTextattachAlign

段落属性

注: 下面属性多段文本拼接只在 entire() 函数后生效; 若只有一段有效文本(非空字符及其余类型), 也能够直接生效.

• maxSize 绘制的约束尺寸, 默认不限制
• shadow 文字阴影, 对全文生效
• preferHeight 指望绘制高度, 内容居中
• verticalMargin 垂直方向间距, 若设置了 preferHeight 此属性不生效
• horizontalMargin 水平方向间距
• backgroundColor 背景颜色
• backgroundLayer 背景视图, 经常使用图片背景/渐变色背景
• cornerRadius 圆角

性能

整体采用 CoreText + 异步绘制图片完成, 理论上性能会比较高, 通过测试以下数据供参考:

内容: 一段文本加上两张图片

机型: iPhone 6

测试结果:

常规(使用NSAttributedString + UILabel)过程: 建立->显示(绘制) 常规分析:

1. 主线程代码在 28ms 左右. (主线程代码开始 至 结束耗时)
2. UILabel 显示(绘制)耗时在 42ms 左右. (addSubview 至 drawRect 耗时)
3. 综合耗时 70ms 左右, 所有在主线程

异步绘制(本框架)过程: 建立->异步绘制->显示 异步绘制分析:

1. 主线程(建立)代码在 28ms 左右. (主线程代码开始 至 结束耗时)
2. 建立(主线程) + 异步绘制耗时 84ms 左右. (主线程代码开始 至 绘制出图片回调)
3. 由 一、2 得出子线程绘制耗时 56ms 左右, 另外通过屡次试验(大段文字绘制)得出绘制复杂的段落也耗时增加较少
4. 显示耗时 0.75 ms 左右. (addSubview 至 drawRect 耗时)
5. 综合耗时 85ms 左右, 其中主线程 29ms, 子线程 56ms

结论:

1. 相较于常规方式下降了主线程压力 70ms -> 29ms
2. 越复杂的文本收益越高(多控件合一, 异步绘制), 上图中大段富文本绘制时间也只多了 15ms, 耗时增加少
3. 整体耗时增长了15ms, 都在子线程, 毕竟处理的逻辑比系统的多.
4. 整体性能与 YYText 相仿

安装

Github

ZJAttributedText

Pod

pod 'ZJAttributedText'
复制代码

本框架依赖 SDWebImage (几乎全部App都集成了, 能够共用一套缓存逻辑)

尾巴

内部实现代码很少, 几乎全部步骤都添加了注释, 若是须要学习 CoreText, 异步绘制, 链式语法, 还算是个不错的 Demo, 若是你们感兴趣, 能够补充下 CoreText 相关内容, 这部分网上的资料都比较老, 错误也比较多. 欢迎 issue 与 star~