51CTO最近向开发者介绍过Android开发之WebView组件的使用详解,今天我们再来介绍一下Android系统搜索对话框设计使用方法:

当您需要在您的应用程序中提供搜索服务时,您第一个想到的是您的搜索框要放哪呢?通过使用Android的搜索框架,应用程序将显示一个自定义搜索对话框来处理用户的搜索请求。通过一个简单的搜索按钮或从您的应用程序中调用API,搜索对话框就会显示在屏幕的顶部,并会自动显示您的应用程序图标。如下图所示:

搜索框
搜索框

本文将教你如何为你的应用程序提供一个自定义搜索对话框。这样做,给您的用户提供一个标准化的搜索体验,并能增加如语音搜索和搜索建议等功能。

基础知识

Android的搜索框架将代您管理的搜索对话框,您不需要自己去开发一个搜索框,不需要担心要把搜索框放什么位置,也不需要担心搜索框影响您当前的界面。所有的这些工作都由SearchManager类来为您处理(以下简称“搜索管理器”),它管理的Android搜索对话框的整个生命周期,并执行您的应用程序将发送的搜索请求,返回相应的搜索关键字。

当用户执行一个搜索,搜索管理器将使用一个专门的Intent把搜索查询的关键字传给您在配置文件中配置的处理搜索结果的Activity。从本质上讲,所有你需要的就是一个Activity来接收Intent,然后执行搜索,并给出结果。具体来说,你需要的做的事就包括以下内容:

一个搜索配置

我们用个XML配置文件来对搜索对话框进行配置,包括一些功能的配置,如文本框,设置语音搜索和搜索建议中显示的提示文字等。

一个用来处理搜索请求的Activity

这个Activity用来接收搜索查询的内容,然后搜索您的数据并显示搜索结果。

一种用户执行搜索的途径

默认情况下,一旦你配置了一个可搜索的Activity,设备搜索键(如果有)将调用搜索对话框。然而,你应该始终提供另一种手段,让用户可以调用搜索对话框,如在选项菜单中的搜索按钮或其他用户界面上的按钮,因为不是所有的设备提供一个专门的搜索键。

创建一个搜索对话框配置文件

搜索框配置文件是一个用来配置您的应用程序中搜索框的设置的XML文件,这个文件一般命名为searchable.xml,并且必须保存在项目的res/xml/目录下。

配置文件的根节点必须为,可以有一个或多个属性。如下图所示:

	

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

<searchable xmlns:android="http://schemas.android.com/apk/res/android" 

    android:label="@string/searchLabel" android:hint="@string/searchHint"> 

searchable> 

 

上面的配置文件中,除android:hint属性外,其它都是一个搜索对话框必须的配置项,android:label是一个必须的属性,它的值为一个string资源引用,不能直接用字符串,通常会是应用程序的名称(尽管它是一个必须的属性,但通常情况下是不显示出来的,除非你开启了搜索建议功能)。android:hint是配置搜索框的输入提示信息,也必须引用string.xml中配置的字符串资源,不能直接使用字符串。

可以配置很多的属性,但大部分属性都只是在使用搜索建议和语音搜索时进行配置,尽管如此,我们建议你一定要配置android:hint,用于提示用户需要输入的信息。

接下来,你需要把这个配置文件放到你的应用程序中。

创建一个可用于搜索的Activity

当用户从一个搜索框执行搜索时,搜索管理器(Search Manager)会通过ACTION_SEARCH Intent 把要搜索的内容(关键字)发送到一个可执行搜索的Activity。这个Acitivity查询数据并显示结果。

定义一个可搜索的Activity

如果你还没有准备好,那么就创建一个用来执行搜索的Activity,声明它可以响应ACTION_SEARCH Intent ,并且增加搜索框配置信息。为此,你需要添加一个元素和一个元素在你的manifest文件中的节点。如下所示:

	

<application ... > 

    <activity android:name=".MySearchableActivity" > 

        <intent-filter> 

            <action android:name="android.intent.action.SEARCH" /> 

        intent-filter> 

        <meta-data android:name="android.app.searchable" 

                   android:resource="@xml/searchable"/> 

    activity> 

    ... 

application> 

 

中的android:name属性值必须为”android.app.searchable”,android:resource属性值必须引用上面提到的res/xml/目录下的搜索配置文件(本例中的res/xml/searchable.xml)。

请注意,只有配置了上面的meta-data节点的Activity的节点才能执行搜索,如果想在整个应用程序中都可以调用搜索框,可以进行如下配置:

	

<application ... > 

    <activity android:name=".MySearchableActivity" > 

        <intent-filter> 

            <action android:name="android.intent.action.SEARCH" /> 

        intent-filter> 

        <meta-data android:name="android.app.searchable" 

                   android:resource="@xml/searchable"/> 

    activity> 

    <activity android:name=".AnotherActivity" ... > 

    activity> 

    > 

    <meta-data android:name="android.app.default_searchable" 

               android:value=".MySearchableActivity" /> 

    ... 

application> 

 

上面代码中android:name=”android.app.default_searchable” 定义一个响应搜索框搜索请求的名称,android:value指定是由哪个Activity响应并执行搜索。当我们在应用程序中的OtherAcitivity中执行搜索请求时,MySearchableActivity将会被加载用于执行搜索并显示搜索结果。

执行一个搜索

当一个Activity声明为可搜索时,执行实际的搜索包括三个步骤:接收查询,检索你的数据,并提交结果。

通常情况下,你的搜索结果需要在一个ListView中展现,所以你用于执行搜索的Acitivity要继承ListActivity,这样,可以方便的访问ListView的Api。

接收搜索查询

当从搜索对话框执行搜索时,刚才配置的可用于搜索的Acitivity将会被Intent激活,同时带着一些搜索相关的参数,你需要检查Intent并做出搜索响应,如下所示:

	

@Override 

public void onCreate(Bundle savedInstanceState) { 

    super.onCreate(savedInstanceState); 

    setContentView(R.layout.search); 

  

    Intent intent = getIntent(); 

//判断是否是搜索请求 

    if (Intent.ACTION_SEARCH.equals(intent.getAction())) { 

//获取搜索的查询内容(关键字) 

      String query = intent.getStringExtra(SearchManager.QUERY); 

//执行相应的查询动作 

      doMySearch(query); 

    } 

 

doMySearch()方法将根据关键字查询数据库,或从网络上查询数据,如果是耗时的搜索,你还需要使用进度条,来告诉用户搜索正在进行,最后返回结果后,可以调用ListView的setAdapter()方法将结果显示在ListView中。

调用搜索对话框

你可以从应用程序中的任何一个地方调用onSearchRequested()方法激活搜索框,比如从菜单中或者一个按钮等。你也要以在onCreate()方法中调用setDefaultKeyMode(DEFAULT_KEYS_SEARCH_LOCAL),这样,当用户按下键盘上的按键时,将会自动激活搜索框。

搜索框和普通对话框一样,浮动在屏幕的最上方,它不会改变任何Activity堆栈状态,没有任何Activity生命周期中的方法会被调用,只是当搜索框出现就,正在运行的Activity会失去输入焦点。

如果你要在执行搜索时,进行别的操作,可以重写onSearchRequested()方法,如下所示:

	

@Override 

public boolean onSearchRequested() { 

//这个方法中干你想干的事,比如做一些被始化工作 

    pauseSomeStuff(); 

    return super.onSearchRequested(); 

 

如果当前的Activity就是响应搜索请求的Activity时,会有以下两种情况:

默认情况下,ACTION_SEARCH Intent将会创建一个新的Activity,并调用onCreate()方法,这个新的Activity会显示在最前面,你将同时有两个Activity实例。当你按“返回”键里,会回到没有执行搜索前的一个Activity。

另一种情况是配置了android:launchMode=”singleTop”的Activity,这时,我们需要在onNewIntent(Intent)方法中处理搜索请求,如下所示:

	

@Override 

public void onCreate(Bundle savedInstanceState) { 

    super.onCreate(savedInstanceState); 

    setContentView(R.layout.search); 

    handleIntent(getIntent()); 

  

@Override 

protected void onNewIntent(Intent intent) { 

    setIntent(intent); 

    handleIntent(intent); 

  

private void handleIntent(Intent intent) { 

    if (Intent.ACTION_SEARCH.equals(intent.getAction())) { 

      String query = intent.getStringExtra(SearchManager.QUERY); 

      doMySearch(query); 

    } 

 

相应的Activity配置如下

	

<activity android:name=".MySearchableActivity" 

              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> 

 

如何给搜索框增加参数

要给搜索框传递参数,我们需要重写onSearchRequested()方法,如下所示:

	

@Override 

public boolean onSearchRequested() { 

     Bundle appData = new Bundle(); 

     appData.putBoolean(MySearchableActivity.JARGON, true); 

     startSearch(null, false, appData, false); 

     return true; 

 

我们的Activity在收到搜索框的搜索请求时,通过如下方法获取参数:

	

Bundle appData = getIntent().getBundleExtra(SearchManager.APP_DATA); 

if (appData != null) { 

     boolean jargon = appData.getBoolean(MySearchableActivity.JARGON); 

 

最后我们来看看如何使用android的语音搜索:

只需要对我们的搜索配置文件做如下改动,你的搜索就支持语音搜索了,配置文件如下所示:

	

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

<searchable xmlns:android="http://schemas.android.com/apk/res/android" 

    android:label="@string/searchLabel" 

    android:hint="@string/searchHint" 

    android:voiceSearchMode="showVoiceSearchButton|launchRecognizer"> 

searchable> 

 

 

示例程序下载:http://www.ideasandroid.com/android/demo/FloatSearchBoxDemo.rar

原文地址:http://www.ideasandroid.com/?p=310