【Flutter】RiverpodでProviderScopeのoverrideをどう使うか

image

最近はFlutterの状態管理でRiverpodを使用しています。 その中でProviderScopeのoverrideが便利なので使い所を解説します。

この記事では、riverpod 1.0.0-dev.7を使用しています。

RiverpodのProviderFamilyについて

Riverpodを商品詳細のようなIDで内容が変わるページで使用した際、providerにIDを渡す必要があります。その際、よくあるパターンとしてProviderのFamilyを使用して以下の様に対応します。
detailPageProviderFamily(id)

特に以下のサンプルのような、詳細画面から詳細画面にpush遷移できるような場合では、Familyをほぼ必ず使用する必要があります。(Familyを使用しないと元の画面のproviderが引き継がれ、元の画面の状態にも影響を及ぼしてしまうため)

sample

View側

class DetailPage extends StatelessWidget {
  const DetailPage({Key? key, required this.id}) : super(key: key);

  final int id;

  
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text('詳細ページ')),
      body: Column(children: [
        Consumer(builder: (context, ref, child) {
          final name = ref.watch(detailPageProviderFamily(id).select((s) => s.name));
          return Text(name, style: TextStyle(fontSize: 30));
        }),
        Consumer(builder: (context, ref, child) {
          final description = ref.watch(detailPageProviderFamily(id).select((s) => s.description));
          return Text(description, style: TextStyle(fontSize: 14));
        }),
        Row(mainAxisAlignment: MainAxisAlignment.spaceAround, children: [
          for (var i = 1; i <= 5; i++)
            ElevatedButton(onPressed: () {
              Navigator.of(context).push(MaterialPageRoute(
                builder: (_) => DetailPage(id: i),
              ));
            }, child: Text('商品${i}'))
        ]),
        Consumer(builder: (context, ref, child) {
          return Container(
            margin: EdgeInsets.only(top: 100),
            width: 200,
            child: ElevatedButton(
              onPressed: ref.read(detailPageProviderFamily(id).notifier).onPurchase,
              child: Text('購入'),
            ),
          );
        }),
      ]),
    );
  }
}

Controller(Provider)側

import 'package:freezed_annotation/freezed_annotation.dart';
import 'package:riverpod/riverpod.dart';
import 'package:state_notifier/state_notifier.dart';

part 'detail_page_controller.freezed.dart';


class DetailPageState with _$DetailPageState {
  const factory DetailPageState({
    ('') String name,
    ('') String description,
  }) = _DetailPageState;
}

final detailPageProviderFamily = StateNotifierProvider.family
    .autoDispose<DetailPageController, DetailPageState, int>(
        (ref, id) {
  return DetailPageController(id: id);
});

class DetailPageController extends StateNotifier<DetailPageState> {
  DetailPageController({required int id})
      : _id = id,
        super(const DetailPageState()) {
    _init();
  }

  final int _id;

  Future<void> _init() async {
    state = state.copyWith(name: 'ID$_idの商品名', description: 'ID$_idの商品説明');
  }

  Future<void> onPurchase() async {
    // 商品の購入
  }
}

毎回IDを渡すのが大変

この実装をした時、Controller側を呼び出す度に、Providerに毎回IDを渡す必要が出てきて、非常に大変な実装となり不便です...

ProviderScopeのoverrideを使う

ここで、ProviderScopeのoverrideを使うと以下の様になります。

View側

class DetailPage extends StatelessWidget {
  const DetailPage({Key? key, required this.id}) : super(key: key);

  final int id;

  
  Widget build(BuildContext context) {
return ProviderScope(
overrides: [
detailPageProvider.overrideWithProvider(detailPageProviderFamily(id))
],
child: Scaffold( appBar: AppBar(title: Text('詳細ページ')), body: Column(children: [ Consumer(builder: (context, ref, child) {
final name = ref.watch(detailPageProvider.select((s) => s.name));
return Text(name, style: TextStyle(fontSize: 30)); }), Consumer(builder: (context, ref, child) {
final description = ref.watch(detailPageProvider.select((s) => s.description));
return Text(description, style: TextStyle(fontSize: 14)); }), Row(mainAxisAlignment: MainAxisAlignment.spaceAround, children: [ for (var i = 1; i <= 5; i++) ElevatedButton(onPressed: () { Navigator.of(context).push(MaterialPageRoute( builder: (_) => DetailPage(id: i), )); }, child: Text('商品${i}')) ]), Consumer(builder: (context, ref, child) { return Container( margin: EdgeInsets.only(top: 100), width: 200, child: ElevatedButton(
onPressed: ref.read(detailPageProvider.notifier).onPurchase,
child: Text('購入'), ), ); }), ]), ), ); } }

Controller(Provider)側

import 'package:freezed_annotation/freezed_annotation.dart';
import 'package:riverpod/riverpod.dart';
import 'package:state_notifier/state_notifier.dart';

part 'detail_page_controller.freezed.dart';


class DetailPageState with _$DetailPageState {
  const factory DetailPageState({
    ('') String name,
    ('') String description,
  }) = _DetailPageState;
}

final detailPageProvider =
StateNotifierProvider.autoDispose<DetailPageController, DetailPageState>(
(ref) => throw UnimplementedError());
final detailPageProviderFamily = StateNotifierProvider.family .autoDispose<DetailPageController, DetailPageState, int>( (ref, id) { return DetailPageController(id: id); }); class DetailPageController extends StateNotifier<DetailPageState> { DetailPageController({required int id}) : _id = id, super(const DetailPageState()) { _init(); } final int _id; Future<void> _init() async { state = state.copyWith(name: 'ID$_idの商品名', description: 'ID$_idの商品説明'); } void onPurchase() { // 商品の購入 } }

呼び出しが簡単に

ProviderScopeのoverrideを使用することで、それ以下のWidgetではFamilyにIDを渡して呼び出す必要が無くなり、detailPageProviderの形で呼び出せるようになりました。

まとめ

Riverpodがバージョン1になり、進化した部分の一つとして、ProviderScopeが非常に便利になりました。
今回のサンプルではシンプルな画面なのでメリットが少なく感じますが、画面のコンテンツや状態やアクションが増えたとき、毎回IDを渡すというような実装は非常に苦しい実装になってしまいます。
Riverpodを使用する際はぜひこちらの記事を参考にしてみてください!

お知らせ

3月19日開催のアプリ開発講座の参加者募集中!!

3月19日開催のアプリ開発講座の参加者募集中!!

3月19日にアプリ開発講座を開催します!会場は岐阜県美濃加茂市のコワーキングスペース「こやぁね」です。興味のある方は是非ご参加ください!

Read More
可茂IT塾ではFlutterインターンを募集しています!

可茂IT塾ではFlutterインターンを募集しています!

可茂IT塾ではFlutterインターンを募集しています!可茂IT塾のエンジニアの判断で、一定以上のスキルをを習得した方には有給でのインターンも受け入れています。

Read More

タグ

Flutter (70)初心者向け (22)イベント (15)Nextjs (8)Google Apps Script (7)可茂IT塾 (6)Firebase (6)React (5)新卒 (3)就活 (3)給与支払報告書 (3)riverpod (3)Dart (3)JavaScript (3)TypeScript (3)インターン (3)FlutterWeb (2)画像 (2)アプリ開発 (2)React Hooks (2)tailwindcss (2)ワーケーション (2)社会人 (2)大学生 (2)お知らせ (2)webfeed (1)RSS (1)CodeRunner (1)VSCode (1)個人開発 (1)設計 (1)フルリモート (1)学生向け (1)Java (1)Spring Boot (1)エンジニア (1)DeviceOrientation (1)正規表現 (1)神楽 (1)趣味紹介 (1)プログラミングだけではない可茂IT塾のメンバー (1)線型計画法 (1)事例 (1)PreferredSize (1)マテリアルデザイン (1)Material (1)クパチーノデザイン (1)Cupertino (1)ListView (1)就活浪人 (1)既卒 (1)保守性 (1)シェアハウス (1)スクレイピング (1)Gmail (1)Googleグループ (1)GoogleWorkspace (1)ShaderMask (1)google map (1)Google Places API (1)Vercel (1)Google Domains (1)branch (1)Git (1)オンラインオフィス (1)Freezed (1)アイコン (1)Apple Store Connect (1)FlutterGen (1)検索機能 (1)Navigator (1)メール送信 (1)カスタム認証 (1)アニメーション (1)FloatingActionButton (1)Arduino (1)ESP32 (1)経験談 (1)フリーランス (1)Dialog (1)Figma (1)デザイン (1)Slack (1)BI (1)非同期処理 (1)BackdropFilter (1)iOS (1)レビュー (1)getAuth (1)匿名 (1)Algolia (1)chakra-ui (1)コンサルティング (1)Symbol (1)reactive_forms (1)

お知らせ

3月19日開催のアプリ開発講座の参加者募集中!!

3月19日開催のアプリ開発講座の参加者募集中!!

3月19日にアプリ開発講座を開催します!会場は岐阜県美濃加茂市のコワーキングスペース「こやぁね」です。興味のある方は是非ご参加ください!

Read More
可茂IT塾ではFlutterインターンを募集しています!

可茂IT塾ではFlutterインターンを募集しています!

可茂IT塾ではFlutterインターンを募集しています!可茂IT塾のエンジニアの判断で、一定以上のスキルをを習得した方には有給でのインターンも受け入れています。

Read More