Android-深入理解android自定义属性(AttributeSet,TypedArray)

Posted 2020-08-16 夜行过客

 

属性

自定义属性，首先要定义出来属性，我们新建一个attrs.xml：

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <attr name="textSize0" format="dimension" />
    <declare-styleable name="button1">
        <attr name="textSize1" format="dimension" />
        <attr name="textSize2" format="dimension" />
    </declare-styleable>
    <declare-styleable name="button2">
        <attr name="textSize3" format="dimension" />
        <attr name="textSize4" format="dimension" />
    </declare-styleable>
</resources>

然后我们要看到产生什么效果：

在R.java文件里

public final class R {
    public static final class attr {
        public static final int textSize0=0x7f010000;
        public static final int textSize1=0x7f010001;
        public static final int textSize2=0x7f010002;
        public static final int textSize3=0x7f010003;
        public static final int textSize4=0x7f010004;
    }
    public static final class styleable {
        public static final int[] button1 = {
            0x7f010001, 0x7f010002
        };
        public static final int button1_textSize1 = 0;
        public static final int button1_textSize2 = 1;
        public static final int[] button2 = {
            0x7f010003, 0x7f010004
        };
        public static final int button2_textSize3 = 0;
        public static final int button2_textSize4 = 1;
    };
}

我在这里把不相关的内容去掉了，在这里我们可以看到通过修改attrs.xml，R文件的改变是多了两个类，分别是attr类和styleable类，这里我们要注意的是区分出来这两个类，他们是不同的，后面获得TypedArray的时候他们的区别就会很明显。在我理解，attr就是属性呗，就想定义一个变量似的定义一个属性。styleable就是样式，就是属性的集合，在R文件里体现的很明显，button1就是样式，它包含两个属性的地址，就是0x7f010001和0x7f010002。还有一个值得注意的地方时button1_textSize1这个属性，它的作用就是下标。后面我们在TypedArray里取值的时候会用到。

AttributeSet

api的解释：

A collection of attributes, as found associated with a tag in an XML document. Often you will not want to use this interface directly, instead passing it to Resources.Theme.obtainStyledAttributes() which will take care of parsing the attributes for you. In particular, the Resources API will convert resource references (attribute values such as "@string/my_label" in the original XML) to the desired type for you; if you use AttributeSet directly then you will need to manually check for resource references (with getAttributeResourceValue(int, int)) and do the resource lookup yourself if needed. Direct use of AttributeSet also prevents the application of themes and styles when retrieving attribute values. 

这里只是粘了一部分过来，可以自己查看，反正AttributeSet这个类就是代表xml里一个节点下面的属性的集合，这个类一般都是系统在生成有xml配置的组件时生成，我们一般不去生成该对象。我们可以通过该对象操作xml里对应的属性，但是官方不建议这么使用，最直接的原因上面英文里有提到，就是它只是xml里属性的一个集合，没有做其他的处理，比如一个样式，这个类只是知道这个样式不能直接拿到样式里面的属性，其他原因不详，举个例子：在XML文件中定义View如下：

<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    >
    
    <com.yongdaimi.costomview.CustomTextView
        android:text="China"
        android:clickable="false"
        style="@style/text_style"
        android:textColor="@android:color/black"
        />
    

</RelativeLayout>

然后在java代码解析当前所定义的属性值。比如：style属性。

package com.yongdaimi.costomview;

import android.content.Context;
import android.util.AttributeSet;
import android.util.Log;
import android.widget.TextView;

public class CustomTextView extends TextView {

    public CustomTextView(Context context) {
        this(context,null);
    }
    
    public CustomTextView(Context context, AttributeSet attrs) {
        this(context,attrs,0);
    }
    
    public CustomTextView(Context context, AttributeSet attrs, int defStyleAttr) {
        super(context, attrs, defStyleAttr);
        
        
        int attributeCount = attrs.getAttributeCount();
        Log.i("test123", "当前属性个数为："+attributeCount);
        
        
        
        for (int i = 0; i < attributeCount; i++) {
            String attributeName = attrs.getAttributeName(i);
            Log.i("test123",String.format("当前属性索引为：%d,索引名为：%s", i,attributeName));
            if (attributeName.equals("style")) {
                String attributeValue = attrs.getAttributeValue(i);
                Log.i("test123", "当前属性值为：："+attributeValue);
                
                
            }
            
        }
    }
    
}

程序打印如下：

可以看到，通过此种形式，无法彻底读取出当前属性的值。

TypedArray

我认为这个类是学习自定义属性最重要的，首先来看它是什么：

Container for an array of values that were retrieved with Resources.Theme.obtainStyledAttributes(AttributeSet, int[], int, int) or Resources.obtainAttributes. Be sure to call recycle when done with them. The indices used to retrieve values from this structure correspond to the positions of the attributes given to obtainStyledAttributes.

它就是属性的集合，我们获取属性一般就是这个类的.getxxx()方法。

 重点是学习这个类的实例是怎么来的？一般是由context.obtainStyledAttributes这个方法，有4个重载的方法。

我们来看

TypedArray android.content.Context.obtainStyledAttributes(AttributeSet set, int[] attrs, int defStyleAttr, int defStyleRes)

下面分别说一下四个参数的意思：

set: XML文件中定义的View的属性的集合。举例：假设你在XML文件中定义了一个TextView并给其指定了6个属性，那么这个set里面就有6个属性。这个东西在自定义View的构造方法里面，由操作系统返回的。

attrs: 这个View自身的属性集合，是一个int数组。举例：假设你需要自定义View,并需要设置其属性，那么就需要在attrs.xml文件为其指定一个styleable。同样，在R文件中就会自动生成一个int[]数组，int[]数组中包含的就是styleable里面指定的属性。

defStyleAttr: 这是当前Theme中的一个attribute,是指向style的一个引用。如果在layout.xml和style中都没有为View指定属性时，会从Theme中这个attribute指向的style查找相应的属性值

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 参考链接：

1.菜鸟进阶之深入理解android自定义属性（AttributeSet，TypedArray）

2.Android中自定义样式与View的构造函数中的第三个参数defStyle的意义