Tools属性

Android Studio 支持 tools 命名空间中的多种 XML 属性,这些属性支持设计时功能(例如要在 Fragment 中显示哪种布局)或编译时行为(例如要对 XML 资源应用哪种压缩模式)。在您构建应用时,编译工具会移除这些属性,因此它们不会对 APK 大小或运行时行为产生影响。

要使用这些属性,请将 tools 命名空间添加到您要在其中使用他们的各个 XML 文件的根元素中,如下所示:

错误处理属性

以下属性可帮助抑制 Lint 警告消息。

  • tools:ignore
    适用于:任何元素
    使用者:Lint
    此属性用于接受您希望工具针对相应元素或它的任何子元素忽略的 Lint 问题 ID 的逗号分隔列表。
    例如,您可以告知工具忽略 MissingTranslation 错误:
<string name="show_all_apps" tools:ignore="MissingTranslation">All</string>    
  • tools:targetApi
    适用于:任何元素
    使用者:Lint
    此属性的工作方式与 Java 代码中的 @TargetApi 注解相同:通过它,您可以指定支持相应元素的 API 级别(指定为整数或代号)。
    它会告知工具您认为该元素(及任何子元素)将只能在指定的 API 级别或更高级别中使用。这样,如果该元素或其属性在您指定为 minSdkVersion 的 API 级别中不可用,Lint 将不会向您发出警告。
    例如,GridLayout 只能在 API 级别 14 及更高级别中使用,但您知道此布局不会用于任何更低版本,在这种情况下,您就可以使用此属性:
<GridLayout
xmlns:android="http://schemas.android.com/apk/res/android"       
xmlns:tools="http://schemas.android.com/tools"       
tools:targetApi="14" >    

但是,您应该使用支持库中的 GridLayout

  • tools:locale
    适用于:<resources>
    使用者:Lint、Android Studio 编辑器
    此属性用于告知工具用于给定 <resources> 元素中各项资源的默认语言/语言区域(因为工具会假设为英语),以免拼写检查工具发出警告。值必须是有效的语言区域限定符
    例如,您可以将此属性添加到 values/strings.xml 文件(默认字符串值)中,以指明用于默认字符串的语言是西班牙语,而不是英语。
    <resources xmlns:tools="http://schemas.android.com/tools"        
    tools:locale="es">    
    
设计时视图属性

以下属性定义了仅会在 Android Studio 布局预览中看到的布局特性。

  • tools: 代替 android:
    适用于:<View>
    使用者:Android Studio 布局编辑器
    您可以通过将 tools: 前缀(而不是 android:)与 Android 框架中的任意 <View> 属性搭配使用,在布局预览中插入示例数据。此属性在以下情况下很有用:在运行时之前,属性的值不会填充,但您希望提前在布局预览中看到效果。
    例如,如果 android:text 属性值在运行时设置,或您希望在布局中看到默认值以外的值,则可以添加 tools:text,以便指定一些仅在布局预览中显示的文本。
    **图 1.** `tools:text` 属性将“Google Voice”设置为在布局预览中显示的值

    您可以同时添加 android: 命名空间属性(在运行时使用)和匹配的 tools: 属性(会替换仅在布局预览中显示的运行时属性)。

您还可以使用 tools: 属性来取消将某属性设置为仅用于布局预览。例如,如果您拥有的 FrameLayout 包含多个子元素,但您希望仅在布局预览中看到一个子元素,则可以将其中一个子元素设置为在布局预览中不可见,如下所示:

 <Button  android:id="@+id/button"  android:layout_width="wrap_content"  android:layout_height="wrap_content"  android:text="First"  />  <Button  android:id="@+id/button2"  android:layout_width="wrap_content"  android:layout_height="wrap_content"  android:text="Second"  **tools:visibility="invisible"** /> 

在设计视图中使用布局编辑器时,您还可以通过 Properties 窗口修改部分设计时视图属性。每个设计时属性都用属性名称旁边的扳手图标进行指示,以便与同名的真实属性区分开。

  • tools:context</devsite-heading>
    适用于:任何根 <View>
    使用者:Lint、Android Studio 布局编辑器
    此属性用于声明相应布局默认与哪个 Activity 相关联。这会在编辑器或布局预览中启用具有以下特征的功能:需要了解相应 Activity 的信息,例如预览中的布局主题应该是什么,以及通过快速修复创建 onClick 处理程序时将其插入到什么位置(图 2)。
    **图 2.** 只有在您设置了 `tools:context` 时,`onClick` 属性的快速修复功能才会工作。

    您可以使用清单文件中所用的同一点前缀指定 Activity 类名称(不包括完整的软件包名称)。例如:
    <android.support.constraint.ConstraintLayout  
        xmlns:android="http://schemas.android.com/apk/res/android"      
        xmlns:tools="http://schemas.android.com/tools"                
        tools:context=".MainActivity" >    
    

提示:您还可以从布局编辑器工具栏中选择布局预览的主题。

  • tools:itemCount
    适用于:<RecyclerView>
    使用者:Android Studio 布局编辑器
    对于给定的 RecyclerView,此属性会指定布局编辑器应该在 Preview 窗口中呈现的内容数量。
    例如:

    <android.support.v7.widget.RecyclerView        
    android:id="@+id/recyclerView"        
    android:layout_width="match_parent"        
    android:layout_height="match_parent"        
    tools:itemCount="3"/>    
    
  • tools:layout
    适用于:<fragment>
    使用者:Android Studio 布局编辑器
    此属性用于声明您希望布局预览在 Fragment 内绘制的布局(因为布局预览无法执行正常情况下会应用布局的 Activity 代码)。
    例如:

        <fragment 
            android:name="com.example.master.ItemListFragment"        
            tools:layout="@layout/list_content" />    
    
  • tools:listitem / tools:listheader / tools:listfooter
    适用于:<AdapterView>(以及 <ListView> 等子类)
    使用者:Android Studio 布局编辑器
    这些属性用于指定要在列表的项目、标题和页脚布局预览中显示的布局。布局中的任何数据字段都填充有数字内容(例如“Item 1”),以确保列表的项目不会重复。
    例如:

    <!----->
    <ListView 
        xmlns:android="http://schemas.android.com/apk/res/android"   
        xmlns:tools="http://schemas.android.com/tools"        
        android:id="@android:id/list"        
        android:layout_width="match_parent"        
        android:layout_height="match_parent"        
        tools:listitem="@layout/sample_list_item"        
        tools:listheader="@layout/sample_list_header"        
        tools:listfooter="@layout/sample_list_footer" />    
    

    注意:这些属性不适用于 Android Studio 2.2 中的 ListView,不过在 Android Studio 2.3 中,该问题(问题 215172)已修复。

  • tools:showIn
    适用于:<include> 引用的布局中的任何根 <View>
    使用者:Android Studio 布局编辑器
    通过此属性,您可以指向将相应布局用作内含布局的布局,以便在它出现并嵌入到其父级布局中时预览(和修改)此文件。
    例如:

    <TextView 
         xmlns:android="http://schemas.android.com/apk/res/android"    
         xmlns:tools="http://schemas.android.com/tools"        
         android:text="@string/hello_world"        
         android:layout_width="wrap_content"        
         android:layout_height="wrap_content"        
         tools:showIn="@layout/activity_main" />    
    

现在当此 TextView 布局出现在 activity_main 布局内部时,布局预览中会进行显示。

  • tools:menu

适用于:任何根 <View>
使用者:Android Studio 布局编辑器
此属性用于指定布局预览应该在应用栏中显示的菜单。值可以是一个或多个菜单 ID,以英文逗号分隔(不带 @menu/ 或任何此类 ID 前缀,且不带 .xml 扩展名)。例如:

<?xml version="1.0" encoding="utf-8"?>    
<LinearLayout 
    xmlns:android="http://schemas.android.com/apk/res/android"        
    xmlns:tools="http://schemas.android.com/tools"        
    android:orientation="vertical"        
    android:layout_width="match_parent"        
    android:layout_height="match_parent"        
    tools:menu="menu1,menu2" />    
  • tools:minValue / tools:maxValue</devsite-heading>
    适用于:<NumberPicker>
    使用者:Android Studio 布局编辑器
    这些属性用于设置 NumberPicker 视图的最小值和最大值。
    例如:

    <!-- --->
    <NumberPicker 
        xmlns:android="http://schemas.android.com/apk/res/android"       
        xmlns:tools="http://schemas.android.com/tools"        
        android:id="@+id/numberPicker"        
        android:layout_width="match_parent"        
        android:layout_height="wrap_content"        
        tools:minValue="0"        
        tools:maxValue="10" />    
    
  • tools:openDrawer</devsite-heading>
    适用于:<DrawerLayout>
    使用者:Android Studio 布局编辑器
    通过此属性,您可以在布局编辑器的 Preview 窗格中打开 [DrawerLayout](https://developer.android.google.cn/reference/androidx/drawerlayout/widget/DrawerLayout.html)。您还可以通过传递以下任一值修改布局编辑器呈现布局的方式:
    | 常量 | 值 | 说明 |
    | --- | --- | --- |
    | 结尾 | 800005 | 将对象推送到其容器的结尾,不更改其大小。 |
    | 左侧 | 3 | 将对象推送到其容器的左侧,不更改其大小。 |
    | 右侧 | 5 | 将对象推送到其容器的右侧,不更改其大小。 |
    | 开头 | 800003 | 将对象推送到其容器的开头,不更改其大小。 |
    例如:

    <android.support.v4.widget.DrawerLayout        
        xmlns:android="http://schemas.android.com/apk/res/android"      
        xmlns:tools="http://schemas.android.com/tools"          
        android:id="@+id/drawer_layout"        
        android:layout_width="match_parent"        
        android:layout_height="match_parent"        
        tools:openDrawer="start" />    
    
  • "@tools:sample/*" 资源</devsite-heading>
    适用于:支持界面文本或图片的任何视图。
    使用者:Android Studio 布局编辑器
    通过此属性,您可以将占位符数据或图片注入到视图中。例如,如果您需要测试布局在采用文本时的行为,但尚未最终确定应用的界面文本,则可以使用占位符文本,如下所示:

    <TextView 
        xmlns:android="http://schemas.android.com/apk/res/android"     
        xmlns:tools="http://schemas.android.com/tools"        
        android:layout_width="wrap_content"        
        android:layout_height="wrap_content"        
        tools:text="@tools:sample/lorem" />    
    

    下表列出了可以注入到布局中的占位符数据的类型。

    属性值 占位符数据说明
    @tools:sample/full_names @tools:sample/first_names@tools:sample/last_names 的组合中随机生成的全名。
    @tools:sample/first_names 常见名字。
    @tools:sample/last_names 常见姓氏。
    @tools:sample/cities 世界各地的城市名称。
    @tools:sample/us_zipcodes 随机生成的美国邮政编码。
    @tools:sample/us_phones 随机生成的电话号码,格式如下:(800) 555-xxxx
    @tools:sample/lorem 源自拉丁语的占位符文本。
    @tools:sample/date/day_of_week 指定格式的随机日期和时间。
    @tools:sample/date/ddmmyy
    @tools:sample/date/mmddyy
    @tools:sample/date/hhmm
    @tools:sample/date/hhmmss
    @tools:sample/avatars 可用作个人资料头像的矢量可绘制对象。
    @tools:sample/backgrounds/scenic 可用作背景的图片。
资源压缩属性

通过以下属性,您可以启用严格引用检查,并在使用资源压缩时声明保留还是舍弃某些资源。
要启用资源压缩,请在 build.gradle 文件中将 shrinkResources 属性(以及适用于代码压缩的 minifyEnabled)设置为 true。例如:

android {        
    ...        
    buildTypes {            
        release {                
            shrinkResources true                
            minifyEnabled true   
            proguardFiles getDefaultProguardFile('proguard-android.txt'),  'proguard-rules.pro'            
        }        
    }    
}    
  • tools:shrinkMode
    适用于:<resources>
    使用者:具有资源压缩功能的编译工具
    通过此属性,您可以指定编译工具应该使用“安全模式”(谨慎行事,保留所有明确引用的资源,以及可以通过调用 Resources.getIdentifier() 动态引用的资源)还是“严格模式”(仅保留代码或其他资源中明确引用的资源)。

    默认使用“安全模式”(shrinkMode="safe")。要改为使用“严格模式”,请将 shrinkMode="strict" 添加到 <resources> 标记,如下所示:

    <?xml version="1.0" encoding="utf-8"?>    <resources 
        xmlns:tools="http://schemas.android.com/tools"        
        tools:shrinkMode="strict" />    
    

    启用“严格模式”后,您可能需要使用 tools:keep 来保留已移除但您实际上需要的资源,并使用 tools:discard 来明确移除更多资源。
    如需了解详情,请参阅压缩资源

  • tools:keep
    适用于:<resources>
    使用者:具有资源压缩功能的编译工具
    使用资源压缩功能移除不使用的资源时,您可以通过此属性指定要保留的资源(通常情况下,原因是:相应资源在运行时以间接方式被引用,例如通过将动态生成的资源名称传递给 Resources.getIdentifier())。

    要使用,请在资源目录中创建一个具有 <resources> 标记的 XML 文件(例如,在 res/raw/keep.xml处),并将要保留在 tools:keep 属性中的各项资源指定为逗号分隔列表。您可以将星号字符用作通配符。例如:

    <?xml version="1.0" encoding="utf-8"?>    
    <resources xmlns:tools="http://schemas.android.com/tools"        
        tools:keep="@layout/used_1,@layout/used_2,@layout/*_3" />    
    

    如需了解详情,请参阅压缩资源

  • tools:discard
    适用于:<resources>
    使用者:具有资源压缩功能的编译工具
    使用资源压缩功能删除不使用的资源时,您可以通过此属性指定要手动舍弃的资源(通常情况下,原因是:相应资源被引用,但引用方式不会影响您的应用,或者 Gradle 插件错误地推导出相应资源被引用)。
    要使用,请在资源目录中创建一个具有 <resources> 标记的 XML 文件(例如,在 res/raw/keep.xml处),并将要保留在 tools:discard 属性中的各项资源指定为逗号分隔列表。您可以将星号字符用作通配符。例如:

    <?xml version="1.0" encoding="utf-8"?>    
    <resources xmlns:tools="http://schemas.android.com/tools"        
       tools:discard="@layout/unused_1" />    
    

    如需了解详情,请参阅压缩资源

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,189评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,577评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,857评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,703评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,705评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,620评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,995评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,656评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,898评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,639评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,720评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,395评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,982评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,953评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,195评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,907评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,472评论 2 342

推荐阅读更多精彩内容