一文讲透Android Span的原理

Span 是什么

看上图中的 Span 是什么？如果你回答是 测试 或者 测试 及下面的下划线那就错了。我们看一下 Google 的定义

Span 是功能强大的标记对象，可用于在字符或段落级别为文本设置样式。通过将 Span 附加到文本对象，能够以各种方式更改文本，包括添加颜色、使文本可点击、缩放文本大小以及以自定义方式绘制文本。Span 还可以更改 TextPaint 属性、在 Canvas 上绘制，以及更改文本布局。

简单的说，Span 是用来处理指定范围内的文本样式的工具。如上图，Span 就为[0, 1]范围内的文本设置了下划线的样式。这里是为了告诉你 Span 不是文本，它是文本处理的工具。真正的文本是分别实现 Spannable 和 Spanned 接口的三个类，分别是 SpannedString 、SpannableString 、SpannableStringBuilder。这三个实现类稍后再讲，我们先看一下 Spannable 和 Spanned 接口。

Spannable 和 Spanned 接口

Spannable 和 Spanned 的区别很简单，Spanned 只能获取 Span，但 Spannable 可以设置和修改 Span 。Spannable 继承 Spanned ，并增加了 setSpan 、removeSpan 方法来设置和修改 Span 。我们先来看 Spannable 接口定义的方法。

Spannable 接口方法

public void setSpan(Object what, int start, int end, int flags);

setSpan 方法为文本设置 Span ，参数作用如下：

• what : 为文本设置的 Span
• start : 设置 Span 的开始的位置
• end : 设置 Span 的结束的位置，end 参数值是不被包含的。例如，要设置上图的下滑线效果，end 值要设置为 2 ,而不是 1。
• flags : Span 的标志位

这里 start 可以等于 end 吗？答案是 SpannedString SpannableString 可以；而 SpannableStringBuilder 在 flags 为 SPAN_EXCLUSIVE_EXCLUSIVE 时不行。flags 的作用到底是什么？这里先不讲，等后面详细介绍 flags 时，你就知道了。

还有个点需要注意，setSpan 内部会判断 what 对象是否之前设置过了，如果是同一个对象，会修改它的位置和flag值。示例代码如下：

UnderlineSpan underlineSpan = new UnderlineSpan();
spannableString.setSpan(underlineSpan, 0, 2, Spannable.SPAN_EXCLUSIVE_EXCLUSIVE);
textView.setText(spannableString);

//修改 Span 的位置
spannableString.setSpan(underlineSpan, 2, 3, Spannable.SPAN_EXCLUSIVE_EXCLUSIVE);
textView.setText(spannableString);

//由于只判断对象是否相同，导致了增加了2个完全相同的 Span
spannableString.setSpan(new UnderlineSpan(), 0, 2, Spannable.SPAN_EXCLUSIVE_EXCLUSIVE);
spannableString.setSpan(new UnderlineSpan(), 0, 2, Spannable.SPAN_EXCLUSIVE_EXCLUSIVE);
textView.setText(spannableString);

public void removeSpan(Object what) 方法用来删除指定的 Span 。这个很简单，就不多介绍了。

Spanned 接口方法

public <T> T[] getSpans(int queryStart, int queryEnd, Class<T> kind)

getSpans 方法获取指定“范围”的指定 Class 的 Span 。如果你想要获取所有的 Span ，你可以使用 Object.class。这里的范围要特别注意，一般我们说的范围是指 start < pos < end 的部分，如下图。

但是，getSpan 方法不光会获取 start < pos < end 的部分，还会获取部分位置在范围内的 Span 。如下图所示：

为什么 Android 要使用这种规则来获取 Span 呢？

答案是让一个 SpanWatcher 能监听到多个 Span。SpanWatcher 是监听 Span （add、remove、set操作时）变化的 Span。它的原理很简单，就是当 Span 变化时，会调用 getSpan 获取范围内的 SpanWatcher，然后调用相应的方法。看下图，采用当前的规则下，SpanWatcher 能监听到 Span1、Span2、Span3; SpanWatcher1 能监听 Span1、Span2; SpanWatcher2 能监听 Span2。如果采用start < pos < end 的部分的规则，就无法通过一个 SpanWatcher 监听多个 Span 了。

public int nextSpanTransition(int start, int limit, Class kind)

返回一个类型的 Span 开始或结束的第一个大于start的偏移，如果没有大于start但小于limit的开始或结束，则返回limit。看文字有点难理解，直接上图。

除了图上的两种情况外，nextSpanTransition 方法只会返回传入的 limit 的值。你没看错，即使 SpanStart == start 时也是返回 limit 的值。

其他 Spanned 定义的方法的介绍如下：

• public int getSpanStart(Object what): 获取指定 Span 的 start 的值。没找到返回 -1
• public int getSpanEnd(Object what): 获取指定 Span 的 end 的值。没找到返回 -1
• public int getSpanFlags(Object tag): 获取 Span 的 flag。没有则返回 0

SpannedString 、SpannableString 和 SpannableStringBuilder

对于这三个类，直接看下面官方文档的对比：