【Flutter】画面の最下部をスクロールした時に、新たにデータを５件表示させたい（NotificationListener）

1. NotificationListenerとは

・何らかの通知をリッスンすることができるクラス
・今回の場合は、ユーザーが画面をスクロールしたことをリッスンする
https://api.flutter.dev/flutter/widgets/NotificationListener-class.html

2. 今回のゴール

画面を下スクロールした際に、動物の名前を１つずつ追加で表示していきます。

3. まずは、動物の名前をリストで表示しよう

まず初めに、下記の３つのフィールドを追加してみよう。
次に、initState（）にてdisplayListにanimalListの最初の要素を追加し、lastIndexをインクリメントしよう。

　　　　// 動物の名前を保持しているリスト
　　　　List<String> animalList = ['dog', 'cat', 'elephant', 'rabbit'];
  // 実際に画面に表示するリスト
  List<String> displayList = [];
  // 次に追加したいanimalListの要素におけるインデックス
  int lastIndex = 0;

  @override
  void initState() {
    // animalListの最初の要素を追加
    displayList.add(animalList[lastIndex]);
    // 次の要素を追加するためにインクリメント
    lastIndex++;
    super.initState();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: ListView.builder(
        itemCount: displayList.length,
        itemBuilder: (BuildContext context, int index) {
          return Text(displayList[index]);
        },
      ),
    );
  }

4. NotificationListenerで囲ってみよう

ListView()をNotificationListenerで囲ってみよう。
<>にScrollNotificationが記載されていますが、これはスクロールした時にリッスンして欲しいという意味です。
スクロールした際にonNotificationに記載した処理が実行されます。
今回は、最下部までスクロールした場合にanimalListの要素をdisplayListに追加し、lastIndexをインクリメントします。
そして、setState()によって再描画されます。
return trueの場合は、処理が実行された場合です。
逆に、return falseの場合は、処理が実行されていない場合です。

@override
  Widget build(BuildContext context) {
    return Scaffold(
      body: NotificationListener<ScrollNotification>(
        onNotification: (ScrollNotification scrollNotification) {
          if (scrollNotification is ScrollEndNotification) {
            final before = scrollNotification.metrics.extentBefore;
            final max = scrollNotification.metrics.maxScrollExtent;
            if (before == max) {
              if (animalList.length == lastIndex) return false;
              setState(() {
                displayList.add(animalList[lastIndex]);
                lastIndex++;
              });
              return true;
            }
          }
          return false;
        },
        child: ListView.builder(
          itemCount: displayList.length,
          itemBuilder: (BuildContext context, int index) {
            return Text(displayList[index]);
          },
        ),
      ),
    );
  }

5. ソースコードの全体像

https://github.com/John-Thailand/notification_listener_sample
main.dart

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 MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(),
    );
  }
}

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

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  List<String> animalList = ['dog', 'cat', 'elephant', 'rabbit'];
  List<String> displayList = [];
  int lastIndex = 0;

  @override
  void initState() {
    displayList.add(animalList[lastIndex]);
    lastIndex++;
    super.initState();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: NotificationListener<ScrollNotification>(
        onNotification: (ScrollNotification scrollNotification) {
          if (scrollNotification is ScrollEndNotification) {
            final before = scrollNotification.metrics.extentBefore;
            final max = scrollNotification.metrics.maxScrollExtent;
            if (before == max) {
              if (animalList.length == lastIndex) return false;
              setState(() {
                displayList.add(animalList[lastIndex]);
                lastIndex++;
              });
              return true;
            }
          }
          return false;
        },
        child: ListView.builder(
          itemCount: displayList.length,
          itemBuilder: (BuildContext context, int index) {
            return Text(displayList[index]);
          },
        ),
      ),
    );
  }
}