设置搜索界面

我们建议在应用栏中使用 SearchView 组件来为您的应用提供搜索功能。与应用栏中的所有其他组件一样，您可以定义 SearchView 以始终显示或仅在有空间时显示。您还可以将其定义为可折叠操作，最初将 SearchView 显示为图标，然后在用户点击图标时占据整个应用栏作为搜索字段。

将 SearchView 添加到应用栏

要将 SearchView 组件添加到应用栏，请在您的项目中创建一个名为 res/menu/options_menu.xml 的文件，并将以下代码添加到该文件。此代码定义了如何创建搜索项目，例如要使用的图标和项目的标题。 collapseActionView 属性允许您的 SearchView 展开以占据整个应用栏，并在不使用时折叠回正常的应用栏项目。由于手机设备上的应用栏空间有限，我们建议使用 collapsibleActionView 属性以提供更好的用户体验。

<?xml version="1.0" encoding="utf-8"?>
<menu xmlns:android="http://schemas.android.com/apk/res/android">
<item android:id="@+id/search"
        android:title="@string/search_title"
        android:icon="@drawable/ic_search"
        android:showAsAction="collapseActionView|ifRoom"
        android:actionViewClass="androidx.appcompat.widget.SearchView" />
</menu>

如果您想要一个更易访问的搜索图标，请在 /res/drawable 文件夹中创建一个 ic_search.xml 文件，并在其中包含以下代码

<vector
    android:height="24dp"
    android:tint="#000000"
    android:viewportHeight="24"
    android:viewportWidth="24"
    android:width="24dp"
    xmlns:android="http://schemas.android.com/apk/res/android">
        <path android:fillColor="@android:color/white" android:pathData="M15.5,14h-0.79l-0.28,-0.27C15.41,12.59 16,11.11 16,9.5 16,5.91 13.09,3 9.5,3S3,5.91 3,9.5 5.91,16 9.5,16c1.61,0 3.09,-0.59 4.23,-1.57l0.27,0.28v0.79l5,4.99L20.49,19l-4.99,-5zM9.5,14C7.01,14 5,11.99 5,9.5S7.01,5 9.5,5 14,7.01 14,9.5 11.99,14 9.5,14z"/>
</vector>

要在应用栏中显示 SearchView，请在活动的 onCreateOptionsMenu() 方法中扩展 XML 菜单资源 res/menu/options_menu.xml

Kotlin

override fun onCreateOptionsMenu(menu: Menu): Boolean {
    menuInflater.inflate(R.menu.options_menu, menu)

    return true
}

运行应用程序会生成类似以下内容

An image showing an empty screen with a search icon in the app top bar
图 1. 应用顶栏中的搜索图标。

SearchView 显示在应用的应用栏中，但它没有功能。如果您点击搜索图标，您会得到类似以下内容

An image showing the search view in action
图 2. SearchView 正在运行。

要使 SearchView 具有功能，您必须定义 SearchView 的行为。

创建搜索配置

搜索配置指定了 SearchView 的行为，并在 res/xml/searchable.xml 文件中定义。搜索配置至少必须包含一个 android:label 属性，其值与 Android 清单文件中 <application> 或 <activity> 元素的 android:label 属性相同。但是，我们还建议添加 android:hint 属性，以使用户了解在搜索框中输入什么。

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

<searchable xmlns:android="http://schemas.android.com/apk/res/android"
        android:label="@string/app_name"
        android:hint="@string/search_hint" />

在应用的清单文件中，声明一个指向 res/xml/searchable.xml 文件的 <meta-data> 元素。在您要显示 SearchView 的 <activity> 中声明该元素。

<activity
android:name=".SearchResultsActivity"
android:exported="false"
android:label="@string/title_activity_search_results"
android:launchMode="singleTop"
android:theme="@style/Theme.AppCompat.Light">
    <intent-filter>
        <action android:name="android.intent.action.SEARCH" />
    </intent-filter>
    <meta-data
        android:name="android.app.searchable"
        android:resource="@xml/searchable" />
</activity>

在您创建的 onCreateOptionsMenu() 方法中，通过调用 setSearchableInfo(SearchableInfo) 将搜索配置与 SearchView 关联。

Kotlin

override fun onCreateOptionsMenu(menu: Menu): Boolean {
    menuInflater.inflate(R.menu.options_menu, menu)

    val searchManager = getSystemService(Context.SEARCH_SERVICE) as SearchManager
    val searchView = menu.findItem(R.id.search).actionView as SearchView
    val component = ComponentName(this, SearchResultsActivity::class.java)
    val searchableInfo = searchManager.getSearchableInfo(component)
    searchView.setSearchableInfo(searchableInfo)
    return true
}

对 getSearchableInfo() 的调用获取一个 SearchableInfo 对象，该对象是从搜索配置 XML 文件创建的。当搜索配置与您的 SearchView 正确关联且用户提交查询时，SearchView 将使用 ACTION_SEARCH 意图启动一个活动。然后，您需要一个可以筛选此意图并处理搜索查询的活动。

创建可搜索活动

可搜索活动筛选 ACTION_SEARCH 意图并在数据集中搜索查询。要创建可搜索活动，请声明您选择的活动以筛选 ACTION_SEARCH 意图

<activity android:name=".SearchResultsActivity" ... >
    ...
    <intent-filter>
        <action android:name="android.intent.action.SEARCH" />
    </intent-filter>
    ...
</activity>

在您的可搜索活动中，通过在 onCreate() 方法中检查它来处理 ACTION_SEARCH 意图。

Kotlin

class SearchResultsActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_search_results)
        handleIntent(intent)
    }

    override fun onNewIntent(intent: Intent) {
        super.onNewIntent(intent)
        handleIntent(intent)
    }

    private fun handleIntent(intent: Intent) {
        if (Intent.ACTION_SEARCH == intent.action) {
            val query = intent.getStringExtra(SearchManager.QUERY)
            Log.d("SEARCH", "Search query was: $query")
        }
    }
}

现在，SearchView 可以接受用户的查询并使用 ACTION_SEARCH 意图启动您的可搜索活动。

获取搜索查询后，您可以将其传递给 ViewModel，您可以在架构的其他层中使用它来检索要显示的搜索结果。