🐻‍❄️

FlutterのGlobalKeyについて深掘りしてみる

2023/03/15に公開

Flutter

GlobalKey

tech

overview(概要)

FlutterのGlobalKeyは、状態にアクセスするためだけではなく、ウィジェットの識別子としても使用されます。GlobalKeyは、ウィジェットのライフサイクル中に一意のIDを提供するために使用され、ウィジェットツリーの異なる場所にあるウィジェットにアクセスするために使用することができます。

GlobalKeyを使用してウィジェットの状態にアクセスする場合、 GlobalKey.currentStateを使用して状態オブジェクトにアクセスします。これにより、ウィジェットの状態を変更することができます。

参考になった動画

example(例)

FlutterでGlobalKeyを使用するには、アクセスしたいStatefulWidgetにGlobalKeyを渡すだけです。
Widgetの状態にアクセスするには、キーが必要です。
これで、StatefulWidgetであるMyHomePageのカウンターと全ての状態にアクセスすることができるようになります。

GlobalKeyを使用して、StatefulWidgetにアクセスする。

 return Scaffold(
      appBar: AppBar(
        title: const Text('GlobalKey'),
      ),
      body: Center(
        child: MyHomePage(key: keyCounter),// MyHomePageにGlobalKeyを渡す
      ),

アクセスするStatefulWidgetには、キーが必要。

注意点
- メソッドや状態がプライベイトだとアクセスできない
- _MyHomePageStateは、MyHomePageStateにする
- _incrementCounterは、incrementCounterにする

class MyHomePage extends StatefulWidget {
  // StatefulWidgetにキーが必要。
  const MyHomePage({Key? key}) : super(key: key);

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

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

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

  @override
  Widget build(BuildContext context) {

カウンターを増やすメソッドをプライベイトから、通常のメソッドにするとアクセスできるようになる。
ボタンを押すとカウンターが増えていく。

floatingActionButton: FloatingActionButton(
        onPressed: () {
          /// 状態にアクセスする変数を定義する
          final state = keyCounter.currentState;

          /// カウンターを増やすメソッドにアクセスする
          state?.incrementCounter();
        },
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),

全体のコード

参考にした動画と異なり、state?.incrementCounter();の部分は、？をつけないとエラーになってしまう。
_がついていて、プライベイトになっている部分は、_を削除して外部からGlobalKeyを使用して、MyHomePageの状態にアクセスできるようになった。

main.dart

import 'package:flutter/material.dart';

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

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: FirstPage(),
    );
  }
}

class FirstPage extends StatelessWidget {
  final keyCounter = GlobalKey<MyHomePageState>();

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('GlobalKey'),
      ),
      body: Center(
        child: MyHomePage(key: keyCounter),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: () {
          /// 状態にアクセスする変数を定義する
          final state = keyCounter.currentState;

          /// カウンターを増やすメソッドにアクセスする
          state?.incrementCounter();
        },
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ), //
    );
  }
}

class MyHomePage extends StatefulWidget {
  // StatefulWidgetにキーが必要。
  const MyHomePage({Key? key}) : super(key: key);

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

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

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

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
          ],
        ),
      ),
    );
  }
}

最後に

GlobalKeyについて調べていると、エレメントやライフサイクルの話が出てきて頭が混乱してしまいました。
GlobalKeyを使っていて、ハマったエラーがあるのですが、上の階層のクラスから、下の階層のglobalKeyを探しにいくと、2枚のファイルに同じものがあるとエラーが発生してしまうのに遭遇しました😱

この場合だと、Riverpodのプロバイダーを使っているので、GlobalKeyを増やして、プロバイダーの変数名を変えれば、同じものを複数使用していると、エラーがでて怒られるのがなくなりました！

このように定義すれば解決する

final signinFormKeyProvider = Provider((ref) => GlobalKey<FormState>());
final signupFormKeyProvider = Provider((ref) => GlobalKey<FormState>());

overview(概要)

example(例)

全体のコード

最後に

Discussion