寫在前面:
之前這篇文章發(fā)表在我的CSDN博客中, 由于CSDN博客使用過于繁瑣 ,趁著這段時間沒啥事情可做(又要開始找新東家了), 將原有的文章整理后發(fā)布到簡書. 原來CSDN博客也將停止更新. 有寫得不對, 或者有更好的解決方案, 歡迎大家指出.

關(guān)于Android自定義屬性網(wǎng)上已經(jīng)有很多大神都已經(jīng)詳細(xì)的講解過了. 關(guān)于如何使用自定義屬性大家可以參考鴻洋_大神的這篇 Android 深入理解Android中的自定義屬性 , 在此小弟再補充一些在自定義屬性時候應(yīng)該注意的一些細(xì)節(jié).

1. 如何定義可被多個自定義控件使用的屬性
2. 如何使用Android已經(jīng)定義好的屬性
3. 各種類型的屬性如何定義(文字樣式 , 背景)等
4. 如何讀取各種類型的自定義屬性
5. 如何使用樣式style屬性給自定義控件設(shè)置樣式

1. 如何定義可被多個自定義控件使用的屬性

在編寫自定義控件的時候,經(jīng)常會遇到兩個或多個自定義控件使用同一個屬性名的情況,假設(shè)有兩個自定義控件A 和 B ,各自都有屬性attr1.那么我們在定義A控件的時候可以像下面這樣定義attr1屬性.

<declare-styleable name="CustomView">
        <attr name="attr1" format="string"/>
</declare-styleable>

接下來我們要在另外一個自定義控件B中使用名稱為"attr1"的自定義屬性,那么我們理所當(dāng)然的也會像上面這樣定義這個屬性,那么編譯器會拋錯,錯誤日志如下:

Error:Execution failed for task ':CustomAttributes:mergeDebugResources'.
> /xxx/xxx/xxx/xxx/xxx/src/main/res/values/attrs.xml: Error: Found item Attr/attr1 more than one time

那么我們?nèi)绾味x一個能被多個自定義控件使用的屬性呢?

我們知道在java類中定義一個被多個實例方法共享的變量---將變量定義在方法體外面,因此我們在自定義屬性時也可以使用同樣的方法將屬性定義在<declare-styleable></declare-styleable>標(biāo)簽之外,這樣自定義屬性就可以被多個自定義控件使用了,代碼如下:

<!-- 將公用的屬性定義在<declare-styleable></declare-styleable>標(biāo)簽之外,即可被多個自定義控件使用 -->
<attr name="attr1" format="string"/>

2. 如何使用Android已經(jīng)定義好的屬性

Android系統(tǒng)已經(jīng)為我們定義好了很多屬性名稱,所有以命名空間android:(xmlns:android="http://schemas.android.com/apk/res/android")開頭的屬性都是Android已經(jīng)定義好的屬性, 在使用的時候只需要直接使用即可, 但是應(yīng)該注意的是, 如果這個屬性在被繼承類中已經(jīng)使用過那么建議不要使用, 如TextView 的android:text屬性就是已經(jīng)被使用的屬性, 所以在自定義控件時候如果繼承自TextView 那么這個屬性就不應(yīng)該被使用.

<declare-styleable name="CustomView">
        <!--我們可以按下面三行這樣來為自定義控件添加,系統(tǒng)已經(jīng)聲明過的屬性-->
        <attr name="android:divider"/>
        <attr name="android:dividerPadding"/>
        <attr name="android:showDividers"/>
</declare-styleable>

各種類型的屬性如何定義

Android中的屬性是如何定義的, 在使用自定義屬性的時候我們應(yīng)該了解Android是如何自定義屬性的.

• 簡單類型的屬性: 像string,integer等類型的屬性,我們可以使用<attr format="string" name="屬性名"/> 來定義 .
• 復(fù)合類型的屬性: 像textColor,background 這樣的復(fù)雜屬性 既可以使用 #FF333333 又可以使用 @drawable/text_color 類型的值. #FF333333 屬于 color 類型 而 @drawable/text_color 屬于 reference 類型 ,這樣的屬性又改如何定義, 這就需要定義復(fù)合類型的屬性, 因此我們可以通過 color| reference 來定義如: <attr format="color|reference" name="屬性名" />.

下面是各種類型屬性定義說明.

4.如何讀取各種類型的自定義屬性

一般步驟: 
1. 第一步獲取自定義控件屬性值的集合(TypedArray)
2. 第二步從獲取的集合中取出每個屬性值
3. 第三步將讀取的屬性值應(yīng)用到自定義控件

1). 獲取自定義控件屬性值的集合
屬性值得集合我們可以通過context.obtainStyledAttributes方法來讀取,首先來了解一下下面這個方法

public final TypedArray obtainStyledAttributes(
            AttributeSet set, @StyleableRes int[] attrs, @AttrRes int defStyleAttr,
            @StyleRes int defStyleRes) {
        return getTheme().obtainStyledAttributes(
            set, attrs, defStyleAttr, defStyleRes);
    }

第二個參數(shù): 這是一個數(shù)組,指定我們需要獲取哪些屬性.
第三個參數(shù): 指定一個樣式,這里我們指定的是attr.xml定義的樣式屬性
第四個參數(shù): 指定一個默認(rèn)的樣式文件.

2). 從獲取的集合中取出每個屬性值
自定義屬性有 string,integer,color,reference等簡單類型, 也有 color|reference 等這種復(fù)合類型.復(fù)合屬性的讀取需要區(qū)別對待. 如對于字體和背景同樣是 color|reference 類型,但是他們的讀取方法也有區(qū)別 , 如textColor 一般使用 ColorStateList 類型background 一般使用 Drawable 類型. 因此需要使用不同的接口來讀取.

• ColorStateList 類型使用getColorStateList(R.styleable.xxx) 方法;
• Drawable 類型使用getDrawable(R.styleable.xxx)方法;
• 簡單類型使用a.getString(R.styleable.CustomView_CustomString)方法.

具體介紹請參考下面代碼:

public CustomView(Context context, AttributeSet attrs) {
        super(context, attrs);
        final Resources res = getResources();
        // 這里能讀取的屬性是在<declare-styleable name="CustomView">定義的屬性
        // 這一行獲取 [樣式文件]和[控件屬性] 里面定義的 <declare-styleable name="CustomView"> 標(biāo)簽中的屬性集合
        TypedArray a = context.obtainStyledAttributes(attrs, R.styleable.CustomView, R.attr.CustomStyle, 0);
        // 讀取資源文件類型的屬性
        resource = a.getResourceId(R.styleable.CustomView_CustomResource, 0);
        // 讀取color類型的屬性(#333333)
        color = a.getColor(R.styleable.CustomView_CustomColor, res.getColor(R.color.colorPrimary));
        // 讀取文字顏色屬性(#333333或者selector類型的drawable資源)
        textColor = a.getColorStateList(R.styleable.CustomView_CustomTextColor);
        // 讀取背景(#333333或者drawable類型資源)注意與文字顏色的區(qū)別
        drawable = a.getDrawable(R.styleable.CustomView_CustomBackground);
        // 讀取int類型屬性
        height = a.getInteger(R.styleable.CustomView_CustomHeight, 0);
        // 讀取dp類型的屬性,讀出來的值已經(jīng)轉(zhuǎn)換為px
        width = a.getDimensionPixelSize(R.styleable.CustomView_CustomWidth, 0);
        // 讀取字符串類型的屬性
        text = a.getString(R.styleable.CustomView_CustomString);
        // 讀取枚舉類型的屬性
        enumValue = a.getInt(R.styleable.CustomView_CustomEnum, 0);

    }

3. .將讀取的屬性值應(yīng)用到自定義控件
   略

如何使用樣式style屬性給自定義控件設(shè)置樣式

很多時候我們在項目開發(fā)中都是使用樣式文件對控件進(jìn)行統(tǒng)一的樣式控制,那自定義控件如何使用自定義樣式呢?
1. 定義自定義控件樣式名稱
2. 在style.xml中定義樣式
3. 在主題中設(shè)置自定義控件樣式
4. 在控件布局中設(shè)置自定義控件樣式

1. 定義樣式名稱

使用自定義樣式時候需要先定義樣式名稱定義方式如下,這里的名稱可以隨意定義,當(dāng)然為了容易識別最好是以控件名稱開頭.
<attr format="reference" name="CustomStyle"/>

2. 定義樣式

在style.xml中定義樣式

<style name="myStyleOne">
        <item name="CustomColor">#3333</item>
        <item name="CustomHeight">34</item>
    </style>

3. 使用樣式

樣式的使用可以通過設(shè)置Activity的主題統(tǒng)一設(shè)置也可以通過對單個控件使用style標(biāo)簽設(shè)置.

<!--通過主題設(shè)置樣式-->
 <style name="AppTheme" parent="Theme.AppCompat.Light.DarkActionBar">
    <item name="CustomStyle">@style/myStyleOne</item>
</style>

<!--通過自定義控件設(shè)置樣式-->
<com.example.customattributes.CustomView
      android:layout_width="300dp"
      android:layout_height="300dp"
      app:CustomColor="#ff0000"
      app:CustomString="我的文字"
      app:CustomTextColor="@drawable/text_color"
      app:CustomWidth="23dp"
      app:CustomBackground="@color/colorAccent"
      style="@style/myStyleOne"
      />

最后我們再次回到前面提到的方法

public final TypedArray obtainStyledAttributes(
            AttributeSet set, @StyleableRes int[] attrs, @AttrRes int defStyleAttr,
            @StyleRes int defStyleRes) {
        return getTheme().obtainStyledAttributes(
            set, attrs, defStyleAttr, defStyleRes);
    }

    // 讀取int類型屬性
    height = a.getInteger(R.styleable.CustomView_CustomHeight, 0);
    Log.e("CustomView", "高度" + height);

再來看看第三個參數(shù)的取值,對自定義控件屬性值的影響.
取值為0,通過主題設(shè)置樣式,控制臺輸出 E/CustomView: 高度0
取值為0,通過標(biāo)簽中的style設(shè)置樣式,控制臺輸出 E/CustomView: 高度34
取值為R.attr.CustomStyle,通過主題設(shè)置樣式,控制臺輸出 E/CustomView: 高度34
取值為R.attr.CustomStyle,通過標(biāo)簽中的style設(shè)置樣式(設(shè)置為另一個樣式值),控制臺輸出 E/CustomView: 高度66,可以看出第三個參數(shù)的作用是將指定的樣式應(yīng)用到自定義控件.

下面用一個表格來總結(jié)一下obtainStyledAttributes方法第三個參數(shù)和樣式設(shè)置之間的關(guān)系.

最后附上GitHub地址,歡迎fork star

Demos
自定義屬性