写在前面:
之前这篇文章发表在我的CSDN博客中, 由于CSDN博客使用过于繁琐 ,趁着这段时间没啥事情可做(又要开始找新东家了), 将原有的文章整理后发布到简书. 原来CSDN博客也将停止更新. 有写得不对, 或者有更好的解决方案, 欢迎大家指出.

关于Android自定义属性网上已经有很多大神都已经详细的讲解过了. 关于如何使用自定义属性大家可以参考鸿洋_大神的这篇 Android 深入理解Android中的自定义属性 , 在此小弟再补充一些在自定义属性时候应该注意的一些细节.

1. 如何定义可被多个自定义控件使用的属性
2. 如何使用Android已经定义好的属性
3. 各种类型的属性如何定义(文字样式 , 背景)等
4. 如何读取各种类型的自定义属性
5. 如何使用样式style属性给自定义控件设置样式

1. 如何定义可被多个自定义控件使用的属性

在编写自定义控件的时候,经常会遇到两个或多个自定义控件使用同一个属性名的情况,假设有两个自定义控件A 和 B ,各自都有属性attr1.那么我们在定义A控件的时候可以像下面这样定义attr1属性.

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

接下来我们要在另外一个自定义控件B中使用名称为"attr1"的自定义属性,那么我们理所当然的也会像上面这样定义这个属性,那么编译器会抛错,错误日志如下:

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

那么我们如何定义一个能被多个自定义控件使用的属性呢?

我们知道在java类中定义一个被多个实例方法共享的变量---将变量定义在方法体外面,因此我们在自定义属性时也可以使用同样的方法将属性定义在<declare-styleable></declare-styleable>标签之外,这样自定义属性就可以被多个自定义控件使用了,代码如下:

<!-- 将公用的属性定义在<declare-styleable></declare-styleable>标签之外,即可被多个自定义控件使用 -->
<attr name="attr1" format="string"/>

2. 如何使用Android已经定义好的属性

Android系统已经为我们定义好了很多属性名称,所有以命名空间android:(xmlns:android="http://schemas.android.com/apk/res/android")开头的属性都是Android已经定义好的属性, 在使用的时候只需要直接使用即可, 但是应该注意的是, 如果这个属性在被继承类中已经使用过那么建议不要使用, 如TextView 的android:text属性就是已经被使用的属性, 所以在自定义控件时候如果继承自TextView 那么这个属性就不应该被使用.

<declare-styleable name="CustomView">
        <!--我们可以按下面三行这样来为自定义控件添加,系统已经声明过的属性-->
        <attr name="android:divider"/>
        <attr name="android:dividerPadding"/>
        <attr name="android:showDividers"/>
</declare-styleable>

各种类型的属性如何定义

Android中的属性是如何定义的, 在使用自定义属性的时候我们应该了解Android是如何自定义属性的.

• 简单类型的属性: 像string,integer等类型的属性,我们可以使用<attr format="string" name="属性名"/> 来定义 .
• 复合类型的属性: 像textColor,background 这样的复杂属性 既可以使用 #FF333333 又可以使用 @drawable/text_color 类型的值. #FF333333 属于 color 类型 而 @drawable/text_color 属于 reference 类型 ,这样的属性又改如何定义, 这就需要定义复合类型的属性, 因此我们可以通过 color| reference 来定义如: <attr format="color|reference" name="属性名" />.

下面是各种类型属性定义说明.

4.如何读取各种类型的自定义属性

一般步骤: 
1. 第一步获取自定义控件属性值的集合(TypedArray)
2. 第二步从获取的集合中取出每个属性值
3. 第三步将读取的属性值应用到自定义控件

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);
    }

第二个参数: 这是一个数组,指定我们需要获取哪些属性.
第三个参数: 指定一个样式,这里我们指定的是attr.xml定义的样式属性
第四个参数: 指定一个默认的样式文件.

2). 从获取的集合中取出每个属性值
自定义属性有 string,integer,color,reference等简单类型, 也有 color|reference 等这种复合类型.复合属性的读取需要区别对待. 如对于字体和背景同样是 color|reference 类型,但是他们的读取方法也有区别 , 如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"> 标签中的属性集合
        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类型资源)注意与文字颜色的区别
        drawable = a.getDrawable(R.styleable.CustomView_CustomBackground);
        // 读取int类型属性
        height = a.getInteger(R.styleable.CustomView_CustomHeight, 0);
        // 读取dp类型的属性,读出来的值已经转换为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. .将读取的属性值应用到自定义控件
   略

如何使用样式style属性给自定义控件设置样式

很多时候我们在项目开发中都是使用样式文件对控件进行统一的样式控制,那自定义控件如何使用自定义样式呢?
1. 定义自定义控件样式名称
2. 在style.xml中定义样式
3. 在主题中设置自定义控件样式
4. 在控件布局中设置自定义控件样式

1. 定义样式名称

使用自定义样式时候需要先定义样式名称定义方式如下,这里的名称可以随意定义,当然为了容易识别最好是以控件名称开头.
<attr format="reference" name="CustomStyle"/>

2. 定义样式

在style.xml中定义样式

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

3. 使用样式

样式的使用可以通过设置Activity的主题统一设置也可以通过对单个控件使用style标签设置.

<!--通过主题设置样式-->
 <style name="AppTheme" parent="Theme.AppCompat.Light.DarkActionBar">
    <item name="CustomStyle">@style/myStyleOne</item>
</style>

<!--通过自定义控件设置样式-->
<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);

再来看看第三个参数的取值,对自定义控件属性值的影响.
取值为0,通过主题设置样式,控制台输出 E/CustomView: 高度0
取值为0,通过标签中的style设置样式,控制台输出 E/CustomView: 高度34
取值为R.attr.CustomStyle,通过主题设置样式,控制台输出 E/CustomView: 高度34
取值为R.attr.CustomStyle,通过标签中的style设置样式(设置为另一个样式值),控制台输出 E/CustomView: 高度66,可以看出第三个参数的作用是将指定的样式应用到自定义控件.

下面用一个表格来总结一下obtainStyledAttributes方法第三个参数和样式设置之间的关系.

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

Demos
自定义属性