通用搜索

Android 8.0 为“设置”菜单添加了经过扩展的搜索功能。本文档介绍了如何添加设置,以及如何确保正确地将其加入“设置”搜索的索引中。

创建可编入索引的设置

需要编入索引的每个“设置”片段都会实现 Indexable 接口,并且需要静态字段:

public static final SearchIndexProvider SEARCH_INDEX_DATA_PROVIDER

为您的片段进行设置以编入索引后,将其添加到以下位置中的 SearchIndexableResources
packages/apps/Settings/src/com/android/settings/search/SearchIndexableResources.java

可选方法

SearchIndexProvider 接口有四种可选方法。

getXmlResourcesToIndex

  • 如果您的片段内容来自 preference xml,则替换此方法
  • 以要编入索引的列表形式返回 XML 偏好设置。

XML 资源示例:

public List<SearchIndexableResource> getXmlResourcesToIndex(Context context, boolean enabled) {
    ArrayList<SearchIndexableResource> result =  new ArrayList<SearchIndexableResource>();
SearchIndexableResource sir = new SearchIndexableResource(context);
	sir.xmlResId = R.xml.display_settings;
	result.add(sir);

    return result;
}

getRawDataToIndex

  • 如果您的片段内容并非来自 preference xml,则替换此方法
  • 返回要编入索引的原始数据 (SearchIndexableRaw) 的列表。

原始数据示例:

public List<SearchIndexableRaw> getRawDataToIndex(Context context, boolean enabled) {
              final List<SearchIndexableRaw> result = new ArrayList<>();
              final Resources res = context.getResources();

              // Add fragment title
       SearchIndexableRaw data = new SearchIndexableRaw(context);
       data.title = res.getString(R.string.wifi_settings);
       data.screenTitle = res.getString(R.string.wifi_settings);
       data.keywords = res.getString(R.string.keywords_wifi);
       data.key = DATA_KEY_REFERENCE;
       result.add(data);

       return result;
}

getNonIndexableKeys

  • 如果您的片段为 DashboardFragment,则很少需要替换该方法。
  • 返回不应针对给定用户、设备、配置等显示的结果相对应的键列表。此处提供的键应与 SearchIndexableResourceSearchIndexableRaw 中的 KEY 字段匹配。
  • 例如:不应向从未在其设备中使用 SIM 卡的用户显示“流量消耗”。

不可编入索引的键示例:

public List<String> getNonIndexableKeys(Context context) {
      final List<String> keys = super.getNonIndexableKeys(context);
              if (!checkIntentAction(context, "android.settings.TERMS")) {
                  keys.add(KEY_TERMS);
              }
              if (!checkIntentAction(context, "android.settings.LICENSE")) {
                  keys.add(KEY_LICENSE);
              }
              if (!checkIntentAction(context, "android.settings.COPYRIGHT")) {
                  keys.add(KEY_COPYRIGHT);
              }
              if (!checkIntentAction(context, "android.settings.WEBVIEW_LICENSE")) {
                  keys.add(KEY_WEBVIEW_LICENSE);
              }
              return keys;
}

getPreferenceControllers

返回与此片段相关联的偏好设置控制器列表。此列表用于形成内嵌结果、更新不可编入索引的内容等。

因此,您希望在搜索中显示的所有内容都必须包含在 getXmlResourcesToIndexgetRawDataToIndex 中。

为您的设置添加关键字

为确保设置易于搜索,请添加与设置相关、用户可能用来搜索该设置的关键字。

添加关键字时请注意以下事项:

  • 关键字是具有以下特征的词语的列表:用户不一定会看到,但可能属于在脑中构想相应设置的工作原理时会用到的字词。
  • 关键字是用户可能会输入以访问您的设置的字词。
  • 关键字可以是同义词,或者与设置相关联的任何字词。
  • 例如,可以使用“静音”来查找“音量”设置。

避免重复内容

如果您要无条件地排除某个设置页面,请移除原始页面的索引,以避免出现重复的结果。

  1. 找到您要排除的页面的 PreferenceFragment
  2. 移除 SearchIndexProvider

验证

要测试新设置的可搜索性,请执行以下操作:

  1. 在设备上安装最新版本的 Android O。
  2. 通过依次选择以下各项让数据库重新编制索引:
  3. 设置 > 应用和通知 > 应用信息 > 设置 > 存储 > 清除数据
  4. 验证目标设置是否显示在搜索结果中。
    搜索设置的标题前缀将与该设置匹配。

可以运行以下 robolectric 测试来验证此功能的实现:
packages/apps/Settings/tests/robotests/src/com/android/settings/search

编译目标为:RunSettingsRoboTests