[实战]android封装一个Header小组件

我在实战过程中发现,很多重复的组件,于是我就想封装一个,咨询了我们的同事,结果果然可以按照我想的那样实现,非常棒。

android 中封装组件,需要以下几步:

  1. 定义 props
  2. props 与“组件”联系起来;
  3. 集成 xml 布局;
  4. props 中的值设置到 xml 中,如果需要暴露方法,在“组件”中定义即可。

1. 定义 props

attrs.xml 文件中添加下面的内容:

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <declare-styleable name="HeaderComponent">
        <attr name="title" format="string" />
        <attr name="rightText" format="string" />
        <attr name="leftText" format="string" />
    </declare-styleable>
</resources>

其中 HeaderComponent 相当于 props 的类型名称,这里的名称最好也跟“组件名称相同”;其中 attr 就是每一个属性,对应的 name 就是属性名。

2. 将 props 与“组件”联系起来

新建一个 HeaderComponent 的类:

class HeaderComponent: ConstraintLayout {
    private var title: String? = null
    private var rightText: String? = null
    private var leftText: String? = null
    var titleView: TextView? = null
    var rightTextView: TextView? = null
    var leftTextView: TextView? = null
    constructor(context: Context): this(context, null)
    constructor(context: Context, attrs: AttributeSet?): this(context, attrs, 0)
    constructor(context: Context, attrs: AttributeSet?, defStyleAttr: Int): super(context, attrs, defStyleAttr) {
        init(context, attrs)
    }
    private fun init(context: Context, attrs: AttributeSet?) {
        // 拿到对应的属性名称,记得在最后执行 types.recycle()
        val types = context.obtainStyledAttributes(attrs, R.styleable.HeaderComponent)
        title = types.getString(R.styleable.HeaderComponent_title)
        rightText = types.getString(R.styleable.HeaderComponent_rightText)
        leftText = types.getString(R.styleable.HeaderComponent_leftText)

        // 拿到我们编写的布局文件,这部分就相当于固定的部分
        val view = LayoutInflater.from(getContext()).inflate(R.layout.header, this)
        titleView = view.findViewById(R.id.title)
        rightTextView = view.findViewById(R.id.rightText)
        leftTextView = view.findViewById(R.id.leftText)

        // 根据 xml 中设置的值设置
        titleView?.text = title
        rightTextView?.text = rightText
        leftTextView?.text = leftText
        types.recycle()
    }

    // 提供方便快捷的方法
    fun setTitle(title: String) {
        titleView?.text = title
    }
}

需要说明的是获取属性名的时候记得带上类型名,不然找不到:

// 得到 props 的类型名
val types = context.obtainStyledAttributes(attrs, R.styleable.HeaderComponent)
// 拿到传进来的 props 值,属性名的规则是:类型名_xml文件中的attr标签中的name值
title = types.getString(R.styleable.HeaderComponent_title)
rightText = types.getString(R.styleable.HeaderComponent_rightText)
leftText = types.getString(R.styleable.HeaderComponent_leftText)

3. 集成 xml 布局

看上面的代码可以知道 header.xml 文件,就是封装的布局,我定义如下:

<?xml version="1.0" encoding="utf-8"?>
<merge
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="?attr/actionBarSize"
    tools:parentTag="androidx.constraintlayout.widget.ConstraintLayout">

    <TextView
        android:id="@+id/title"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="标题"
        android:textColor="@color/black"
        android:textSize="18sp"
        android:textStyle="bold"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

    <TextView
        android:id="@+id/leftText"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_marginStart="16dp"
        android:text=""
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        tools:visibility="gone" />

    <TextView
        android:id="@+id/rightText"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text=""
        android:layout_marginEnd="16dp"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

    <TextView
        android:id="@+id/button"
        android:layout_width="24dp"
        android:layout_height="24dp"
        android:layout_marginStart="16dp"
        android:background="@drawable/ic_baseline_arrow_back_ios_24"
        android:backgroundTint="@color/black"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

</merge>

5. 根据 props 设置对应的值

在上面的 kotlin 代码中有:

// 拿到我们编写的布局文件,这部分就相当于固定的部分
val view = LayoutInflater.from(getContext()).inflate(R.layout.header, this)
titleView = view.findViewById(R.id.title)
rightTextView = view.findViewById(R.id.rightText)
leftTextView = view.findViewById(R.id.leftText)

// 根据 xml 中设置的值设置
titleView?.text = title
rightTextView?.text = rightText
leftTextView?.text = leftText

6. 使用封装的组件

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:background="#f2f2f2"
    tools:context=".MainActivity">

    <com.wu.learn.HeaderComponent
        android:layout_width="0dp"
        android:layout_height="?attr/actionBarSize"
        android:background="@color/white"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        app:title="标题"
        app:rightText="消息"
        tools:ignore="MissingConstraints" />

</androidx.constraintlayout.widget.ConstraintLayout>

效果如下:


简单的demo

更新日志(2021-05-27)
为了减少布局嵌套,封装的组件我采用了 <merge> ;把原先的 LinearLayout 换成了 ConstraintLayout ,现在我全力拥抱约束布局。

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

推荐阅读更多精彩内容