如何在 Android 中定義和使用自定義屬性

更新時(shí)間：2025年07月18日 09:35:06 作者：micro9981

文章介紹了Android中定義和使用自定義屬性的完整流程：通過(guò)attrs.xml聲明屬性,布局文件中應(yīng)用屬性,自定義視圖中通過(guò)TypedArray獲取值,并利用Kotlin的apply、默認(rèn)參數(shù)等特性簡(jiǎn)化代碼,提升布局可重用性和可維護(hù)性,感興趣的朋友一起看看吧

1. 定義自定義屬性

首先，我們需要在 res/values/attrs.xml 文件中定義自定義屬性。這些屬性可以是顏色、尺寸、字符串等。

創(chuàng)建或打開(kāi) res/values/attrs.xml 文件，并添加以下內(nèi)容：

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <declare-styleable name="CustomView">
        <attr name="customColor" format="color" />
        <attr name="customSize" format="dimension" />
    </declare-styleable>
</resources>

在上面的代碼中，declare-styleable 標(biāo)簽定義了一組與 CustomView 關(guān)聯(lián)的屬性。每個(gè) attr 標(biāo)簽定義了一個(gè)屬性及其數(shù)據(jù)類型（這里我們定義了一個(gè)顏色屬性 customColor 和一個(gè)尺寸屬性 customSize）。

2. 在布局文件中使用自定義屬性

接下來(lái)，我們將在布局 XML 文件中使用這些自定義屬性。假設(shè)我們有一個(gè)自定義視圖 CustomView。

在布局文件中（例如 res/layout/activity_main.xml），我們可以這樣使用自定義屬性：

<com.example.CustomView
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    app:customColor="@color/primaryColor"
    app:customSize="16dp" />

在這里，app:customColor 和 app:customSize 是我們?cè)?attrs.xml 中定義的自定義屬性。

3. 在自定義視圖中獲取屬性值

為了在自定義視圖中使用這些屬性值，我們需要在視圖的構(gòu)造函數(shù)中獲取它們。我們可以使用 Kotlin 的特性來(lái)簡(jiǎn)化代碼，例如 apply 函數(shù)。

以下是 CustomView 的 Kotlin 代碼示例：

package com.example
import android.content.Context
import android.graphics.Canvas
import android.graphics.Color
import android.util.AttributeSet
import android.view.View
class CustomView @JvmOverloads constructor(
    context: Context,
    attrs: AttributeSet? = null,
    defStyleAttr: Int = 0
) : View(context, attrs, defStyleAttr) {
    private var customColor: Int = Color.BLACK
    private var customSize: Float = 0f
    init {
        context.theme.obtainStyledAttributes(
            attrs,
            R.styleable.CustomView,
            0, 0
        ).apply {
            try {
                customColor = getColor(R.styleable.CustomView_customColor, Color.BLACK)
                customSize = getDimension(R.styleable.CustomView_customSize, 0f)
            } finally {
                recycle()
            }
        }
    }
    override fun onDraw(canvas: Canvas) {
        super.onDraw(canvas)
        // 使用 customColor 和 customSize 繪制內(nèi)容
    }
}

在上面的代碼中：

使用 @JvmOverloads 注解生成多個(gè)構(gòu)造函數(shù)，以便在 Java 代碼中也能方便地使用。
在 init 塊中使用 context.theme.obtainStyledAttributes 方法獲取屬性值。
使用 apply 函數(shù)將代碼塊作用于 TypedArray 對(duì)象，并在 finally 塊中回收它。

4. 使用樣式應(yīng)用自定義屬性

我們可以在 res/values/styles.xml 文件中定義一個(gè)樣式，并在樣式中指定自定義屬性的默認(rèn)值。

在 res/values/styles.xml 文件中添加以下內(nèi)容：

<resources>
    <style name="CustomViewStyle">
        <item name="customColor">@color/primaryColor</item>
        <item name="customSize">16dp</item>
    </style>
</resources>

然后，在布局文件中應(yīng)用這個(gè)樣式：

<com.example.CustomView
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    style="@style/CustomViewStyle" />

通過(guò)這種方式，我們可以通過(guò)一個(gè)樣式應(yīng)用多個(gè)屬性值，使得布局更加簡(jiǎn)潔和可重用。

5. 使用 Kotlin 的特性

在 Kotlin 中，我們可以利用一些特性來(lái)使代碼更加簡(jiǎn)潔和易讀。例如，使用 apply 函數(shù)可以讓代碼更加流暢：

context.theme.obtainStyledAttributes(attrs, R.styleable.CustomView, 0, 0).apply {
    try {
        customColor = getColor(R.styleable.CustomView_customColor, Color.BLACK)
        customSize = getDimension(R.styleable.CustomView_customSize, 0f)
    } finally {
        recycle()
    }
}

此外，我們還可以使用 Kotlin 的默認(rèn)參數(shù)、命名參數(shù)等特性來(lái)提高代碼的靈活性和可讀性。