Android自定义属性解析

一般情况下，我们自定义一个View的时候往往会重载它的三个构造函数，如下：

public class CustomView extends View {

    public CustomView(Context context) {
        this(context, null);
    }

    public CustomView(Context context, AttributeSet attrs) {
        this(context, attrs, 0);
    }

    public CustomView(Context context, AttributeSet attrs, int defStyleAttr) {
        super(context, attrs, defStyleAttr);
    }

}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15

另外，我们定义一个属性文件attrs.xml

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <declare-styleable name="CustomView">
        <attr name="text" format="string" />
        <attr name="num" format="integer"/>
    </declare-styleable>
</resources>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7

下面针对这三个构造函数，我们来一一讲解： 
1、public CustomView(Context context)

这个构造函数一般在代码中来定义这个CustomView对象的时候会被调用，例如：

CustomView customView = new CustomView(context);
  • 1
  • 1

2、public CustomView(Context context, AttributeSet attrs)

这个构造函数一般是在布局文件中使用这个CustomView的时候会被调用，AttributeSet对应的就是设置的属性值集合，例如：

<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <com.xxx.cn.customattr.CustomView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        app:text="Mirhunana"
        app:num="20"/>

</RelativeLayout>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12

3、public CustomView(Context context, AttributeSet attrs, int defStyleAttr)

这个构造函数一般是被第一个或者第二个构造函数来调用，它的作用是当没有为自定义的属性赋值的时候，就可以使用defStyleAttr里面定义的默认属性值。

下面先来说说构造函数里面的两个参数： 
1、AttributeSet attrs 
这个参数里面存放的就是上面布局文件中CustomView所定义的属性。例如：Android:layout_width、android:layout_height、app:text、app:num。

所以在布局文件中使用CustomView的时候，会调用第二个构造函数，并且将CustomView里面所赋值的属性封装在AttributeSet里面传递给第二个构造函数。

2、int defStyleAttr 
我们自定义的CustomView的属性值也可以在Theme中进行指定，我们知道，我们在AndroidManifest文件中会为整个应用设置一个主题，在这个主题里面就可以为自定义的View定义默认的属性值，如下图： 
这里写图片描述

我们以CheckBox为例：

public CheckBox(Context context,) {
    this(context, null);
}

public CheckBox(Context context, AttributeSet attrs) {
    this(context, attrs, com.android.internal.R.attr.checkboxStyle);
}

public CheckBox(Context context, AttributeSet attrs, int defStyle) {
    super(context, attrs, defStyle);
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11

从上面可以看到它调用三个参数的构造函数的时候，传递了一个com.android.internal.R.attr.checkboxStyle值。

在frameworks/base/core/res/res/values/themes.xml文件中指定了它的值，这个值就是在Theme中设置的：

<item name="checkboxStyle">@android:style/Widget.CompoundButton.CheckBox</item>
  • 1
  • 1

在frameworks/base/core/res/res/values/styles.xml文件里面有它的具体值：

<style name="Widget.CompoundButton.CheckBox">
    <item name="android:button">?android:attr/listChoiceIndicatorMultiple</item>
</style>
  • 1
  • 2
  • 3
  • 1
  • 2
  • 3

一般情况下，我们的操作会在第三个构造函数中处理，第一个构造函数会调用第二个构造函数，第二个构造函数会调用第三个构造函数，具体如上面代码所示，那么第三个构造函数中AttributeSet和defStyle都有自定义属性的赋值怎么办？这个也不难，既然defStyle里面对应的是默认的属性值，就相当于如果我们在布局文件为自定义属性赋值了，那么AttributeSet不为空，肯定就是使用给定的属性值，如果AttributeSet为空的话，就使用默认属性，它们之间有一定的先后顺序。

另外，在构造函数中，其实还有第四个构造函数：

public CustomView(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes) {
    super(context, attrs, defStyleAttr, defStyleRes);
}
  • 1
  • 2
  • 3
  • 1
  • 2
  • 3

这个构造函数里面又多了一个参数defStyleRes，它是一个样式，我们可以为它指定一个默认的样式文件。 
还是举例子：

<style name="default_style">
    <item name="text">Mirhunana/item>
    <item name="num">20</item>
</style>
  • 1
  • 2
  • 3
  • 4
  • 1
  • 2
  • 3
  • 4
public CustomView(Context context) {
    this(context, null);
}

public CustomView(Context context, AttributeSet attrs) {
    this(context, attrs, 0);
}

public CustomView(Context context, AttributeSet attrs, int defStyleAttr) {
    this(context, attrs, defStyleAttr, R.style.default_style);
}

public CustomView(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes) {
    super(context, attrs, defStyleAttr, defStyleRes);
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15

它们三个参数直接的优先级别为： 
attrs > defStyleAttr > defStyleRes

下面我们来验证一下AttributeSet是否如上面所说，存放的是布局文件里面CustomView的属性值。

package com.xxx.cn.customattr;

import android.content.Context;
import android.util.AttributeSet;
import android.util.Log;
import android.view.View;

public class CustomView extends View {
    private static final String TAG = "CustomView";

    public CustomView(Context context) {
        this(context, null);
    }

    public CustomView(Context context, AttributeSet attrs) {
        this(context, attrs, 0);
    }

    public CustomView(Context context, AttributeSet attrs, int defStyleAttr) {
        super(context, attrs, defStyleAttr);
        int count = attrs.getAttributeCount();
        for (int i = 0; i < count; i++) {
            String attrName = attrs.getAttributeName(i);
            String attrVal = attrs.getAttributeValue(i);
            Log.e(TAG, "attrName = " + attrName + " , attrVal = " + attrVal);
        }
    }

}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29

运行结果如下： 
这里写图片描述

但是通常情况下，我们使用TypedArray来获取里面的属性值，原因是因为TypedArray其实是用来简化我们的工作的，比如，如果布局中的属性的值是引用类型（比如：@dimen/dp100），如果使用AttributeSet去获得最终的像素值，那么需要第一步拿到id，第二步再去解析id。而TypedArray正是帮我们简化了这个过程。

下面我们来看看怎样使用TypedArray，还是举个例子，看看CustomView的构造函数。

public CustomView(Context context, AttributeSet attrs, int defStyleAttr) {
    super(context, attrs, defStyleAttr);
    TypedArray a = context.obtainStyledAttributes(attrs, R.styleable.CustomView, defStyleAttr, 0);
    String text = a.getString(R.styleable.CustomView_text);
    int num = a.getInt(R.styleable.CustomView_num, 0);
    Log.e(TAG, "text = " + text +", num = " + num);
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7

它使用了obtainStyledAttributes函数来进行处理。

下面来看看现在来看看这个函数的声明吧：

  1. obtainAttributes(AttributeSet set, int[] attrs)
  2. obtainStyledAttributes(int[] attrs)
  3. obtainStyledAttributes(int resId,int[] attrs)
  4. obtainStyledAttributes (AttributeSet set, int[] attrs, int defStyleAttr, int defStyleRes)

这四个声明跟上面的四个构造函数是一一对应的，里面的参数也是基本对应的，唯一不同的就是它里面多了一个int[] attrs，它是自定义属性数组。 
下面来分别对这几个函数进行一下说明： 
1、obtainAttributes(AttributeSet set, int[] attrs) 
AttributeSet就是局文件中得到的CustomView的属性集合，attrs是自定义的属性数组，因为AttributeSet得到的是CustomView里面所有设置过的属性，例如上面布局文件中android:layout_width、android:layout_height、app:text、app:num，通过attrs这个自定义的属性数组，我们就可以从所有设置的属性中筛选出我们自定义的属性值。 
总结一句就是：从layout设置的属性集中获取attrs中的属性

2、obtainStyledAttributes(int[] attrs) 
从系统主题中获取attrs中的属性

3、obtainStyledAttributes(int resId,int[] attrs) 
从资源文件定义的style中读取attrs中的属性

4、obtainStyledAttributes (AttributeSet set, int[] attrs, int defStyleAttr, int defStyleRes) 
按照上面的优先级来获取来获取attrs中的属性值

从上面的CustomView的构造函数中，我们可以看到int[] attrs数组为R.styleable.CustomView。

下面我们来看看项目中的R文件，把有用的内容整理如下：

public final class R {

    public static final class styleable {
        public static final int[] CustomView = {
            0x7f010025, 0x7f010026
        };

        public static final int CustomView_text = 0;

        public static final int CustomView_num = 1;
    }

    public static final class attr {
        public static final int text=0x7f010025;

        public static final int num=0x7f010026;
    }
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18

从这里我们可以看到系统帮我们做的一系列工作。

<declare-styleable name="CustomView">
    <attr name="text" format="string" />
    <attr name="num" format="integer"/>
</declare-styleable>
  • 1
  • 2
  • 3
  • 4
  • 1
  • 2
  • 3
  • 4

现在我们就知道上面使用declare-styleable的原因就是因为它把不同类别的属性进行分组，其实没有其他作用，每一个declare-styleable对应一个数组，数组里面存放的就是对应的属性id，在获取对应属性值的时候是根据属性的索引来得到的，所以上面的CustomView_text、CustomView_num对应的就是索引值。

参考文章： 
深入理解Android 自定义attr Style styleable以及其应用

Android 深入理解Android中的自定义属性

posted @ 2016-11-27 23:11  天涯海角路  阅读(118)  评论(0)    收藏  举报