【Android入門】AppBarLayoutの使い方をステップ解説！ToolbarとRecyclerViewを連携させよう

この記事では、Androidアプリ開発におけるAppBarLayoutの基本的な使い方を、実際のコード例とともにステップ形式で解説します。AppBarLayoutを活用すると、スクロールに連動してツールバーが隠れたり再表示されたりする、モダンなUIを簡単に実装できます。

完成イメージ

本チュートリアルでは、AppBarLayout内にToolbarを配置し、その下にRecyclerViewを設置します。リストを下にスクロールするとツールバーが隠れ、上にスクロールするとすぐに再表示される動作を作ります。

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

まず、Android Studioで新しいプロジェクトを作成しましょう。メニューから「File」→「New Project」を選択し、必要な情報を入力してプロジェクトを作成してください。

Step 2：activity_main.xml の実装

次に、res/layout/activity_main.xml に以下のコードを追加します。

<?xml version = "1.0" encoding = "utf-8"?>
<android.support.design.widget.CoordinatorLayout android:layout_width = "match_parent"
    android:layout_height = "match_parent"
    xmlns:android = "https://schemas.android.com/apk/res/android"
    xmlns:app = "https://schemas.android.com/apk/res-auto">
    <android.support.design.widget.AppBarLayout
        android:layout_width = "match_parent"
        android:layout_height = "wrap_content">
        <android.support.v7.widget.Toolbar
            android:id = "@+id/appbarlayout_tool_bar"
            android:background = "@color/colorPrimary"
            android:layout_width = "match_parent"
            android:layout_height = "?attr/actionBarSize"
            app:layout_scrollFlags = "scroll|snap|enterAlways"
            app:theme = "@style/ThemeOverlay.AppCompat.Dark.ActionBar"
            app:popupTheme = "@style/ThemeOverlay.AppCompat.Light" />
    </android.support.design.widget.AppBarLayout>
    <android.support.v7.widget.RecyclerView
        android:id = "@+id/recycler_view"
        android:layout_width = "match_parent"
        android:layout_height = "match_parent"
        app:layout_behavior = "@string/appbar_scrolling_view_behavior"/>
</android.support.design.widget.CoordinatorLayout>

コードのポイント

上記のレイアウトでは、CoordinatorLayout を親ビューとして、AppBarLayout（内部にToolbar）と RecyclerView を配置しています。

• app:layout_scrollFlags="scroll|snap|enterAlways"：スクロールに応じてToolbarが隠れたり表示されたりする挙動を制御します。enterAlways を指定すると、下方向へのスクロール開始時に即座にToolbarが再表示されます。
• app:layout_behavior="@string/appbar_scrolling_view_behavior"：RecyclerViewとAppBarLayoutを連携させるために必須の属性です。これにより、リストのスクロールイベントがAppBarLayoutに伝わります。

Step 3：MainActivity.java の実装

続いて、src/MainActivity.java に以下のコードを記述します。

import android.annotation.TargetApi;
import android.os.Build;
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.support.v7.widget.DefaultItemAnimator;
import android.support.v7.widget.DividerItemDecoration;
import android.support.v7.widget.LinearLayoutManager;
import android.support.v7.widget.RecyclerView;
import android.support.v7.widget.Toolbar;
import java.util.ArrayList;

public class MainActivity extends AppCompatActivity {
    private RecyclerView recyclerView;
    private customAdapter mAdapter;
    ArrayList<String> list = new ArrayList<>();
    @TargetApi(Build.VERSION_CODES.LOLLIPOP)
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        Toolbar toolbar = (android.support.v7.widget.Toolbar)findViewById(R.id.appbarlayout_tool_bar);
        toolbar.setTitle("This is toolbar.");
        setSupportActionBar(toolbar);
        recyclerView = (RecyclerView) findViewById(R.id.recycler_view);
        RecyclerView.LayoutManager mLayoutManager = new LinearLayoutManager(getApplicationContext());
        recyclerView.setLayoutManager(mLayoutManager);
        recyclerView.setItemAnimator(new DefaultItemAnimator());
        mAdapter = new customAdapter(this,list);
        recyclerView.setAdapter(mAdapter);
        recyclerView.addItemDecoration(new DividerItemDecoration(recyclerView.getContext(), DividerItemDecoration.VERTICAL));
        list.add("sairamm");
        list.add("Krishna");
        list.add("prasad");
        list.add("sairamm");
        list.add("Krishna");
        list.add("prasad");
        list.add("sairamm");
        list.add("Krishna");
        list.add("prasad");
        list.add("sairamm");
        list.add("Krishna");
        list.add("prasad");
        list.add("Krishna");
        list.add("prasad");
        list.add("sairamm");
        list.add("Krishna");
        list.add("prasad");
        list.add("sairamm");
        list.add("Krishna");
        list.add("prasad");
    }
}

ここでは、XMLで定義したToolbarを取得して setSupportActionBar() でアクションバーとして設定し、RecyclerViewにLinearLayoutManagerとカスタムアダプターをセットしています。また、DividerItemDecoration を使ってリスト項目間に区切り線を表示しています。

Step 4：Manifest.xml の設定

Manifest.xml に以下のコードを追加します。テーマには NoActionBar 系のスタイルを指定するのがポイントです。デフォルトのアクションバーが有効だと、独自のToolbarと重なってしまうためです。

<?xml version = "1.0" encoding = "utf-8"?>
<manifest xmlns:android = "https://schemas.android.com/apk/res/android"
    package = "com.example.myapplication">
    <uses-permission android:name = "android.permission.INTERNET" />
    <uses-permission android:name = "com.android.launcher.permission.INSTALL_SHORTCUT" />
    <application
        android:allowBackup = "true"
        android:theme = "@style/AppTheme.NoActionBar"
        android:icon = "@mipmap/ic_launcher"
        android:label = "@string/app_name"
        android:roundIcon = "@mipmap/ic_launcher_round"
        android:supportsRtl = "true">
        <activity
            android:name = ".MainActivity"
            android:configChanges = "keyboardHidden|orientation|screenSize">
            <intent-filter>
                <action android:name = "android.intent.action.MAIN" />
                <action android:name = "android.intent.action.CREATE_SHORTCUT" />
                <category android:name = "android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>
</manifest>

Step 5：customAdapter.java の作成

RecyclerViewにデータを表示するためのカスタムアダプターです。customAdapter.java として以下のコードを作成します。

import android.content.Context;
import android.support.annotation.NonNull;
import android.support.v7.widget.RecyclerView;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.TextView;
import java.util.ArrayList;

public class customAdapter extends RecyclerView.Adapter<customAdapter.MyViewHolder> {
    Context context;
    ArrayList<String> list;
    public class MyViewHolder extends RecyclerView.ViewHolder {
        public TextView title;
        public MyViewHolder(View view) {
            super(view);
            title = (TextView) view.findViewById(R.id.title);
        }
    }
    public customAdapter(Context context, ArrayList<String> list) {
        this.context = context;
        this.list = list;
    }
    @NonNull
    @Override
    public MyViewHolder onCreateViewHolder(@NonNull ViewGroup viewGroup, int i) {
        View itemView = LayoutInflater.from(viewGroup.getContext()).inflate(R.layout.list_row, viewGroup, false);
        return new MyViewHolder(itemView);
    }
    @Override
    public void onBindViewHolder(@NonNull MyViewHolder myViewHolder, int i) {
        myViewHolder.title.setText(list.get(i));
    }
    @Override
    public int getItemCount() {
        return list.size();
    }
}

Step 6：list_row.xml の作成

リストの各行のレイアウトを定義する list_row.xml を作成し、以下のコードを記述します。

<?xml version = "1.0" encoding = "utf-8"?>
<LinearLayout xmlns:android = "https://schemas.android.com/apk/res/android"
    android:orientation = "vertical" android:layout_width = "match_parent"
    android:layout_height = "wrap_content">
    <TextView
        android:id = "@+id/title"
        android:layout_width = "wrap_content"
        android:textSize = "30sp"
        android:layout_marginLeft = "10dp"
        android:layout_height = "wrap_content" />
</LinearLayout>

アプリを実行してみよう

それでは、アプリを実行してみましょう。実機のAndroidスマートフォンをPCに接続していることを確認してください。Android Studioでプロジェクトのアクティビティファイルを開き、ツールバーの「Run」アイコンをクリックします。接続した端末を選択して実行すると、以下のような初期画面が表示されます。

画面を下にスクロールするとToolbarが隠れ、上にスクロールするとすぐにToolbarが再表示されます。動作は以下のようになります。

まとめ

AppBarLayoutとCoordinatorLayout、RecyclerViewを組み合わせることで、Material Designらしい自然なスクロール連動UIを簡単に実装できました。特に layout_scrollFlags の指定方法を変えることで、「scroll」「enterAlways」「enterAlwaysCollapsed」「exitUntilCollapsed」「snap」といった多彩な挙動を制御できるので、ぜひいろいろ試してみてください。