[Flutter] カウンターアプリを flutter_riverpod で作るチュートリアル

概要
Riverpod
チュートリアル
1. 公式を動かす
2. 機能ごとにファイル分割
まとめ
参考

概要

カウンターアプリを Riverpod で作る。

サンプルは flutter_riverpod 公式の Example を利用する。

flutter_riverpod example | Flutter package

A reactive caching and data-binding framework. Riverpod makes working with asynchronous code a breeze.

Riverpod

Flutter の状態管理パッケージ。

グローバルで状態変数を利用できることが利点。

今回は flutter_riverpod ライブラリを利用する。

プロバイダ

Riverpod はグローバル定数として宣言する。常にイミュータブル。

下記のサンプルでの Provider は外部からの変更が不可能。

final myProvider = Provider((ref) {
  return MyValue();
});

今回利用するプロバイダは StateProvider で外部から変更が可能。プロバイダ内で生成できる型は int 型。

final counterProvider = StateProvider((ref) => 0);

プロバイダとは | Riverpod

のインストールが完了したところで、「プロバイダ」について学びましょう。

プロバイダの利用方法

プロバイダを利用するには、ref オブジェクトを取得する必要がある。

このオブジェクトを通じて、プロバイダと様々なやり取りを行う（値の取得、更新など）。

ref 自体はプロバイダまたはウィジェットから取得する。

例えば以下で利用する ConsumerWidget は StatelessWidget とほぼ同等で、build メソッドに第2パラメータが存在する以外の違いはない。

今回は以下のように使っている。

ref を取得するため、 ConsumerWidget にして引数 ref を追加（ウィジェットから取得）
ref.watch で state を値を取得し監視する。値が変化するとその値に依存するウィジェットやプロバイダも更新する
ref.read で state の値を取得する（監視しない）

class Home extends ConsumerWidget {
  @override
  Widget build(BuildContext context, WidgetRef ref) {
    return Scaffold(
      appBar: AppBar(title: const Text('Counter example')),
      body: Center(
        // Consumer is a widget that allows you reading providers.
        child: Consumer(builder: (context, ref, _) {
          final count = ref.watch(counterProvider.state).state;
          return Text('$count');
        }),
      ),
      floatingActionButton: FloatingActionButton(
        // The read method is a utility to read a provider without listening to it
        onPressed: () => ref.read(counterProvider.state).state++,
        child: const Icon(Icons.add),
      ),
    );
  }
}

プロバイダの利用方法 | Riverpod

本セクションの前に「プロバイダとは」のセクションに目を通していただくことをおすすめします。

チュートリアル

公式を動かす

チュートリアル用のプロジェクトを作成。

flutter create riverpod_official
cd riverpod_official
vi lib/main.dart

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

// A Counter example implemented with riverpod

void main() {
  runApp(
    // Adding ProviderScope enables Riverpod for the entire project
    const ProviderScope(child: MyApp()),
  );
}

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

  @override
  Widget build(BuildContext context) {
    return MaterialApp(home: Home());
  }
}

/// Providers are declared globally and specify how to create a state
final counterProvider = StateProvider((ref) => 0);

class Home extends ConsumerWidget {
  @override
  Widget build(BuildContext context, WidgetRef ref) {
    return Scaffold(
      appBar: AppBar(title: const Text('Counter example')),
      body: Center(
        // Consumer is a widget that allows you reading providers.
        child: Consumer(builder: (context, ref, _) {
          final count = ref.watch(counterProvider.state).state;
          return Text('$count');
        }),
      ),
      floatingActionButton: FloatingActionButton(
        // The read method is a utility to read a provider without listening to it
        onPressed: () => ref.read(counterProvider.state).state++,
        child: const Icon(Icons.add),
      ),
    );
  }
}

実行。

flutter run

いつもの光景。

機能ごとにファイル分割

main.dart

Flutter アプリのルート（root）に ProviderScope を置く。

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

import 'app.dart';

void main() {
  runApp(
    // Adding ProviderScope enables Riverpod for the entire project
    const ProviderScope(child: MyApp()),
  );
}

app.dart

Home クラスを呼び出すのみ。

import 'package:flutter/material.dart';

import 'home.dart';

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

  @override
  Widget build(BuildContext context) {
    return MaterialApp(home: Home());
  }
}

home.dart

コードの内容は↑で説明しているので割愛。

現在 View 機能と Model 機能が混在している。今後解体していく。

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

/// Providers are declared globally and specify how to create a state
final counterProvider = StateProvider((ref) => 0);

class Home extends ConsumerWidget {
  @override
  Widget build(BuildContext context, WidgetRef ref) {
    return Scaffold(
      appBar: AppBar(title: const Text('Counter example')),
      body: Center(
        // Consumer is a widget that allows you reading providers.
        child: Consumer(builder: (context, ref, _) {
          final count = ref.watch(counterProvider.state).state;
          return Text('$count');
        }),
      ),
      floatingActionButton: FloatingActionButton(
        // The read method is a utility to read a provider without listening to it
        onPressed: () => ref.read(counterProvider.state).state++,
        child: const Icon(Icons.add),
      ),
    );
  }
}