服务器之家

服务器之家 > 正文

理解Android中的自定义属性

时间:2021-05-21 13:19     来源/作者:鸿洋_

本文实例讲解了Android中的自定义属性,具体内容如下

1、引言

对于自定义属性,大家肯定都不陌生,遵循以下几步,就可以实现:

  • 自定义一个CustomView(extends View )类
  • 编写values/attrs.xml,在其中编写styleable和item等标签元素
  • 在布局文件中CustomView使用自定义的属性(注意namespace)
  • 在CustomView的构造方法中通过TypedArray获取

ps:如果你对上述几个步骤不熟悉,建议先熟悉下,再继续~
那么,我有几个问题:

  • 以上步骤是如何奏效的?
  • styleable 的含义是什么?可以不写嘛?我自定义属性,我声明属性就好了,为什么一定要写个styleable呢?
  • 如果系统中已经有了语义比较明确的属性,我可以直接使用嘛?
  • 构造方法中的有个参数叫做AttributeSet
    (eg: MyTextView(Context context, AttributeSet attrs) )这个参数看名字就知道包含的是参数的数组,那么我能不能通过它去获取我的自定义属性呢?
  • TypedArray是什么鬼?从哪冒出来的,就要我去使用?

恩,针对这几个问题,大家可以考虑下,如何回答呢?还是说:老子会背上述4个步骤就够了~~

2、常见的例子

接下来通过例子来回答上述问题,问题的回答顺序不定~~大家先看一个常见的例子,即上述几个步骤的代码化。

自定义属性的声明文件

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

自定义View类

?
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
package com.example.test;
 
import android.content.Context;
import android.content.res.TypedArray;
import android.util.AttributeSet;
import android.util.Log;
import android.view.View;
 
public class MyTextView extends View {
 
  private static final String TAG = MyTextView.class.getSimpleName();
 
  public MyTextView(Context context, AttributeSet attrs) {
    super(context, attrs);
 
    TypedArray ta = context.obtainStyledAttributes(attrs, R.styleable.test);
 
    String text = ta.getString(R.styleable.test_testAttr);
    int textAttr = ta.getInteger(R.styleable.test_text, -1);
 
    Log.e(TAG, "text = " + text + " , textAttr = " + textAttr);
 
    ta.recycle();
  }
 
}

布局文件中使用

?
1
2
3
4
5
6
7
8
9
10
11
12
13
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
  xmlns:tools="http://schemas.android.com/tools"
  xmlns:zhy="http://schemas.android.com/apk/res/com.example.test"
  android:layout_width="match_parent"
  android:layout_height="match_parent" >
 
  <com.example.test.MyTextView
    android:layout_width="100dp"
    android:layout_height="200dp"
    zhy:testAttr="520"
    zhy:text="helloworld" />
 
</RelativeLayout>

ok,大家花3s扫一下,运行结果为:

?
1
MyTextView: text = helloworld , textAttr = 520

应该都不意外吧,注意下,我的styleable的name写的是test,所以说这里并不要求一定是自定义View的名字。

3、AttributeSet与TypedArray

下面考虑:

构造方法中的有个参数叫做AttributeSet(eg: MyTextView(Context context, AttributeSet attrs) )这个参数看名字就知道包含的是参数的集合,那么我能不能通过它去获取我的自定义属性呢?
首先AttributeSet中的确保存的是该View声明的所有的属性,并且外面的确可以通过它去获取(自定义的)属性,怎么做呢?
其实看下AttributeSet的方法就明白了,下面看代码。

?
1
2
3
4
5
6
7
8
9
10
11
12
13
public MyTextView(Context context, AttributeSet attrs) {
    super(context, attrs);
 
    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);
    }
 
    // ==>use typedarray ...
 
  }

输出:

?
1
2
3
4
MyTextView(4136): attrName = layout_width , attrVal = 100.0dip
MyTextView(4136): attrName = layout_height , attrVal = 200.0dip
MyTextView(4136): attrName = text , attrVal = helloworld
MyTextView(4136): attrName = testAttr , attrVal = 520

结合上面的布局文件,你发现了什么?
我擦,果然很神奇,真的获得所有的属性,恩,没错,通过AttributeSet可以获得布局文件中定义的所有属性的key和value(还有一些方法,自己去尝试),那么是不是说TypedArray这个鬼可以抛弃了呢?答案是:NO!。

现在关注下一个问题:

TypedArray是什么鬼?从哪冒出来的,就要我去使用?
我们简单修改下,布局文件中的MyTextView的属性。

?
1
2
3
4
5
<com.example.test.MyTextView
    android:layout_width="@dimen/dp100"
    android:layout_height="@dimen/dp200"
    zhy:testAttr="520"
    zhy:text="@string/hello_world" />

现在再次运行的结果是:

?
1
2
3
4
5
6
MyTextView(4692): attrName = layout_width , attrVal = @2131165234
MyTextView(4692): attrName = layout_height , attrVal = @2131165235
MyTextView(4692): attrName = text , attrVal = @2131361809
MyTextView(4692): attrName = testAttr , attrVal = 520
>>use typedarray
MyTextView(4692): text = Hello world! , textAttr = 520

发现了什么?通过AttributeSet获取的值,如果是引用都变成了@+数字的字符串。你说,这玩意你能看懂么?那么你看看最后一行使用TypedArray获取的值,是不是瞬间明白了什么。

TypedArray其实是用来简化我们的工作的,比如上例,如果布局中的属性的值是引用类型(比如:@dimen/dp100),如果使用AttributeSet去获得最终的像素值,那么需要第一步拿到id,第二步再去解析id。而TypedArray正是帮我们简化了这个过程。

贴一下:如果通过AttributeSet获取最终的像素值的过程:

?
1
2
int widthDimensionId = attrs.getAttributeResourceValue(0, -1);
    Log.e(TAG, "layout_width= "+getResources().getDimension(widthDimensionId));

ok,现在别人问你TypedArray存在的意义,你就可以告诉他了。

4、declare-styleable

我们已经解决了两个问题,接下来,我们看看布局文件,我们有一个属性叫做:zhy:text。
总所周知,系统提供了一个属性叫做:android:text,那么我觉得直接使用android:text更nice,这样的话,考虑问题:

如果系统中已经有了语义比较明确的属性,我可以直接使用嘛?
答案是可以的,怎么做呢?
直接在attrs.xml中使用android:text属性。

?
1
2
3
4
<declare-styleable name="test">
    <attr name="android:text" />
    <attr name="testAttr" format="integer" />
  </declare-styleable>

注意,这里我们是使用已经定义好的属性,不需要去添加format属性(注意声明和使用的区别,差别就是有没有format)。
然后在类中这么获取:ta.getString(R.styleable.test_android_text);布局文件中直接android:text="@string/hello_world"即可。

这里提一下,系统中定义的属性,其实和我们自定义属性的方式类似,你可以在sdk/platforms/android-xx/data/res/values该目录下看到系统中定义的属性。然后你可以在系统提供的View(eg:TextView)的构造方法中发现TypedArray获取属性的代码(自己去看一下)。

ok,接下来,我在想,既然declare-styleable这个标签的name都能随便写,这么随意的话,那么考虑问题:

styleable 的含义是什么?可以不写嘛?我自定义属性,我声明属性就好了,为什么一定要写个styleable呢?
其实的确是可以不写的,怎么做呢?

首先删除declare-styleable的标签
那么现在的attrs.xml为:

?
1
2
3
4
<?xml version="1.0" encoding="utf-8"?>
<resources>
  <attr name="testAttr" format="integer" />
</resources>

* MyTextView实现

?
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
30
31
package com.example.test;
 
import android.content.Context;
import android.content.res.TypedArray;
import android.util.AttributeSet;
import android.util.Log;
import android.view.View;
 
public class MyTextView extends View {
 
  private static final String TAG = MyTextView.class.getSimpleName();
 
  private static final int[] mAttr = { android.R.attr.text, R.attr.testAttr };
  private static final int ATTR_ANDROID_TEXT = 0;
  private static final int ATTR_TESTATTR = 1;
 
  public MyTextView(Context context, AttributeSet attrs) {
    super(context, attrs);
 
    // ==>use typedarray
    TypedArray ta = context.obtainStyledAttributes(attrs, mAttr);
 
    String text = ta.getString(ATTR_ANDROID_TEXT);
    int textAttr = ta.getInteger(ATTR_TESTATTR, -1);
    //输出 text = Hello world! , textAttr = 520
    Log.e(TAG, "text = " + text + " , textAttr = " + textAttr);
 
    ta.recycle();
  }
 
}

貌似多了些代码,可以看到我们声明了一个int数组,数组中的元素就是我们想要获取的attr的id。并且我们根据元素的在数组中的位置,定义了一些整形的常量代表其下标,然后通过TypedArray进行获取。
可以看到,我们原本的:

?
1
2
3
R.styleable.test => mAttr
R.styleable.test_text => ATTR_ANDROID_TEXT(0)
R.styleable.test_testAttr => ATTR_TESTATTR(1)

那么其实呢?android在其内部也会这么做,按照传统的写法,它会在R.java生成如下代码:

?
1
2
3
4
5
6
7
8
9
10
public static final class attr {
  public static final int testAttr=0x7f0100a9;
  }
public static final class styleable {
   public static final int test_android_text = 0;
   public static final int test_testAttr = 1;
   public static final int[] test = {
      0x0101014f, 0x7f0100a9
    };
  }

ok,根据上述你应该发现了什么。styleale的出现系统可以为我们完成很多常量(int[]数组,下标常量)等的编写,简化我们的开发工作(想想如果一堆属性,自己编写常量,你得写成什么样的代码)。那么大家肯定还知道declare-styleable的name属性,一般情况下写的都是我们自定义View的类名。主要为了直观的表达,该declare-styleable的属性,都是改View所用的。

其实了解该原理是有用的,详见:Android 自定义控件 优雅实现元素间的分割线

ok,现在5个问题,回答了4个,第一个问题:

自定义属性的几个步骤是如何奏效的?
恩,上述以及基本涵盖了这个问题的答案,大家自己总结,所以:略。

总结:

  • attrs.xml里面的declare-styleable以及item,android会根据其在R.java中生成一些常量方便我们使用(aapt干的),本质上,我们可以不声明declare-styleable仅仅声明所需的属性即可。
  • 我们在View的构造方法中,可以通过AttributeSet去获得自定义属性的值,但是比较麻烦,而TypedArray可以很方便的便于我们去获取。
  • 我们在自定义View的时候,可以使用系统已经定义的属性。

以上就是关于Android中的自定义属性的相关内容,希望对大家的学习有所帮助。

相关文章

热门资讯

2020微信伤感网名听哭了 让对方看到心疼的伤感网名大全
2020微信伤感网名听哭了 让对方看到心疼的伤感网名大全 2019-12-26
yue是什么意思 网络流行语yue了是什么梗
yue是什么意思 网络流行语yue了是什么梗 2020-10-11
背刺什么意思 网络词语背刺是什么梗
背刺什么意思 网络词语背刺是什么梗 2020-05-22
苹果12mini价格表官网报价 iPhone12mini全版本价格汇总
苹果12mini价格表官网报价 iPhone12mini全版本价格汇总 2020-11-13
2021德云社封箱演出完整版 2021年德云社封箱演出在线看
2021德云社封箱演出完整版 2021年德云社封箱演出在线看 2021-03-15
返回顶部