AndroidのツールバーでSearchViewを実装する方法【ステップ解説】

はじめに

本記事では、Androidアプリのツールバー（Toolbar）にSearchViewを組み込み、リストの絞り込み検索機能を実装する方法を、ステップバイステップで解説します。サンプルとして月名の一覧をListViewに表示し、SearchViewに入力したキーワードでリアルタイムに検索結果をフィルタリングする仕組みを作ります。

手順1：新規プロジェクトの作成

まず、Android Studioを起動し、メニューから「File」→「New Project」を選択します。必要な項目をすべて入力して、新しいプロジェクトを作成しましょう。

手順2：レイアウトファイルの編集

次に、res/layout/activity_main.xml に以下のコードを追加します。ここでは、Toolbar、ListView、および検索結果が見つからなかった場合に表示するTextViewを配置しています。

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout
   xmlns:android="https://schemas.android.com/apk/res/android"
   xmlns:tools="https://schemas.android.com/tools"
   android:layout_width="match_parent"
   android:layout_height="match_parent"
   xmlns:app="https://schemas.android.com/apk/res-auto"
   tools:context=".MainActivity">
   <android.support.v7.widget.Toolbar
      android:id="@+id/toolbar"
      android:layout_width="match_parent"
      android:layout_height="wrap_content"
      android:background="?attr/colorPrimary"
      android:minHeight="?attr/actionBarSize"
      app:actionViewClass="android.support.v7.widget.SearchView"
      app:theme="@style/ThemeOverlay.AppCompat.Dark" />
   <ListView
      android:id="@+id/listView"
      android:layout_width="match_parent"
      android:layout_height="wrap_content" />
   <TextView
      android:id="@+id/emptyView"
      android:layout_width="wrap_content"
      android:layout_height="wrap_content"
      android:layout_centerInParent="true"
      android:text="No Results"
      android:textSize="20sp"
      android:visibility="gone"/>
</RelativeLayout>

手順3：MainActivity.javaの実装

src/MainActivity.java に以下のコードを記述します。onCreateOptionsMenu() 内でメニューからSearchViewを取得し、OnQueryTextListener を使って入力テキストが変化するたびに ArrayAdapter のフィルター処理を呼び出すことで、リストの絞り込みを行っています。

import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.support.v7.widget.SearchView;
import android.support.v7.widget.Toolbar;
import android.view.Menu;
import android.view.MenuItem;
import android.view.View;
import android.widget.AdapterView;
import android.widget.ArrayAdapter;
import android.widget.ListView;
import android.widget.TextView;
import android.widget.Toast;
public class MainActivity extends AppCompatActivity {
   Toolbar toolbar;
   ArrayAdapter adapter;
   ListView listView;
   TextView emptyView;
   @Override
   protected void onCreate(Bundle savedInstanceState) {
      super.onCreate(savedInstanceState);
      setContentView(R.layout.activity_main);
      toolbar = findViewById(R.id.toolbar);
      listView = findViewById(R.id.listView);
      emptyView = findViewById(R.id.emptyView);
      adapter = new ArrayAdapter(this, android.R.layout.simple_list_item_1,
      getResources().getStringArray(R.array.months_array));
      listView.setAdapter(adapter);
      listView.setOnItemClickListener(new AdapterView.OnItemClickListener() {
         @Override
         public void onItemClick(AdapterView<?> adapterView, View view, int i, long l) {
            Toast.makeText(MainActivity.this, adapterView.getItemAtPosition(i).toString(), Toast.LENGTH_SHORT).show();
         }
      });
      listView.setEmptyView(emptyView);
   }
   @Override
   public boolean onCreateOptionsMenu(Menu menu) {
      getMenuInflater().inflate(R.menu.menu, menu);
      MenuItem mSearch = menu.findItem(R.id.appSearchBar);
      SearchView mSearchView = (SearchView) mSearch.getActionView();
      mSearchView.setQueryHint("Search");
      mSearchView.setOnQueryTextListener(new SearchView.OnQueryTextListener() {
         @Override
         public boolean onQueryTextSubmit(String query) {
            return false;
         }
         @Override
         public boolean onQueryTextChange(String newText) {
            adapter.getFilter().filter(newText);
            return true;
         }
      });
      return super.onCreateOptionsMenu(menu);
   }
}

手順4：メニューリソースの作成

プロジェクトを右クリックし、「New」→「Android Resource Directory」を選択して menu ディレクトリを作成します。続いて res/menu を右クリックし、「New」→「Menu resource file」で menu.xml を作成し、以下のコードを追加してください。

<?xml version="1.0" encoding="utf-8"?>
<menu xmlns:android="https://schemas.android.com/apk/res/android"
   xmlns:app="https://schemas.android.com/apk/res-auto">
   <item
      android:id="@+id/appSearchBar"
      android:icon="@drawable/ic_search"
      android:title="Search"
      app:showAsAction="ifRoom|withText"
      app:actionViewClass="android.support.v7.widget.SearchView"/>
</menu>

手順5：文字列リソースの定義

res/values/strings.xml を開き、以下のコードを追加します。ここには表示用の月名データ（months_array）を定義しています。

<resources>
   <string name="app_name">Sample</string>
   <string-array name="months_array">
      <item>January</item>
      <item>February</item>
      <item>March</item>
      <item>April</item>
      <item>May</item>
      <item>June</item>
      <item>July</item>
      <item>August</item>
      <item>September</item>
      <item>October</item>
      <item>November</item>
      <item>December</item>
   </string-array>
</resources>

手順6：マニフェストファイルの編集

最後に、androidManifest.xml に以下のコードを追加します。

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="https://schemas.android.com/apk/res/android" package="app.com.sample">
   <application
      android:allowBackup="true"
      android:icon="@mipmap/ic_launcher"
      android:label="@string/app_name"
      android:roundIcon="@mipmap/ic_launcher_round"
      android:supportsRtl="true"
      android:theme="@style/AppTheme">
      <activity android:name=".MainActivity">
         <intent-filter>
            <action android:name="android.intent.action.MAIN" />
            <category android:name="android.intent.category.LAUNCHER" />
         </intent-filter>
      </activity>
   </application>
</manifest>

アプリの実行と動作確認

それでは、実際にアプリを実行してみましょう。実機のAndroidスマートフォンをパソコンに接続していることを前提に説明します。Android Studioでプロジェクト内のアクティビティファイルを開き、ツールバーの「Run」アイコンをクリックしてください。表示される選択肢から接続中のモバイルデバイスを選ぶと、端末に以下のような画面が表示されます。