Zenn
📝

[Flutter]ProviderとStatefulWidgetの違いについての個人的まとめ

2022/09/08に公開
Flutter
Dart
tech

前提：状態管理とは

  • 変数や画面に変更があった際にそれを検知する仕組み。

StatefulWidgetの確認

  • 状態を管理するStateクラスを持つ
  • setState()を呼ぶことで変数が更新され、再buildされる
  • 再描画範囲はそのsetState()を持つクラス。ここでは_MyHomePageStateクラス。
  • StatefulWidgetで定義した変数にアクセスしたい場合は、widget.変数名とすることで可能

Sample code(デフォルトカウンターアプリ)

main.dart
import 'package:flutter/material.dart';

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headline4,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: Icon(Icons.add),
      ), 
    );
  }
}

代わりにProviderを使うとどうなる？(StatelessWidgetを使う)

  1. 変更を検知する_incrementCounter()メソッドをclass CounterStore with ChangeNotifierの中に一旦入れる(ChangeNotifierクラスをMix-inした)。
    また、notifyListeners();はsetState()と同じ感じで、変更を読み取る

  2. create: (context) => CounterStore(),の部分を記述することで、class CounterStore with ChangeNotifierを使える。

  3. ScaffoldをChangeNotifierProviderでラップ(Providerを使うための決まり文句)

  4. final store = Provider.of<CounterStore>(context);でCounterStoreのインスタンスを作成し、final _counter = store._counter;で変数を取得。

  5. CounterStoreのインスタンスであるstore(オブジェクト)のメソッドを取り出した！

  6. Consumer()で囲んだ範囲だけが再描画されるので無駄な再描画を避けれる

main.dart
import 'package:flutter/material.dart';
import 'package:provider/provider.dart';  // 変更箇所 Providerを使うためのimport

// 変更箇所
class CounterStore with ChangeNotifier {
  //①：class CounterStore with ChangeNotifierの中に一旦入れる
  int _counter = 0;
  //①：変更を検知する_incrementCounter()メソッドを
  void _incrementCounter() {   
    _counter++;
    notifyListeners();//setstate()とほぼ同義
    //もしnotifyListeners()が無く、_counter++;だけの記述の場合、
    //内部的な数値は増加するが、その値の変更による画面の再描画はされないので
    //_counterの値は画面上では不変。
  }
}

class MyHomePage extends StatelessWidget {
  MyHomePage({Key key, this.title}) : super(key: key);
  final String title;

  @override
  Widget build(BuildContext context) {
   // ③：Scaffoldを`ChangeNotifierProvider`でラップ(Providerを使うための決まり文句)
    return ChangeNotifierProvider(
      //②　create: (context) => CounterStore(),の部分を記述することで
      //   class CounterStore with ChangeNotifierが有効になる。
        create: (context) => CounterStore(),
        child: Consumer(builder: (BuildContext context) {
          //Builder()よりConsumer()の方が良いっぽい。？
          //⑥：Consumer()ウィジェットで囲った部分だけが再描画されるので
          //無駄な再描画を避けれる！
          final store = Provider.of<CounterStore>(context);
          //④：CounterStoreのインスタンスを作成しstore(オブジェクト)にぶち込む。
          final _counter = store._counter;
          //storeにぶち込んだ中から変数(_counter)を取得し、_counterに再代入。
          //(オブジェクト指向的にいうと、「同じ場所を参照する」って意味かな)。
          return Scaffold(
            appBar: AppBar(
              title: Text(title),  //widget.title → title
            ),
            body: Center(
              child: Column(
                mainAxisAlignment: MainAxisAlignment.center,
                children: <Widget>[
                  Text(
                    'You have pushed the button this many times:',
                  ),
                  Text(
                    '$_counter',
                    style: Theme.of(context).textTheme.headline4,
                  ),
                ],
              ),
            ),
            floatingActionButton: FloatingActionButton(
              onPressed: store._incrementCounter,  
              // ⑤：storeオブジェクトに詰め込んだ_incrementCounterメソッドを引っ張ってくる！
              tooltip: 'Increment',
              child: Icon(Icons.add),
            ),
          );
        }));
  }
}

参考記事
参考記事
参考記事

StatefulWidgetとの違いとProvioderの利点

  1. Providerにすると、UIを表示するファイル(View)と裏側のロジックを管理するファイル(model)に分けたファイル構成が可能。MVVM設計。つまり役割の棲み分けが自然にできて可読性とメンテナンス性が向上。


  1. 無駄な再描画を減らせる

    • statefulWidget：画面の小さな状態変化でも画面全てのWidgetを１から上から順に更新する

      • 細かく言うと、setStateメソッドを使用するとそのclass内にあるbuild関数以内全てのWidgetを再描画する。無駄な再描画が増える可能性がある。
      • そのクラス内でUIを構築する処理と状態管理する処理を記述する必要があり、各画面で状態を共有したい場合には向いていない。

    • Provider：再描画したい範囲を自分で絞って指定することができ、無駄な再描画を削減できる。

      • 再描画したい箇所だけConsumer()で囲み、notifyListeners()で再描画される


以上です。間違えが見つかり次第、或いは知識がアップデートされ次第改訂していきます。🙏

個人的にはやっぱりWidget状態はStatelessで、状態変化はProvider,RiverPodで行う。という線引きをしようと思った。

また再描画範囲のラップをConsumer()でしたけど、他にBuilder()とかで包むのも大丈夫なのか？と思ったから調査要

GitHubで編集を提案

Discussion