使用搜索小部件（SearchView）是否可以仅传递搜索上下文数据？

Question

根据官方文档，提供搜索界面有两种方式：使用搜索对话框或SearchView小部件。我想着重介绍如何使用这两种方式传递搜索上下文数据。

因此，文档指出：

..you can provide additional data in the intent that the system sends to your searchable activity. You can pass the additional data in the APP_DATA Bundle, which is included in the ACTION_SEARCH intent.

To pass this kind of data to your searchable activity, override the onSearchRequested() method for the activity from which the user can perform a search, create a Bundle with the additional data, and call startSearch() to activate the search dialog. For example:

@Override
public boolean onSearchRequested() {
     Bundle appData = new Bundle();
     appData.putBoolean(SearchableActivity.JARGON, true);
     startSearch(null, false, appData, false);
     return true;
}

..Once the user submits a query, it's delivered to your searchable activity along with the data you've added. You can extract the extra data from the APP_DATA Bundle to refine the search. For example:

Bundle appData = getIntent().getBundleExtra(SearchManager.APP_DATA);
if (appData != null) {
    boolean jargon = appData.getBoolean(SearchableActivity.JARGON);
}

这指的是搜索对话框。那么搜索小部件呢？

是否可能仅使用SearchView小部件传递搜索上下文数据？

希望有人能清楚地解释和/或建议另一种或类似的方法来完成目标。

谢谢！

- Eugene Matiyuk

Answer 1

我已经找到了解决方案。甚至有两种解决方案！

它们不需要调用onSearchRequested()，因此根本没有搜索对话框 :)

首先，我提供一些常见的步骤来创建搜索界面，然后给出源问题的解决方案。

我们通过创建res/menu/options_menu.xml文件并使用以下代码将搜索视图添加到应用程序栏：

<?xml version="1.0" encoding="utf-8"?>
<menu xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    tools:context=".MainActivity" >

    <item
        android:id="@+id/action_search"
        android:icon="@drawable/ic_action_search"
        android:title="@string/search_string"
        app:showAsAction="collapseActionView|ifRoom"
        app:actionViewClass="android.support.v7.widget.SearchView" />

</menu>

在res/xml/searchable.xml文件中创建可搜索的配置：

<?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" />

在 AndroidManifest.xml 中声明两个活动：

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

    <application
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:theme="@style/AppTheme">
        <activity
            android:name=".MainActivity"
            android:label="@string/app_name">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>

        <activity android:name=".SearchableActivity"
            android:label="@string/app_name"
            android:launchMode="singleTop">
            <intent-filter>
                <action android:name="android.intent.action.SEARCH"/>
            </intent-filter>
            <meta-data android:name="android.app.searchable"
                android:resource="@xml/searchable"/>
        </activity>

    </application>

</manifest>

创建可搜索的活动，我们处理来自MainActivity的ACTION_SEARCH意图和搜索上下文数据。我们从APP_DATA Bundle中提取额外的数据以细化搜索：

public class SearchableActivity extends AppCompatActivity {
    public static final String JARGON = "com.example.searchinterface.jargon";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_searchable);

        handleIntent(getIntent());
    }

    @Override
    protected void onNewIntent(Intent intent) {
        super.onNewIntent(intent);

        handleIntent(intent);
    }

    private void handleIntent(Intent intent) {

        if (Intent.ACTION_SEARCH.equals(intent.getAction())) {
            String query = intent.getStringExtra(SearchManager.QUERY);
            // use the query to search the data somehow

            Bundle appData = intent.getBundleExtra(SearchManager.APP_DATA);
            if (appData != null) {
                boolean jargon = appData.getBoolean(SearchableActivity.JARGON);
                // use the context data to refine our search
            }
        }
    }
}

现在，我们需要实现我们的MainActivity类。 因此，我们填充菜单并配置SearchView元素。 我们还需要设置SearchView.OnQueryTextListener并实现其方法，特别是onQueryTextSubmit()。 当用户按下提交按钮时，它会被调用，并包含将搜索上下文数据传递给SearchableActivity的主要逻辑。 最后，我们进入了主要答案部分。 正如我所说，有两个解决方案： 1. 使用Bundle extra创建意图并手动发送到SearchableActivity; 以下是包含所有必要内容的MainActivity:

public class MainActivity extends AppCompatActivity implements SearchView.OnQueryTextListener {
    private SearchView mSearchView;

    @Override
    public boolean onCreateOptionsMenu(Menu menu) {
        getMenuInflater().inflate(R.menu.options_menu, menu);

        MenuItem searchItem = menu.findItem(R.id.action_search);
        mSearchView = (SearchView) MenuItemCompat.getActionView(searchItem);

        // associate searchable configuration with the SearchView
        SearchManager searchManager = (SearchManager) getSystemService(Context.SEARCH_SERVICE);
        mSearchView.setSearchableInfo(searchManager.getSearchableInfo(
                new ComponentName(this, SearchableActivity.class)));

        mSearchView.setOnQueryTextListener(this);

        return true;
    }

    @Override
    public boolean onQueryTextSubmit(String query) {
        Intent searchIntent = new Intent(this, SearchableActivity.class);
        searchIntent.putExtra(SearchManager.QUERY, query);

        Bundle appData = new Bundle();
        appData.putBoolean(SearchableActivity.JARGON, true); // put extra data to Bundle
        searchIntent.putExtra(SearchManager.APP_DATA, appData); // pass the search context data
        searchIntent.setAction(Intent.ACTION_SEARCH);

        startActivity(searchIntent);

        return true; // we start the search activity manually
    }

    @Override
    public boolean onQueryTextChange(String newText) {
        return false;
    }
}

感谢https://dev59.com/_2HVa4cB1Zd3GeqPnoQa#22184137。

第二种解决方案也可以放在onQueryTextSubmit()中（但不是必须的）：

2.创建搜索上下文数据Bundle并将其传递给SearchView的setAppSearchData()方法。

因此，我们不需要创建和传递整个搜索意图并启动相应的可搜索活动，系统会处理它。这里有另一个代码片段：

/*
 You may need to suppress the “restrictedApi” error that you could possibly
 receive from this method "setAppSearchData(appData)”.I had to
 I’m targetSdkVersion 26. I’m also using Android Studio 3 
 with the new gradle plugin, which might be causing this.

 If you’re not running Android Studio 3 you can simply put
 “//noinspection RestrictedApi" 
  right above the line: mSearchView.setAppSearchData(appData);
 */
@SuppressWarnings("RestrictedApi")
@Override
public boolean onQueryTextSubmit(String query) {
    Bundle appData = new Bundle();
    appData.putBoolean(SearchableActivity.JARGON, true); // put extra data to Bundle
    mSearchView.setAppSearchData(appData); // pass the search context data

    return false; // we do not need to start the search activity manually, the system does it for us 
}

感谢https://dev59.com/_2HVa4cB1Zd3GeqPnoQa#38295904提供的帮助。

注意：只有支持库版本的SearchView（android.support.v7.widget.SearchView）包含setAppSearchData()方法，请注意。

- Eugene Matiyuk

---

我想补充一下，解决方案2也适用于搜索建议。建议1也可能适用，但我没有使用过。非常棒的帖子！谢谢！ - Sakiboy

Answer 2

如果这个设计符合您的需求，您可以单独使用SearchView，并添加一个OnQueryTextListener来处理它。不需要其他任何东西，没有Intents、Meta-tags或XML文件。我已经做过几次了，但文档上并没有很清楚地说明这一点。

- lionscribe

---

实际上，我需要从具有“SearchView”元素的活动中传递搜索额外数据到某个可搜索活动。我认为无论如何都应该使用意图。 但是你关于使用OnQueryTextListener是正确的。它有助于跟踪用户提交查询的情况。 我也同意你的看法，文档有点不太清楚 :) - Eugene Matiyuk