Android | 自定义属性

作者: 彭旭锐 | 来源:发表于2019-08-01 22:26 被阅读126次

前言

自定义View经常需要用到自定义属性
属性根据使用方式不同，也可以分为控件属性、主题属性、Manifest属性
很多文章讲自定义属性只提到控件属性
本文将总结自定义属性相关知识细节，希望能帮上忙

自定义属性思维导图

属性分类示意图

Manifest属性是可以在AndroidManifest.xml中使用的属性，定义在原生框架中（比如Android Pattrs_manifests.xml）。本文的重点是其他两种属性：控件属性与主题属性

在正文开始之前，先来看看几个小题目，这些问题你都能解释清楚吗？

下面两种键值对的区别是什么？
- <item name="colorAccent">@color/colorAccent</item>
- <item name="android:colorAccent">@color/colorAccent</item>
下面四种属性的区别是什么？
- tools:background="@color/colorAccent"
- android:background="@color/colorAccent"
- app:background="@color/colorAccent"
- background="@color/colorAccent"

稍后会为大家一一解答，有任何疑问都可以在评论区留言讨论！

1. 定义

如何定义一个属性呢？定义属性需要用到：

<attr>标签
属性名与属性值类型

我们就以Android P原生框架提供的attrs.xml为例，里面定义了非常多的属性，我们选取一些熟知的属性如下：

<!-- 文本颜色 -->
<attr name="textColor" format="reference|color"/>
<!-- 高亮文本颜色 -->
<attr name="textColorHighlight" format="reference|color" />
<!-- 高亮文本颜色 -->
<attr name="textColorHint" format="reference|color" />

你也可以在SDK中找到这个文件，有两种方式：

文件夹：sdk/platform/android-28/data/res/values/attrs.xml

Android Studio（切换到project视图）：External Libraries/<Android API 28 Platform>/res/values/attrs.xml

提示：你在这里看到的版本号是在app/build.gradle中的compileSdkVersion设置的

这些都是我们再熟悉不过的属性了，比如我们用它们来定义EditText：

<EditText
        ...
        android:textColor="@android:color/white"
        android:textColorHighlight="@color/colorAccent"
        android:textColorHint="@android:color/darker_gray"/>

2. 命名空间

为什么我们定义属性的时候没有指明android:前缀，而引用属性的时候却需要呢？这就引出了属性命名空间的概念，有四种命名空间：

命名空间示意图

工具—tools：xmlns:tools="http://schemas.android.com/tools"

只在Android Studio中生效，运行时不生效，比如以下代码，背景色在编辑器的预览窗口显示白色，但是在运行时显示黑色：
```
tools:background="@android:color/white"
android:background="@android:color/black"
```
原生—android：xmlns:android="http://schemas.android.com/apk/res/android"

原生框架中attrs定义的属性，比如前文提到的Android P原生框架提供的attrs.xml：
```
<attr name="colorAccent" format="color" />
```
AppCompat兼容库——无命名空间

AppCompat兼容库中定义的属性，比如：
```
<attr format="color" name="colorAccent"/>
```
Android Studio（切换到project视图）：External Libraries/Gradle:com.android.support:appcompat-v7:[版本号]@aar/res/values/values.xml
自定义—app：xmlns:app="http://schemas.android.com/apk/res-auto"

除了原生框架和AppCompat兼容库之外定义的属性，包括项目中自定义的属性与依赖库中自定义的属性，比如ConstraintLayout中自定义的属性：
```
<attr format="reference|enum" name="layout_constraintBottom_toBottomOf">
      <enum name="parent" value="0"/>
</attr>
```
Android Studio（切换到project视图）：External Libraries/Gradle:com.android.support:constraint:constraint-layout:[版本号]@aar/res/values/values.xml

注意到了吗，无论是原生、AppCompat兼容库还是自定义的属性，定义的时候都不需要命名空间，只有在引用的时候需要，命名空间用于区分属性定义的位置，比如：

<resources>
    <style name="AppTheme" parent="Theme.AppCompat.NoActionBar">
            <!-- AppCompat兼容库定义的属性 -->
        <item name="colorAccent">@color/colorAccent</item>
        <!-- 原生框架定义的属性 -->
        <item name="android:colorAccent">@android:color/white</item>
    </style>
</resources>

上面两个键值对，一个将AppCompat兼容库的colorAccent属性的值设置为@color/colorAccent，另一个将原生框架的android:colorAccent属性的值设置为@android:color/white，命名空间帮助在区分具体指示的是哪个属性。

事实上，在使用兼容库的应用中，只有第一个键值对能产生有实际效果

3. 控件属性

控件属性是最常用的属性了，后面提到的样式属性也需要以控件属性为前提，控件属性有以下特点：

使用<declare-styleable>标签定义控件属性集合
可以在布局文件中使用
属性定义和属性引用可以在一步完成
（同一个包内）定义一次属性后，引用的时候不需要在指定属性值类型

我们以TextView的控件属性为例，定义在attrs.xml中：

// 定义
<attr name="textColor" format="reference|color"/>

// 引用
<declare-styleable name="TextView">
        // 同时定义和引用属性
        <attr name="text" format="string" localization="suggested" />
        <attr name="hint" format="string" />
        // 引用属性
        <attr name="textColor" />
        // ...
</declare-styleable>

属性定义和属性引用可以在一步完成，比如上面的text属性与hint属性

可以看到，name指明了对应的控件为TextView，因此我们可以在布局文件中将这些属性设置到TextView上：

<TextView
        ...
        android:textColor="@android:color/white"
        android:text="Hello World!"/>

那么问题来了，这些设置的属性值最终是怎么体现在视图上的呢？我们需要到TextView的源码中寻找答案：

public TextView(Context context, @Nullable AttributeSet attrs, int defStyleAttr, int defStyleRes) {
        super(context, attrs, defStyleAttr, defStyleRes);
        // ...
        final Resources.Theme theme = context.getTheme();
        TypedArray a = theme.obtainStyledAttributes(
                    attrs, com.android.internal.R.styleable.TextView, defStyleAttr, defStyleRes);
    for (int i = 0; i < n; i++) {
                int attr = a.getIndex(i);
                switch (attr) {      
                        // ...
                        // 读取到text属性的属性值
                        case com.android.internal.R.styleable.TextView_text:
                    textIsSetFromXml = true;
                    // 属性值是一个String类型的资源ID
                    mTextId = a.getResourceId(attr, ResourceId.ID_NULL);
                    // 从资源ID取得String
                    text = a.getText(attr);
                    break;
                        // ...
        }
    }
        // ...
}

总结一下，布局属性可以在布局文件中使用，代码中使用TypedArray读取属性值，最终作用在控件上。

控件属性示意图

4. 样式属性

样式属性是另外一种用途广泛的属性，与控件属性结合使用可以打造主题化应用，巩固项目UI的可维护性。样式属性具有以下特点：

使用<style>定义样式属性集合
在布局文件中使用不生效
可以被子样式覆盖

我们以AppCompat兼容库中定义的一个主题为例：

<attr format="color" name="colorAccent"/>

<style name="Base.V7.Theme.AppCompat" parent="Platform.AppCompat">
        // ...
        // 样式属性1
        <item name="colorAccent">@color/accent_material_dark</item>
        // ...
        // 样式属性2
        <item name="colorControlActivated">?attr/colorAccent</item>
        // ...
</style>

样式资源本质上就是属性—属性值的键值对集合
样式属性1：属性colorAccent—属性值@color/accent_material_dark
样式属性2：属性colorControlActivated，对应的属性值引用了colorAccent的属性值，这是通过了语法?attr/colorAccent，?表示在当前应用的主题中寻找属性，也就是引用主题下colorAccent属性的值

样式属性可以被子样式覆盖，比如：

<style name="AppTheme" parent="Theme.AppCompat.NoActionBar">
        <!-- Customize your theme here. -->
        <item name="colorPrimary">@color/colorPrimary</item>
        <item name="colorPrimaryDark">@color/colorPrimaryDark</item>
        <item name="colorAccent">@color/colorAccent</item>
</style>

可以看到，这是我们熟知的主题样式定制，我们修改了colorAccent属性的值，设置为自定义的@color/colorAccent，结果是所有引用了colorAccent属性的地方都被修改。

注意，样式属性在布局文件中是不生效的，比如以下布局并不会取得预期效果：

<TextView
        ...
        android:colorAccent="@android:color/white"/>

提示：一个属性可以同时被引用为控件属性和样式属性，比如textSize；也有的属性只是作为样式属性，比如colorAccent

样式属性示意图

5. 属性值类型

前文提到，定义属性需要指定：属性名与属性值类型，属性值类型可以分为资源类与特殊类

资源类

属性值类型	描述	TypedArray
fraction	百分数	getFraction(...)
float	浮点数	getFloat(...)
boolean	布尔值	getBoolean(...)
color	颜色值	getColor(...)
string	字符串	getString(...)
dimension	尺寸值	getDimensionPixelOffset(…) getDimensionPixelSize(...) getDimension(...)
integer	整数值	getInt(...) getInteger(...)

特殊类

属性值类型	描述	TypedArray
flag	标志位	getInt(...)
enum	枚举值	getInt(…)等
reference	资源引用	getDrawable(...)等

fraction举例

属性

<declare-styleable name="RotateDrawable">
        // ...
        <attr name="pivotX" format="float|fraction" />
        <attr name="pivotY" format="float|fraction" />
        <attr name="drawable" />
</declare-styleable>

设置

<?xml version="1.0" encoding="utf-8"?>
<animated-rotate xmlns:android="http://schemas.android.com/apk/res/android"
    android:pivotX="50%"
    android:pivotY="50%"
    android:drawable="@drawable/fifth">
</animated-rotate>

应用（RotateDrawable）
```
if (a.hasValue(R.styleable.RotateDrawable_pivotX)) {
        // 取出对应的TypedValue
        final TypedValue tv = a.peekValue(R.styleable.RotateDrawable_pivotX);
        // 判断属性值是float还是fraction
        state.mPivotXRel = tv.type == TypedValue.TYPE_FRACTION;
        // 取出最终的值
        state.mPivotX = state.mPivotXRel ? tv.getFraction(1.0f, 1.0f) : tv.getFloat();
}
```
pivotX支持float和fraction两种类型，因此需要通过TypedValue#type判断属性值的类型，分别调用TypedValue#getFraction()与TypedValue#getFloat()。

getFraction(float base,float pbase)的两个参数为基数，最终的返回值是基数*百分数。举个例子，当设置的属性值为50%时，返回值为base*50%；当设置的属性值为50%p时，返回值为pbase*50%。

6. 总结

命名空间

命名空间描述

android 原生框架

app AppCompat兼容库

无项目或依赖库

tools Android Studio
属性分类

属性描述

控件属性 <declare-styleable>

样式属性 <style>

Manifest属性 AndroidManifest

命名空间	描述
android	原生框架
app	AppCompat兼容库
无	项目或依赖库
tools	Android Studio

属性	描述
控件属性	<declare-styleable>
样式属性	<style>
Manifest属性	AndroidManifest

参考

Style resource — Developers
Styles and Themes — Developers
Creating a Custom View Class — Developers
Best Practices for Themes and Styles — Android Dev Summit '18
Android themes & styles demystified — Google I/O 2016
《Android 编程权威指南》[美]Bill Phillips, Chris Stewart, Kristin Marsicano 著

感谢喜欢！你的点赞是对我最大的鼓励！欢迎关注彭旭锐的简书！

网友评论

本文标题：Android | 自定义属性

本文链接：https://www.haomeiwen.com/subject/bgehdctx.html

延伸阅读

深度阅读

您也可以注册成为美文阅读网的作者，发表您的原创作品、分享您的心情！

Android | 自定义属性

前言

1. 定义

2. 命名空间

3. 控件属性

控件属性示意图

4. 样式属性

5. 属性值类型

6. 总结

推荐阅读

参考

感谢喜欢！你的点赞是对我最大的鼓励！欢迎关注彭旭锐的简书！

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

Android开发经验谈

Android技术知识

Android开发

程序员

Android控件

Android | 自定义属性

前言

1. 定义

2. 命名空间

3. 控件属性

控件属性 示意图

4. 样式属性

5. 属性值类型

6. 总结

推荐阅读

参考

感谢喜欢！你的点赞是对我最大的鼓励！欢迎关注彭旭锐的简书！

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

Android开发经验谈

Android技术知识

Android开发

程序员

Android控件

控件属性示意图