设置托管配置

如果您正在为企业市场开发应用，则可能需要满足组织政策设定的特定要求。托管配置（以前称为应用限制）允许组织的 IT 管理员远程指定应用的设置。此功能对于部署到工作资料的组织批准的应用特别有用。

例如，组织可能要求批准的应用允许 IT 管理员

• 允许或阻止 Web 浏览器的 URL
• 配置应用是否允许通过蜂窝网络同步内容，或者仅通过 Wi-Fi 同步内容
• 配置应用的电子邮件设置

本指南介绍如何在您的应用中实现托管配置设置。若要查看具有托管配置的示例应用，请参阅 ManagedConfigurations。如果您是企业移动管理 (EMM) 开发人员，请参阅 Android 管理 API 指南。

注意：由于历史原因，这些配置设置称为限制，并使用此术语实施文件和类（例如 RestrictionsManager）。但是，这些限制实际上可以实施各种配置选项，而不仅仅是应用功能的限制。

远程配置概述

应用定义可由 IT 管理员远程设置的托管配置选项。这些是可由托管配置提供程序更改的任意设置。如果您的应用在工作资料中运行，则 IT 管理员可以更改您的应用的托管配置。

托管配置提供程序是同一设备上运行的另一个应用。此应用通常由 IT 管理员控制。IT 管理员将配置更改传达给托管配置提供程序应用。然后，该应用反过来更改您的应用上的配置。

若要提供外部托管配置

• 在应用清单中声明托管配置。这样做允许 IT 管理员通过 Google Play API 读取应用的配置。
• 每当应用恢复时，请使用 RestrictionsManager 对象检查当前的托管配置，并更改应用的 UI 和行为以符合这些配置。
• 监听 ACTION_APPLICATION_RESTRICTIONS_CHANGED 意图。当您收到此广播时，检查 RestrictionsManager 以查看当前的托管配置，并对应用程序的行为进行必要的更改。

定义托管配置

您的应用程序可以支持您想要定义的任何托管配置。您在托管配置文件中声明应用程序的托管配置，并在清单中声明配置文件。创建配置文件允许其他应用程序检查您的应用程序提供的托管配置。EMM 合作伙伴可以使用 Google Play API 读取应用程序的配置。

要定义应用程序的远程配置选项，请将以下元素放在清单的 <application> 元素中

<meta-data android:name="android.content.APP_RESTRICTIONS"
    android:resource="@xml/app_restrictions" />

在应用程序的 res/xml 目录中创建一个名为 app_restrictions.xml 的文件。该文件结构在 RestrictionsManager 的参考中进行了描述。该文件具有一个顶级 <restrictions> 元素，其中包含一个 <restriction> 子元素，用于应用程序的每个配置选项。

注意：不要创建托管配置文件的本地化版本。您的应用程序仅允许拥有一个托管配置文件，因此配置在所有区域设置中对您的应用程序都将保持一致。

在企业环境中，EMM 通常会使用托管配置模式为 IT 管理员生成远程控制台，以便管理员可以远程配置您的应用程序。

托管配置提供程序可以查询应用程序以查找有关应用程序可用配置的详细信息，包括其描述文本。配置提供程序和 IT 管理员可以随时更改应用程序的托管配置，即使应用程序未运行也是如此。

例如，假设您的应用程序可以远程配置为允许或禁止其通过蜂窝网络下载数据。您的应用程序可以具有如下 <restriction> 元素

<?xml version="1.0" encoding="utf-8"?>
<restrictions xmlns:android="http://schemas.android.com/apk/res/android">

  <restriction
    android:key="downloadOnCellular"
    android:title="@string/download_on_cell_title"
    android:restrictionType="bool"
    android:description="@string/download_on_cell_description"
    android:defaultValue="true" />

</restrictions>

您使用每个配置的 android:key 属性从托管配置包中读取其值。因此，每个配置必须具有唯一的键字符串，并且该字符串不能本地化。它必须使用字符串文字指定。

注意：在生产应用程序中，android:title 和 android:description 应从本地化资源文件中提取，如 使用资源进行本地化 中所述。

应用程序使用 bundle_array 中的包来定义限制。例如，具有多个 VPN 连接选项的应用程序可以在 bundle 中定义每个 VPN 服务器配置，并将多个包组合到一个包数组中

<?xml version="1.0" encoding="utf-8"?>
<restrictions xmlns:android="http://schemas.android.com/apk/res/android" >

  <restriction
    android:key="vpn_configuration_list"
    android:restrictionType="bundle_array">
    <restriction
      android:key="vpn_configuration"
      android:restrictionType="bundle">
      <restriction
        android:key="vpn_server"
        android:restrictionType="string"/>
      <restriction
        android:key="vpn_username"
        android:restrictionType="string"/>
      <restriction
        android:key="vpn_password"
        android:restrictionType="string"/>
    </restriction>
  </restriction>

</restrictions>

android:restrictionType 元素支持的类型列在 表 1 中，并在 RestrictionsManager 和 RestrictionEntry 的参考中进行了说明。

表 1. 限制条目类型及其用法。

注意：android:entryValues 是机器可读的，不能本地化。使用 android:entries 显示可以本地化的人类可读值。每个条目必须在 android:entryValues 中具有相应的索引。

检查托管配置

当其他应用程序更改应用程序的配置设置时，不会自动通知应用程序。相反，您需要在应用程序启动或恢复时检查托管配置是什么，并监听系统意图以了解应用程序运行时配置是否发生更改。

要了解当前的配置设置，应用程序使用 RestrictionsManager 对象。应用程序应在以下时间检查当前的托管配置

• 当应用程序启动或恢复时，在其 onResume() 方法中
• 当应用程序收到配置更改通知时，如 监听托管配置更改 中所述

要获取 RestrictionsManager 对象，请使用 getActivity() 获取当前活动，然后调用该活动的 Activity.getSystemService() 方法

var myRestrictionsMgr =
        activity?.getSystemService(Context.RESTRICTIONS_SERVICE) as RestrictionsManager

RestrictionsManager myRestrictionsMgr =
    (RestrictionsManager) getActivity()
        .getSystemService(Context.RESTRICTIONS_SERVICE);

获得 RestrictionsManager 后，您可以通过调用其 getApplicationRestrictions() 方法获取当前配置设置

var appRestrictions: Bundle = myRestrictionsMgr.applicationRestrictions

Bundle appRestrictions = myRestrictionsMgr.getApplicationRestrictions();

注意：为了方便起见，您还可以使用 UserManager 通过调用 UserManager.getApplicationRestrictions() 获取当前配置。此方法的行为与 RestrictionsManager.getApplicationRestrictions() 完全相同。

getApplicationRestrictions() 方法需要从数据存储中读取，因此应谨慎使用。不要在每次需要了解当前配置时都调用此方法。相反，您应该在应用程序启动或恢复时调用它一次，并缓存获取的托管配置包。然后监听 ACTION_APPLICATION_RESTRICTIONS_CHANGED 意图以了解应用程序处于活动状态时配置是否发生更改，如 监听托管配置更改 中所述。

读取和应用托管配置

getApplicationRestrictions() 方法返回一个 Bundle，其中包含每个已设置配置的键值对。这些值都是 Boolean、int、String 和 String[] 类型。获得托管配置 Bundle 后，您可以使用这些数据类型的标准 Bundle 方法（例如 getBoolean() 或 getString()）检查当前配置设置。

注意：托管配置 Bundle 包含托管配置提供程序显式设置的每个配置的一个条目。但是，不能假设仅因为在托管配置 XML 文件中定义了默认值，配置就会出现在包中。

应用程序需要根据当前托管配置设置采取适当的操作。例如，如果应用程序的配置指定它是否可以通过蜂窝网络下载数据，并且发现配置设置为 false，则必须禁用数据下载，除非设备具有 Wi-Fi 连接，如下面的示例代码所示

val appCanUseCellular: Boolean =
        if (appRestrictions.containsKey("downloadOnCellular")) {
            appRestrictions.getBoolean("downloadOnCellular")
        } else {
            // cellularDefault is a boolean using the restriction's default value
            cellularDefault
        }

if (!appCanUseCellular) {
    // ...turn off app's cellular-download functionality
    // ...show appropriate notices to user
}

boolean appCanUseCellular;

if (appRestrictions.containsKey("downloadOnCellular")) {
    appCanUseCellular = appRestrictions.getBoolean("downloadOnCellular");
} else {
    // cellularDefault is a boolean using the restriction's default value
    appCanUseCellular = cellularDefault;
}

if (!appCanUseCellular) {
    // ...turn off app's cellular-download functionality
    // ...show appropriate notices to user
}

要应用多个 嵌套限制，请将 bundle_array 限制条目读取为 Parcelable 对象的集合，并将其转换为 Bundle。在此示例中，将解析每个 VPN 的配置数据并用于构建服务器连接选择的列表

// VpnConfig is a sample class used store config data, not defined
val vpnConfigs = mutableListOf<VpnConfig>()

val parcelables: Array<out Parcelable>? =
        appRestrictions.getParcelableArray("vpn_configuration_list")

if (parcelables?.isNotEmpty() == true) {
    // iterate parcelables and cast as bundle
    parcelables.map { it as Bundle }.forEach { vpnConfigBundle ->
        // parse bundle data and store in VpnConfig array
        vpnConfigs.add(VpnConfig()
                .setServer(vpnConfigBundle.getString("vpn_server"))
                .setUsername(vpnConfigBundle.getString("vpn_username"))
                .setPassword(vpnConfigBundle.getString("vpn_password")))
    }
}

if (vpnConfigs.isNotEmpty()) {
    // ...choose a VPN configuration or prompt user to select from list
}

// VpnConfig is a sample class used store config data, not defined
List<VpnConfig> vpnConfigs = new ArrayList<>();

Parcelable[] parcelables =
    appRestrictions.getParcelableArray("vpn_configuration_list");

if (parcelables != null && parcelables.length > 0) {
    // iterate parcelables and cast as bundle
    for (int i = 0; i < parcelables.length; i++) {
        Bundle vpnConfigBundle = (Bundle) parcelables[i];
        // parse bundle data and store in VpnConfig array
        vpnConfigs.add(new VpnConfig()
            .setServer(vpnConfigBundle.getString("vpn_server"))
            .setUsername(vpnConfigBundle.getString("vpn_username"))
            .setPassword(vpnConfigBundle.getString("vpn_password")));
    }
}

if (!vpnConfigs.isEmpty()) {
    // ...choose a VPN configuration or prompt user to select from list
}

监听托管配置更改

每当应用程序的托管配置发生更改时，系统都会触发 ACTION_APPLICATION_RESTRICTIONS_CHANGED 意图。应用程序必须监听此意图，以便在配置设置发生更改时更改应用程序的行为。

注意：ACTION_APPLICATION_RESTRICTIONS_CHANGED 意图仅发送到动态注册的侦听器，不发送到在应用程序清单中声明的侦听器。

以下代码显示了如何为该意图动态注册广播接收器

val restrictionsFilter = IntentFilter(Intent.ACTION_APPLICATION_RESTRICTIONS_CHANGED)

val restrictionsReceiver = object : BroadcastReceiver() {
    override fun onReceive(context: Context, intent: Intent) {

        // Get the current configuration bundle
        val appRestrictions = myRestrictionsMgr.applicationRestrictions

        // Check current configuration settings, change your app's UI and
        // functionality as necessary.
    }
}

registerReceiver(restrictionsReceiver, restrictionsFilter)

IntentFilter restrictionsFilter =
    new IntentFilter(Intent.ACTION_APPLICATION_RESTRICTIONS_CHANGED);

BroadcastReceiver restrictionsReceiver = new BroadcastReceiver() {
  @Override public void onReceive(Context context, Intent intent) {

    // Get the current configuration bundle
    Bundle appRestrictions = myRestrictionsMgr.getApplicationRestrictions();

    // Check current configuration settings, change your app's UI and
    // functionality as necessary.
  }
};

registerReceiver(restrictionsReceiver, restrictionsFilter);

注意：通常，当应用程序暂停时，不需要通知它有关配置更改的信息。相反，您应该在应用程序暂停时取消注册广播接收器。当应用程序恢复时，首先检查当前托管配置（如 检查托管配置 中所述），然后注册广播接收器以确保在应用程序处于活动状态时收到有关配置更改的通知。

将托管配置反馈发送到 EMM

将托管配置更改应用于应用程序后，最佳实践是通知 EMM 更改的状态。Android 支持一项名为键控应用程序状态的功能，您可以使用它在应用程序每次尝试应用托管配置更改时发送反馈。此反馈可以作为应用程序成功设置托管配置的确认，或者如果应用程序未能应用指定的更改，则可以包含错误消息。

EMM 提供商能够检索此反馈并在其控制台中显示，供 IT 管理员查看。有关此主题的更多信息，包括有关如何向应用程序添加反馈支持的详细指南，请参阅 将应用程序反馈发送到 EMM。

其他代码示例

ManagedConfigurations 示例进一步演示了本页介绍的 API 的用法。