Show navigation Hide navigation

应用清单文件

每个应用的根目录中都必须包含一个 AndroidManifest.xml 文件(且文件名精确无误)。 清单文件为 Android 系统提供有关您的应用的基本信息,系统必须获得这些信息才能运行任意应用代码。 此外,清单文件还可执行以下操作:

  • 为应用的 Java 软件包命名。软件包名称充当应用的唯一标识符
  • 描述应用的各个组件,即:构成应用的 Activity、服务、广播接收器和内容提供程序。 为实现每个组件的类命名并发布其功能(例如,它们可以处理的 Intent 消息)。根据这些声明,Android 系统可以了解这组件具体是什么,以及在什么条件下可以启动它们
  • 确定将托管应用组件的进程
  • 声明应用必须具备哪些权限才能访问 API 中受保护的部分并与其他应用交互
  • 还声明其他应用与该应用组件交互所需具备的权限
  • 列出 Instrumentation 类,这些类可在应用运行期间提供分析和其他信息。这些声明只会在应用处在开发和测试阶段时出现在清单文件中;它们会在应用发布之前被删除
  • 声明应用所需的最低 Android API 级别
  • 列出应用必须链接到的库

清单文件结构

下图显示了清单文件的通用结构及其可包含的每个元素。 每个元素及其所有属性全部记录在一个单独的文件中。 要查看有关任何元素的详细信息,请点击该图中或其后按字母顺序排列的元素列表中相应的元素名称,或者点击任何其他地方提到的相应元素名称。

<?xml version="1.0" encoding="utf-8"?>

<manifest>

    <uses-permission />
    <permission />
    <permission-tree />
    <permission-group />
    <instrumentation />
    <uses-sdk />
    <uses-configuration />  
    <uses-feature />  
    <supports-screens />  
    <compatible-screens />  
    <supports-gl-texture />  

    <application>

        <activity>
            <intent-filter>
                <action />
                <category />
                <data />
            </intent-filter>
            <meta-data />
        </activity>

        <activity-alias>
            <intent-filter> . . . </intent-filter>
            <meta-data />
        </activity-alias>

        <service>
            <intent-filter> . . . </intent-filter>
            <meta-data/>
        </service>

        <receiver>
            <intent-filter> . . . </intent-filter>
            <meta-data />
        </receiver>

        <provider>
            <grant-uri-permission />
            <meta-data />
            <path-permission />
        </provider>

        <uses-library />

    </application>

</manifest>

可出现在清单文件中的所有元素按字母顺序罗列如下。 这些是仅有的合法元素;您无法添加自己的元素或属性。

<action>
<activity>
<activity-alias>
<application>
<category>
<data>
<grant-uri-permission>
<instrumentation>
<intent-filter>
<manifest>
<meta-data>
<permission>
<permission-group>
<permission-tree>
<provider>
<receiver>
<service>
<supports-screens>
<uses-configuration>
<uses-feature>
<uses-library>
<uses-permission>
<uses-sdk>

文件约定

有些约定和规则普遍适用于清单文件中的所有元素和属性:

元素
只有 <manifest><application> 元素是必需的,它们都必须存在并且只能出现一次。其他大部分元素可以出现多次或者根本不出现,即便清单文件中必须至少存在其中某些元素才能完成任何有意义的操作也是如此。

如果一个元素包含某些内容,也就包含其他元素。所有值均通过属性进行设置,而不是通过元素内的字符数据设置。

同一级别的元素通常不分先后顺序。例如,<activity><provider><service> 元素可以按任何顺序混合在一起。 (<activity-alias> 元素不适用此规则: 它必须跟在别名所指的 <activity> 之后。)

属性
从某种意义上说,所有属性都是可选的。但是,有些属性必须指定给元素以实现其目的。 请使用本文档作为参考。 对于真正可选的属性,它将指定默认值或声明缺乏规范时将执行何种操作。

除了根 <manifest> 元素的一些属性外,所有属性名称均以 android: 前缀开头,例如,android:alwaysRetainTaskState。由于该前缀是通用的,因此在按名称引用属性时,本文档通常会将其忽略。

声明类名
许多元素对应于 Java 对象,其中包括应用本身的元素(<application> 元素)及其主要组件 — Activity (<activity>)、服务 (<service>)、广播接收器 (<receiver>) 以及内容提供程序 (<provider>)。

如果按照您针对组件类(ActivityServiceBroadcastReceiverContentProvider)几乎一直采用的方式来定义子类,则该子类需通过 name 属性来声明。 该名称必须包含完整的软件包名称。 例如,Service 子类可能会声明如下:

<manifest . . . >
    <application . . . >
        <service android:name="com.example.project.SecretService" . . . >
            . . .
        </service>
        . . .
    </application>
</manifest>

但是,为了简便起见,如果字符串的第一个字符是句点,则字符串将追加到应用的软件包名称(正如 <manifest> 元素的 package 属性中所指定)。 以下赋值与上述方法相同:

<manifest package="com.example.project" . . . >
    <application . . . >
        <service android:name=".SecretService" . . . >
            . . .
        </service>
        . . .
    </application>
</manifest>

当启动组件时,Android 会创建已命名子类的实例。如果未指定子类,则会创建基类的实例。

多个值
如果可以指定多个值,则几乎总是在重复此元素,而不是列出单个元素内的多个值。 例如,Intent 过滤器可以列出多个操作:
<intent-filter . . . >
    <action android:name="android.intent.action.EDIT" />
    <action android:name="android.intent.action.INSERT" />
    <action android:name="android.intent.action.DELETE" />
    . . .
</intent-filter>
资源值
某些属性的值可以显示给用户,例如,Activity 的标签和图标。 这些属性的值应该本地化,因此需要通过资源或主题进行设置。 资源值用以下格式表示:

@[package:]type:name

其中,如果资源与应用位于同一软件包中,则可忽略 package 名称; type 是资源类型,如“字串符”或“图片”; name 是标识特定资源的名称。例如:

<activity android:icon="@drawable/smallPic" . . . >

主题中的值用类似的方法表示,但是以“?”开头而不是“@”:

?[package:]type:name

字串符值
如果属性值为字串符,则必须使用双反斜杠(“\\”) 转义字符。例如,使用“\\n”表示换行符或使用“\\uxxxx”表示 Unicode 字符)。

文件功能

下文介绍如何在清单文件中利用某些 Android 特性。

Intent 过滤器

应用的核心组件(其 Activity、服务和广播接收器)由 Intent 激活。Intent 是一系列用于描述所需操作的信息(Intent 对象),其中包括要执行操作的数据、应执行操作的组件类别以及其他相关说明。 Android 会找到合适的组件来响应 Intent,根据需要启动组件的新实例,并将其传递到 Intent 对象。

组件将通过“Intent 过滤器”公布其功能,即它们可响应的 Intent 类型。 由于 Android 系统在启动某组件之前必须了解该组件可以处理哪些 Intent,因此 Intent 过滤器在清单文件中被指定为 <intent-filter> 元素。 一个组件可能有任意数量的过滤器,其中每个过滤器描述一种不同的功能。

显式命名目标组件的 Intent 将激活该组件;过滤器不起作用。但是,不按名称指定目标的 Intent 只有在能够通过组件的一个过滤器时才可激活该组件。

有关如何根据 Intent 过滤器测试 Intent 对象的信息,请参阅单独的文档 Intent 和 Intent 过滤器

图标和标签

对于可以显示给用户的小图标和文本标签,大量元素具有 iconlabel 属性。此外,对于同样可以显示在屏幕上的较长说明文本,某些元素还具有 description 属性。例如,<permission> 元素具有所有这三个属性。因此,当系统询问用户是否授权给请求获得权限的应用时,权限图标、权限名称以及所需信息的说明均可呈现给用户。

无论何种情况下,在包含元素中设置的图标和标签都将成为所有容器子元素的默认 iconlabel 设置。因此,在 <application> 元素中设置的图标和标签是每个应用组件的默认图标和标签。 同样,为组件(例如,<activity> 元素)设置的图标和标签是组件每个 <intent-filter> 元素的默认设置。 如果 <application> 元素设置标签,但是 Activity 及其 Intent 过滤器不执行此操作,则应用标签将被视为 Activity 和 Intent 过滤器的标签。

在实现 Intent 过滤器公布的功能时,只要向用户呈现组件,系统便会使用为过滤器设置的图标和标签表示该组件。 例如,具有“android.intent.action.MAIN”和“android.intent.category.LAUNCHER”设置的过滤器将 Activity 公布为可启动应用的功能,即,公布为应显示在应用启动器中的功能。 因此,在过滤器中设置的图标和标签就是显示在启动器中的图标和标签。

权限

权限 是一种限制,用于限制对部分代码或设备上数据的访问。 施加限制是为了保护可能被误用以致破坏或损害用户体验的关键数据和代码。

每种权限均由一个唯一的标签标识。标签通常指示受限制的操作。 例如,以下是由 Android 定义的一些权限:

android.permission.CALL_EMERGENCY_NUMBERS
android.permission.READ_OWNER_DATA
android.permission.SET_WALLPAPER
android.permission.DEVICE_POWER

一个功能最多只能由一种权限保护。

如果应用需要访问受权限保护的功能,则必须在清单文件中使用 <uses-permission> 元素声明应用需要该权限。 但是,将应用安装到设备上之后,安装程序会通过检查签署应用证书的颁发机构并(在某些情况下)询问用户,确定是否授予请求的权限。 如果授予权限,则应用能够使用受保护的功能。 否则,其访问这些功能的尝试将会失败,并且不会向用户发送任何通知。

此外,应用也可以使用权限保护自己的组件(Activity、服务、广播接收器和内容提供程序)。 它可以采用由 Android 定义(如 android.Manifest.permission 中所列)或由其他应用声明的任何权限。或者,它也可以定义自己的权限。新权限用 <permission> 元素来声明。 例如,Activity 可受到如下保护:

<manifest . . . >
    <permission android:name="com.example.project.DEBIT_ACCT" . . . />
    <uses-permission android:name="com.example.project.DEBIT_ACCT" />
    . . .
    <application . . .>
        <activity android:name="com.example.project.FreneticActivity"
                  android:permission="com.example.project.DEBIT_ACCT"
                  . . . >
            . . .
        </activity>
    </application>
</manifest>

请注意,在此示例中,DEBIT_ACCT 权限不仅是通过 <permission> 元素来声明,而且其使用也是通过 <uses-permission> 元素来请求。要让应用的其他组件也能够启动受保护的 Activity,就必须请求其使用权限,即便保护是由应用本身施加的亦如此。

同样还是在此示例中,如果将 permission 属性设置为在其他位置(例如,android.permission.CALL_EMERGENCY_NUMBERS)声明的权限,则无需使用 <permission> 元素再次声明。 但是,仍有必要通过 <uses-permission> 请求使用它。

<permission-tree> 元素为一组将在代码中定义的权限声明命名空间。 同时, <permission-group> 为一组权限(包括在清单文件中使用 <permission> 元素声明的权限以及在其他位置声明的权限)定义标签。它只影响如何对提供给用户的权限进行分组。 <permission-group> 元素并不指定哪些权限属于该组,而只是为组提供名称。 通过向 <permission> 元素的 permissionGroup 属性分配组名,将权限放入组中。

每个应用均链接到默认的 Android 库,该库中包括构建应用(以及通用类,如 Activity、服务、 Intent 、视图、按钮、应用、ContentProvider 等)的基本软件包。

但是,某些软件包驻留在自己的库中。如果应用使用来自其中任一软件包的代码,则必须明确要求其链接到这些软件包。 清单文件必须包含单独的 <uses-library> 元素来命名其中每个库。(库名称可在软件包的文档中找到。)