【Android開発】RecyclerViewでGridLayoutManagerを使ってグリッド表示を実装する方法

このチュートリアルでは、Androidアプリ開発におけるRecyclerViewでGridLayoutManagerを使用し、アイテムを2列のグリッド形式で表示する方法を、実際のサンプルコードとともにステップごとに詳しく解説します。

ステップ1：新規プロジェクトの作成

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

ステップ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で囲み、上部にToolbarを含むAppBarLayout、その下にRecyclerViewを配置しています。これにより、スクロールに連動したツールバーの表示・非表示も自然に制御できます。

ステップ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.GridLayoutManager;
import android.support.v7.widget.RecyclerView;
import android.support.v7.widget.Toolbar;
import android.widget.Toast;
import java.util.ArrayList;

public class MainActivity extends AppCompatActivity {
    ArrayList<String> list = new ArrayList<>();
    private RecyclerView recyclerView;
    private customAdapter mAdapter;
    private onClickInterface onclickInterface;
    @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);
        onclickInterface = new onClickInterface() {
        @Override
        public void setClick(int abc) {
            list.remove(abc);
            Toast.makeText(MainActivity.this,"Position is"+abc,Toast.LENGTH_LONG).show();
            mAdapter.notifyDataSetChanged();
        }
    };
    recyclerView = (RecyclerView) findViewById(R.id.recycler_view);
    GridLayoutManager mLayoutManager = new GridLayoutManager(getApplicationContext(),2);
    recyclerView.setLayoutManager(mLayoutManager);
    recyclerView.setItemAnimator(new DefaultItemAnimator());
    mAdapter = new customAdapter(this, list, onclickInterface);
    recyclerView.setAdapter(mAdapter);
    DividerItemDecoration dividerItemDecoration = new DividerItemDecoration(recyclerView.getContext(), DividerItemDecoration.HORIZONTAL);
    recyclerView.addItemDecoration(dividerItemDecoration);
    list.add("sairamm");
    list.add("Krishna");
    list.add("prasad");
    list.add("sairamm");
    list.add("Krishna");
    list.add("prasad");
    list.add("sairamm");

ここでの重要なポイントは次の行です。

GridLayoutManager mLayoutManager = new GridLayoutManager(getApplicationContext(), 2);

第2引数の「2」が列数を表しており、この指定によりRecyclerViewが2列のグリッド表示になります。また、クリックされたアイテムをリストから削除し、Toastで位置情報を表示するインターフェースも実装しています。DividerItemDecorationを追加することで、アイテム間に区切り線が描画されます。

ステップ4：カスタムアダプター（customAdapter.java）の作成

src/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;
    onClickInterface onClickInterface;
    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, onClickInterface onClickInterface) {
        this.context = context;
        this.list = list;
        this.onClickInterface = onClickInterface;
    }
    @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, final int i) {
        myViewHolder.title.setText(list.get(i));
        myViewHolder.title.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                onClickInterface.setClick(i);
            }
        });
    }
    @Override
    public int getItemCount() {
        return list.size();
    }
}

このアダプターでは、onCreateViewHolder()で行レイアウト（list_row.xml）を inflate し、onBindViewHolder()で各アイテムにテキストをセットしています。同時にクリックリスナーを設定し、タップされたアイテムの位置をActivity側へ通知します。

ステップ5：行レイアウト（list_row.xml）の作成

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

<?xml version = "1.0" encoding = "utf-8"?>
<android.support.v7.widget.CardView xmlns:android = "https://schemas.android.com/apk/res/android"
    xmlns:app = "https://schemas.android.com/apk/res-auto"
    xmlns:tools = "https://schemas.android.com/tools"
    android:layout_width = "match_parent"
    android:layout_height = "wrap_content"
    app:cardElevation = "10dp"
    app:cardCornerRadius = "20dp"
    tools:context = ".MainActivity">
    <LinearLayout
        android:layout_width = "match_parent"
        android:layout_height = "wrap_content"
        android:gravity = "center"
        android:orientation = "vertical">
        <ImageView
            android:id = "@+id/imageView2"
            android:layout_width = "wrap_content"
            android:layout_height = "wrap_content"
            android:src = "@drawable/logo" />
        <TextView
            android:id = "@+id/title"
            android:layout_width = "match_parent"
            android:layout_height = "wrap_content"
            android:gravity = "center"
            android:textSize = "30sp" />
        <TextView
            android:id = "@+id/textview2"
            android:layout_width = "match_parent"
            android:layout_height = "wrap_content"
            android:gravity = "center"
            android:text = "Sairamkrishan"
            android:textSize = "30sp" />
    </LinearLayout>
</android.support.v7.widget.CardView>

各行はCardViewで構成されており、角丸（20dp）と影（10dp）を設定したカード型のデザインになっています。内部にはImageViewと2つのTextViewを縦方向に配置しました。

ステップ6：クリックイベント用インターフェース（onClickInterface.java）の作成

src/onClickInterface.java に以下のコードを追加します。

public interface onClickInterface {
    void setClick(int abc);
}

このシンプルなインターフェースを介して、アダプター側のクリックイベントをMainActivityに受け渡します。

アプリの実行

それでは、アプリケーションを実行してみましょう。実機のAndroidスマートフォンをパソコンに接続しているものとして説明を進めます。Android Studioからアプリを実行するには、プロジェクト内のいずれかのアクティビティファイルを開き、ツールバーの実行（Run）アイコンをクリックします。接続済みのデバイスを選択すると、端末に以下のようなグリッド表示の画面が表示されます。

補足：AndroidXへの移行について

本記事のコードは旧サポートライブラリ（android.support.*）を使用していますが、現在のAndroid StudioではAndroidX（androidx.recyclerview.widget.RecyclerView など）が標準となっています。既存プロジェクトを流用する場合は、メニューの「Refactor」→「Migrate to AndroidX」から簡単に移行できるため、新規開発ではAndroidXの利用を推奨します。