RecyclerViewのスクロール位置を保持して表示する

こんにちは、まっさん(@Tera_Msaki)です。

この記事はAndroidスマホ用のアプリ開発の中で、
今後の開発で再使用性が高いと思われるコーディングをまとめたものです。
Javaでの開発経験、XML構文規則、Androidのアプリ開発経験がある方を対象としています。
Androidのアプリ開発でお役にたててれば、嬉しいです。
（これからAndroidのアプリ開発やJavaでの開発を始めたい方への案内は、記事の最後で紹介します）

リンク

これはイイ、、、
USB電源が足りなくて、
困っている人におすすめ♪

◎テーマ
スクロール位置を保持した状態でRecyclerViewを再表示する。

◎ポイント

Andoridアプリの開発で、
リスト表示する場合に、RecyclerViewを使用することが多いと思います。
アイテムの削除や画面遷移などで RecyclerView を再表示させた場合、
スクロール位置がリセットされます。
開発者からすると当たり前の動作ですが、
削除や画面遷移の度にスクロール位置がリセットされると、
操作性が著しく低下します。
スクロール位置を保持して状態で、RecyclerViewを再表示する仕組みを実装します。

◎スクロール位置を取得する

RecyclerView（motionView）の setOnItemClickListener で
アイテムの選択（タップ）をフックし、
LinearLayoutManagerの findFirstVisibleItemPosition を使用して、
リスト表示している一番上のアイテムの位置を取得します。

    private int                         motionPos = 0;
    :
        motionView.setOnItemClickListener((view, position) -> {
            // スクロール位置取得
            LinearLayoutManager layoutManager = (LinearLayoutManager) motionView.getLayoutManager();
            if (layoutManager != null)
                motionPos = layoutManager.findFirstVisibleItemPosition();
            else
                motionPos = 0;
    :

◎スクロール位置を保持した状態で、RecyclerViewを表示する

scrollToPositionWithOffset を使用して、RecyclerView をスクロールさせます。

        :
        LinearLayoutManager layoutManager = (LinearLayoutManager) motionView.getLayoutManager();
        if (layoutManager != null)
            layoutManager.scrollToPositionWithOffset(motionPos, 0);
        :

◎Activity間で画面遷移する場合

スクロール位置を Bundle にセットして、保持します。

    :
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        //Bundle取得
        Intent intent = getIntent();
        if (intent.getExtras() != null) {
            RestoreCondition(intent.getExtras());
        }
    :

    @Override
    protected void onSaveInstanceState(@NonNull Bundle outState) {
        SaveCondition(outState);
        super.onSaveInstanceState(outState);
    }
    @Override
    protected void onRestoreInstanceState(Bundle savedInstanceState) {
        if (DEBUG) Log.d(TAG, "onRestoreInstanceState");
        RestoreCondition(savedInstanceState);
    }
    :

    // Bundle操作 //
    private Bundle SaveCondition(Bundle bundle) {
        :
        bundle.putString("motionPos",String.valueOf(motionPos));
        return bundle;
    }
    private void RestoreCondition(Bundle bundle) {
        :
        motionPos = Integer.parseInt(bundle.getString("motionPos"));
    }

◎これからAndroidのアプリ開発やJavaでの開発を始めたい方へ

初めてのAndroidのアプリ開発では、アプリケーション開発経験がない方や、
アプリケーション開発経験がある方でも、JavaやC#などのオブジェクト指向言語が初めての方は、
書籍などによる独学ではアプリ開発できるようになるには、
かなりの時間がかかりますので、オンラインスクールでの習得をおススメします。