【Flutter】 無限スクロール の実装方法

無限スクロール Flutter

Flutterで 無限スクロール を実装したいけれど、どうすればいいのだろう?

そんな悩みにお答えするのが本記事です。

本記事ではリストビューが下端に行った時に自動でデータを読み取り、表示する、
無限スクロールの実装方法について解説します。

本記事を読めば、以下のgifのような無限スクロールが実装可能となります。

無限スクロールの実装方法は色々とありますが、
今回はScrollControllerを使った方法を解説します。

ぜひ読んでみてください!

準備

まずは無限スクロールできないリストビューのサンプルコードを紹介します。

このコードを改造して無限スクロールができるようにします。

サンプルコードの後に、このコードの解説を行います。

サンプルコード

import 'package:flutter/material.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      home: InfinityScrollPage(),
    );
  }
}

class InfinityScrollPage extends StatefulWidget {
  const InfinityScrollPage({Key? key}) : super(key: key);

  @override
  State<InfinityScrollPage> createState() => _InfinityScrollPageState();
}

class _InfinityScrollPageState extends State<InfinityScrollPage> {
  final List<String> _contents = [];
  final int loadLength = 30;

  int _lastIndex = 0;

  //1
  Future<void> _getContents() async {
    await Future.delayed(const Duration(seconds: 3));
    for (int i = _lastIndex; i < _lastIndex + loadLength; i++) {
      _contents.add('Item $i');
    }
    _lastIndex += loadLength;
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Infinity Scroll Sample')),
      body: Center(
        //2
        child: FutureBuilder(
          future: _getContents(),
          builder: (BuildContext context, AsyncSnapshot snapshot) {
            if (snapshot.connectionState == ConnectionState.waiting) {
              return const CircularProgressIndicator();
            }
            if (snapshot.hasError) {
              return Text('${snapshot.error}');
            }
            //3
            return ListView.separated(
              itemCount: _contents.length,
              separatorBuilder: (BuildContext context, int index) => Container(
                width: double.infinity,
                height: 2,
                color: Colors.grey,
              ),
              itemBuilder: (BuildContext context, int index) {
                return SizedBox(
                  height: 50,
                  child: Center(
                    child: Text(
                      _contents[index],
                    ),
                  ),
                );
              },
            );
          },
        ),
      ),
    );
  }
}

解説

サンプルコードの特徴的な部分を解説します。

  //1
  Future<void> _getContents() async {
    await Future.delayed(const Duration(seconds: 3));
    for (int i = _lastIndex; i < _lastIndex + loadLength; i++) {
      _contents.add('Item $i');
    }
    _lastIndex += loadLength;
  }

//1
データ読み取りの関数です。
FirebaseやAPI等、外部からのデータ取得を想定して、非同期関数として設定しています。
現在のインデックス(初期値は0)から、
読み込むデータ数(30)までデータを_contentに追加する、
という関数となっています。

非同期処理についてはこちらをご覧ください。

        //2
        child: FutureBuilder(
          future: _getContents(),
          builder: (BuildContext context, AsyncSnapshot snapshot) {
            if (snapshot.connectionState == ConnectionState.waiting) {
              return const CircularProgressIndicator();
            }
            if (snapshot.hasError) {
              return Text('${snapshot.error}');
            }
// ・・・

//2
非同期関数でデータの取得を行い、その結果を使って画面表示するため、
FutureBuilderにて記述します。
futureに先ほど定義したデータ取得の関数を設定します。
snapshot.connectionState == ConnectionState.waitingtrueの時は
データ取得中であることを意味します。
データ取得中はCircularProgressIndicatorを表示します。
データ取得後、エラーの際は、(snapshot.hasErrortrueの際は)
エラー内容を表示します。

            //3
            return ListView.separated(
              itemCount: _contents.length,
              separatorBuilder: (BuildContext context, int index) => Container(
                width: double.infinity,
                height: 2,
                color: Colors.grey,
              ),
              itemBuilder: (BuildContext context, int index) {
                return SizedBox(
                  height: 50,
                  child: Center(
                    child: Text(
                      _contents[index],
                    ),
                  ),
                );
              },
            );

//3
リスト部分は、ListView.seperatedを使用します。
separatorBuilderでアイテムの間にどんなWidgetを表示させるか設定可能です。
今回はシンプルに高さ2、グレーの線を表示させています。
itemBuilderでは、読み取ったデータの配列_contentから、データを表示しています。

無限スクロール の実装

ここから、無限スクロールの実装に入ります。
準備と同様、コードの紹介の後、解説を行います。
ちょっと複雑な部分がありますが、解説しますのでぜひ読んでみてください。

実装コード

import 'package:flutter/material.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      home: InfinityScrollPage(),
    );
  }
}

class InfinityScrollPage extends StatefulWidget {
  const InfinityScrollPage({Key? key}) : super(key: key);

  @override
  State<InfinityScrollPage> createState() => _InfinityScrollPageState();
}

class _InfinityScrollPageState extends State<InfinityScrollPage> {
  final List<String> _contents = [];
  final int loadLength = 30;

  int _lastIndex = 0;

  Future<void> _getContents() async {
    await Future.delayed(const Duration(seconds: 3));

    for (int i = _lastIndex; i < _lastIndex + loadLength; i++) {
      _contents.add('Item $i');
    }

    _lastIndex += loadLength;
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Infinity Scroll Sample')),
      body: Center(
        child: FutureBuilder(
          future: _getContents(),
          builder: (BuildContext context, AsyncSnapshot snapshot) {
            if (snapshot.connectionState == ConnectionState.waiting) {
              return const CircularProgressIndicator();
            }
            if (snapshot.hasError) {
              return Text('${snapshot.error}');
            }
            //4
            return InfinityListView(
              contents: _contents,
              getContents: _getContents,
            );
          },
        ),
      ),
    );
  }
}

class InfinityListView extends StatefulWidget {
  final List<String> contents;
  final Future<void> Function() getContents;

  const InfinityListView({
    Key? key,
    required this.contents,
    required this.getContents,
  }) : super(key: key);

  @override
  State<InfinityListView> createState() => _InfinityListViewState();
}

class _InfinityListViewState extends State<InfinityListView> {
  //5
  late ScrollController _scrollController;
  //6
  bool _isLoading = false;

  //7
  @override
  void initState() {
    _scrollController = ScrollController();
    _scrollController.addListener(() async {
      if (_scrollController.position.pixels >=
              _scrollController.position.maxScrollExtent * 0.95 &&
          !_isLoading) {
        _isLoading = true;

        await widget.getContents();

        setState(() {
          _isLoading = false;
        });
      }
    });
    super.initState();
  }
  //8
  @override
  void dispose() {
    _scrollController.dispose();
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return ListView.separated(
      //9
      controller: _scrollController,
      //10
      itemCount: widget.contents.length + 1,
      separatorBuilder: (BuildContext context, int index) => Container(
        width: double.infinity,
        height: 2,
        color: Colors.grey,
      ),
      itemBuilder: (BuildContext context, int index) {
        //11
        if (widget.contents.length == index) {
          return const SizedBox(
            height: 50,
            width: 50,
            child: Center(
              child: CircularProgressIndicator(),
            ),
          );
        }
        return SizedBox(
          height: 50,
          child: Center(
            child: Text(
              widget.contents[index],
            ),
          ),
        );
      },
    );
  }
}

解説

実装コードを詳細に解説していきます。

            //4
            return InfinityListView(
              contents: _contents,
              getContents: _getContents,
            );

//4
InfinityListViewという新たなWidgetを自作し、ListViewがあった場所に配置しています。
親から表示する_contents と、_getContentsを取得し、
無限スクロール可能なListViewを表示します。

※本筋から若干外れる応用的な内容のため、
本筋を読みたい方は以下の文は飛ばしてください。

ここで新たなWidgetでListViewを分けている理由は描画パフォーマンスのためです。
分けなくても無限スクロール自体は実装可能です。
無限スクロールで新たなデータを読み取る際に、setStateを行う必要があります。
新たなWidgetで分けない場合、FutureBuildersetStateにてリビルドされてしまうため、
ListViewの再構築が行われ、結果としてリストの末尾に到達するたび、
既にあるリストが一度白紙になって表示される、ということが起きます。
これの防御策として、setStateの範囲を絞るために、
ListViewを新たなWidgetで置き換えています。

  //5
  late ScrollController _scrollController;

//5
ScrollControllerの定義部分です。
このScrollControllerを用いて、スクロールが終端に行ったことを検知し、
データの再取得の処理を行います。

  //6
  bool _isLoading = false;

//6
データ取得状況を管理するフラグです。
データ取得中に再度データ取得処理が走らないよう、このフラグで管理します。

  //7
  @override
  void initState() {
    _scrollController = ScrollController();
    _scrollController.addListener(() async {
      if (_scrollController.position.pixels >=
              _scrollController.position.maxScrollExtent * 0.95 &&
          !_isLoading) {
        _isLoading = true;

        await widget.getContents();

        setState(() {
          _isLoading = false;
        });
      }
    });
    super.initState();
  }

//7
ここが無限スクロールのキモとなる部分です。
scrollControllerの初期化と、リスナーの登録を行なっている部分です。
_scrollController.addListenerにてスクロール状態を監視するリスナーを登録します。
_scrollController.position.pixelsは現在のスクロールの位置を、
_scrollController.position.maxScrollExtent は最大スクロール位置を表します。
よって、if文は、「現在のスクロール位置が、最大スクロールの0.95の位置を超えた時(かつ読み込み中でない時)」を表します。
実行文は、データ読み込みしているかしていないかを_isLoadingで管理し、
親Widgetから受け取ったデータ読み込み関数、getContentsでデータ読み込みをする、
という内容になっています。
最後に、データ取得内容を反映するためにsetStateを行なっています。

  //8
  @override
  void dispose() {
    _scrollController.dispose();
    super.dispose();
  }

//8
ScrollControllerdisposeしている部分です。

      //9
      controller: _scrollController,

//9
ListViewに上で定義したScrollControllerを設定します。

      //10
      itemCount: widget.contents.length + 1,
//・・・
        //11
        if (widget.contents.length == index) {
          return const SizedBox(
            height: 50,
            width: 50,
            child: Center(
              child: CircularProgressIndicator(),
            ),
          );
        }

//10,11
itemCountの値をデータ長+1しています。
これは、リストが終端に行った際に、現在読み込んでるデータ+1番目の要素として、CircularProgressIndicatorを表示するためです。

以上が実装コードの解説となります。
本記事で紹介した実装コードのDartPadは以下となります。
実際に触ってみて、挙動を確かめて見てください。

DartPad

まとめ

本記事ではリストビューが下端に行った時に自動でデータを読み取り、表示する、
無限スクロールの実装方法について解説しました。

実装方法としてScrollControllerを使った方法を解説しました。

少し複雑に思われるかと思いますが、
一つ一つ理解していけば、必ず実装できます。

本記事があなたのアプリ開発の一助となれば幸いです。

参考

編集後記(2022/3/30)

無限スクロールの実装方法についての記事でした。

無限スクロールはTwitter風のSNSなど、色々なところで使えるテクニックかと思います。

今回は特別なパッケージを使うことなく、Stateful Widgetで記述しました。
各々の環境に合わせて、状態管理手法等で応用していただければ良いと思います。

また、本記事ではコード紹介の方法を少し今までと変えてみました。
いかがだったでしょうか?

読みやすくなっていれば嬉しいです。

今後も改良を重ねていきますので、引き続きご愛読のほど、よろしくお願い致します。

週刊Flutter大学では、Flutterに関する技術記事、Flutter大学についての紹介記事を投稿していきます。
記事の更新情報はFlutter大学Twitterにて告知します。
ぜひぜひフォローをお願いいたします

タイトルとURLをコピーしました