【Android】如何像html一样写span?

Html.fromHtml

老方法也许永不过时:

Html.fromHtml("Text, <b>Bold</b>, <i>italic</i>")

但这个方法也存在不少缺点:拼接变量比较麻烦,虽然使用kotlin的原始字符串可以方便地拼接字符串,但还是有诸如支持的标签比较少,img标签处理比较麻烦,扩展标签和自定义span也很麻烦等问题。

Kotlin

kotlinx.html的启发,我们可以利用kotlin支持dsl,运算符重载,扩展函数等特性实现下面类似html + css的span写法:

textView.text = createSpanned {
    style {
        h3 { 
            color = 0xFF8D07F6.toInt() 
        }
        "serif" { 
            fontFamily = Typeface.SERIF 
        }
    }
    
    h3 { +"::before" }
    p { 
        b { +"KtSpans" }
        +" is inspired by "
        a("https://github.com/Kotlin/kotlinx.html") {
            +"kotlinx.html"
        }
    }
    br {}
    h3 { +"#now" }
    p {
        +"Make spans on android easy to use."
    }
    br {}
    h3 { +"::after" }
    p {
        className = "serif"
        +"More possibilities is comming"
    }
}

然后得到这样的结果:

screenshot_01_clipped.png

实现

只是简略的说明主要思路,可以直接跳到下面的Github链接和使用部分。

1. createSpanned {}

首先从最外层开始,createSpanned 块可以简单地利用带接收者的lambda定义:

inline fun createSpanned(body: RootTag.() -> Unit): Spanned {
    val root = RootTag()
    root.body()
    return root.span()
}

2. style {}

style是样式属性块,定义为:

inline fun RootTag.style(body: StyleSheet.() -> Unit) {
    this.style = StyleSheet().also(body)
}

StyleSheet类包含了用于存储标签属性的map:

// StyleSheet.kt
val tagAttrs: MutableMap<String, Attributes> = HashMap()

为了在style块中能定义各个标签的属性,还需要定义这样的函数:

// StyleSheet.kt
inline fun a(body: Attributes.() -> Unit) {
    val attrs = tagAttrs[A] ?: Attributes().also {
        tagAttrs[A] = it
    }
    attrs.body()
}

Attributes定义了一些共有的属性:

open class Attributes(
    var fontSize: Size? = null,
    var fontFamily: Typeface? = null,
    var fontStyle: Int = Typeface.NORMAL,
    var lineHeight: Size? = null,
    var align: Layout.Alignment? = null,
    var backgroundColor: Int = 0,
    var color: Int = 0,
    var decoration: Decoration? = null
)

3. 标签内容的dsl

标签类Tag内部定义了一个SpannableStringBuilder的变量,用于添加文本和子标签:

// Tag.kt
private val spanBuilder = SpannableStringBuilder()

open fun span(): Spanned {
    return spanBuilder
}

open fun spanBuilder(): SpannableStringBuilder {
    return spanBuilder
}

Tag中重写String的一元运算符+

// Tag.kt
 operator fun String.unaryPlus() {
    spanBuilder.append(this)
}

这样就可以通过+"Text"的方式(kotlinx.html的方式)添加内容了。

最后还需要在定义Tag的扩展函数来实现dsl和span的逻辑:

inline fun Tag.a(url: String, crossinline body: Tag.() -> Unit) {
    checkRoot(this)
    val tag = Tag(A, root)
    tag.body()
    root!!.defaultStyle.a {}
    insertTag(tag, arrayOf(URLSpan(url)))
}

insertTag()函数包含了样式属性和span等内容的处理,同时把生成好的SpannableStringBuilder添加到父标签中。实现和更多细节可点击下面的Github链接查看项目。

Github和使用

项目地址

欢迎各位大佬的New Issue,Star,Fork
https://github.com/dokar3/KtSpans

基本使用

1. 添加gradle依赖:

implementation 'io.github.dokar3:ktspans:1.0.2'

2. 使用createSpanned创建span并使用一些常用标签:

textView.text = createSpanned {
    // 定义样式 
    style { ... }
    
    // 标题标签
    h1 { ... }
    // 水平分割线标签
    hr {}
    // 段落标签
    p { ... }
    // 图片标签
    img(drawable) { ... }
    // 链接标签
    a(url) { ... }
    // 点击事件标签
    clickable(onClick) { ... }
    ...
}

完整的内置标签:README

3. 标签内属性:

p {
    attrs {
        fontStyle = Typeface.BOLD
    }
    +"Some text"
}

完整的共有属性见上面的Atrributes类或浏览README

4. 一些特殊标签的完整属性:

quote {
    fullAttrs {
        stripeColor = accent
        stripeWidth = 4.dp
        gapWidth = 8.dp
    }
    +"A quote here"
}

5. 使用外部的样式:

val appTextStyle = createStyle {
    h1 { ... }
    p { ... }
    quote { ... }
    bullet { ... }
    hr { ... }
}

然后在 createSpanned 中:

createSpanned {
    style(appTextStyle)
    ...
}

6. 包含/重用span:

fun header(): Spanned {
    val banner = ContextCompat.getDrawable(this, R.mipmap.ic_banner)!!
    return createSpanned {
        img(banner) {}
        h1 { +"Title" }
        p { ... }
    }
}

然后在 createSpanned 中:

createSpanned {
    +header()

    p { ... }
    ...
}

自定义标签:

查看README

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

推荐阅读更多精彩内容