Android SpannableStringBuilder 持久化探索

问题

业务上需要将一些数据缓存到本地，思路是定义个类，赋值后使用 Gson 转换为 Json 数据存到本地。但是由于需要 SpannableStringBuilder 来保存Text的富文本属性，尝试序列化会 Json 后，再反序列化为 SpannableStringBuilder 赋值给 TextView 会有一些意外的错误。

Stack trace:  
java.lang.IndexOutOfBoundsException: setSpan (0 ... -1) has end before start
	at android.text.SpannableStringInternal.checkRange(SpannableStringInternal.java:485)
	at android.text.SpannableStringInternal.setSpan(SpannableStringInternal.java:199)
	at android.text.SpannableStringInternal.copySpansFromSpanned(SpannableStringInternal.java:87)
	at android.text.SpannableStringInternal.<init>(SpannableStringInternal.java:48)
	at android.text.SpannedString.<init>(SpannedString.java:35)
	at android.text.SpannedString.<init>(SpannedString.java:44)
	at android.text.TextUtils.stringOrSpannedString(TextUtils.java:532)
	at android.widget.TextView.setText(TextView.java:6318)
	at android.widget.TextView.setText(TextView.java:6227)
	at android.widget.TextView.setText(TextView.java:6179)

探索

SpannableString

起初尝试将 SpannableStringBuilder 转为 SpannableString：

val spannableStringBuilder = SpannableStringBuilder("测试文本")
val spannableString = SpannableString.valueOf(spannableStringBuilder)

虽然恢复数据时不会报错，但 SpannableString 的属性全部消失了。

Html

于是开始检索如何持久化 SpannableStringBuilder， 在 Stackoverflow 上有这么一个方案

android: how to persistently store a Spanned?

其中提到需要可以使用 Android 的 Html 类的 Html.toHtml 方法将 SpannableStringBuilder 数据转换为 html 的标签语言，恢复时再使用 Html.fromHtml

val spannableStringBuilder = SpannableStringBuilder("测试文本")

val htmlString = Html.toHtml(spannableStringBuilder)

val spannableStringBuilder = Html.fromHtml(htmlString)

测试了一个，以上方式确实是一个顺利解决的崩溃问题。需要注意的是，Html 的两个方法都是耗时方法，最好异步调用。

自定义 Gson 序列化和反序列化适配器

项目的 Json 解析框架使用的是 Gson，支持自定义序列化和反序列化。于是，编写一个适配器实现 JsonSerializer和 JsonDeserializer

class SpannableStringBuilderTypeAdapter : JsonSerializer<SpannableStringBuilder>,
	JsonDeserializer<SpannableStringBuilder> {
	override fun serialize(
		src: SpannableStringBuilder?,
		typeOfSrc: Type?,
		context: JsonSerializationContext?
	): JsonElement {
		return src?.let {
			JsonPrimitive(Html.toHtml(src))
		} ?: JsonPrimitive("")
	}

	override fun deserialize(
		json: JsonElement?,
		typeOfT: Type?,
		context: JsonDeserializationContext?
	): SpannableStringBuilder {
		return json?.let {
			val fromHtml = Html.fromHtml(json.asString).trim()
			SpannableStringBuilder(fromHtml)
		} ?: SpannableStringBuilder("")
	}
}

	//使用
	Gson gson = new GsonBuilder()
				.setDateFormat("yyyy-MM-dd hh:mm:ss")
				.registerTypeAdapter(SpannableStringBuilder.class,
						new SpannableStringBuilderTypeAdapter())
				.create();
	

以上代码可以很好的工作，如果细心的话，可以注意到反序列化时用到 trim()，因为反序列化为 SpannableStringBuilder 后字符串末尾会多处两个换行符，这个 Stackoverflow 有提到HTML.fromHtml adds space at end of text?。

总结，这次探索让我对持久化多了一些思路，对于一些无法修改源码的类可以自定义适配器来序列化。