Flutter開発入門18 依存性注入（DI）とは？効率的な状態管理

Flutter

はじめに

　Flutterアプリケーション開発において、依存性注入（Dependency Injection, DI）は、クリーンで拡張性の高いコードを書くために欠かせない設計手法です。DIを適切に導入することで、アプリケーションのテストが容易になり、コードの保守性が向上します。本記事では、Flutterでの依存性注入の基本的な考え方と、その実践方法を解説します。特に、ProviderやGetItなどの便利なパッケージを使った実装方法を中心に説明します。

依存性注入（DI）とは？

　依存性注入とは、あるクラスが必要とする他のクラスやオブジェクト（依存性）を外部から提供する設計手法です。これにより、クラスが直接依存するインスタンスを自ら生成するのではなく、必要な依存性が注入されるため、クラスの柔軟性とテストのしやすさが向上します。

　例えば、アプリのビジネスロジックを担当するクラス（サービスやリポジトリ）が、外部APIやデータベースとのやりとりを行う際、その依存するクラスを直接内部でインスタンス化すると、テストや保守が難しくなります。そこで、DIを使って、必要な依存性を外部から注入します。

依存性注入のメリット
  • モジュール化: クラスが特定の実装に強く依存しなくなるため、クラス間の依存性を緩和できます。
  • テストが容易: 依存性を外部から注入することで、テスト時にモック（テスト用のオブジェクト）を使用できます。
  • 保守性が向上: クラスの実装が変更されても、注入される依存性を簡単に変更できるため、コードの保守が容易になります。

Flutterでの依存性注入の実装

　　Flutterでは、依存性注入を実現するためにいくつかの方法がありますが、代表的なのがProviderやGetItといったパッケージを使った方法です。ここでは、それぞれの方法を紹介します。

1. Providerを使った依存性注入

　Providerは、Flutterの状態管理と依存性注入をシンプルに実現できるパッケージです。ChangeNotifierやValueNotifierといった状態管理クラスを用いることで、UIとビジネスロジックを効率的に連携できます。

　まず、pubspec.yamlファイルにproviderパッケージを追加します。

dependencies:
  provider: ^6.0.0

　次に、ChangeNotifierを用いて依存性注入を実装してみましょう。

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

// データの取得と管理を行うクラス
class CounterService with ChangeNotifier {
  int _counter = 0;

  int get counter => _counter;

  void increment() {
    _counter++;
    notifyListeners(); // 状態が変わったことを通知
  }
}

void main() {
  runApp(
    ChangeNotifierProvider(
      create: (context) => CounterService(),
      child: MyApp(),
    ),
  );
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Dependency Injection with Provider'),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              Text(
                'カウント数:',
              ),
              Consumer<CounterService>(
                builder: (context, counterService, child) {
                  return Text(
                    '${counterService.counter}',
                    style: TextStyle(fontSize: 40),
                  );
                },
              ),
            ],
          ),
        ),
        floatingActionButton: FloatingActionButton(
          onPressed: () {
            Provider.of<CounterService>(context, listen: false).increment();
          },
          child: Icon(Icons.add),
        ),
      ),
    );
  }
}
解説
  • ChangeNotifierProvider: 依存性注入を行うためのProviderです。CounterServiceというクラスをグローバルに提供しています。
  • Consumer: Consumerウィジェットを使って、CounterServiceの状態をUIに反映させています。状態が変更されるたびにUIが再描画されます。
  • notifyListeners(): ChangeNotifierクラスのメソッドで、状態が更新されたことをリスナーに通知します。

2. GetItを使った依存性注入

　　GetItは、シンプルな依存性注入の実装を提供するパッケージです。シングルトンパターンを使ってインスタンスを管理するため、アプリのどこからでも簡単に依存性にアクセスできるのが特徴です。GetItを使った依存性注入

　まず、pubspec.yamlファイルにget_itパッケージを追加します。

dependencies:
  get_it: ^7.7.0

　次に、GetItを使って依存性注入を実装します。

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

// GetItを初期化する
GetIt locator = GetIt.instance;

void setupLocator() {
  locator.registerLazySingleton<CounterService>(() => CounterService());
}

// カウンターを管理するクラス
class CounterService {
  int _counter = 0;

  int get counter => _counter;

  void increment() {
    _counter++;
  }
}

void main() {
  setupLocator(); // GetItのセットアップ
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Dependency Injection with GetIt'),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              const Text('カウント数:'),
              Text(
                '${locator<CounterService>().counter}',
                style: TextStyle(fontSize: 40),
              ),
            ],
          ),
        ),
        floatingActionButton: FloatingActionButton(
          onPressed: () {
            locator<CounterService>().increment();
          },
          child: const Icon(Icons.add),
        ),
      ),
    );
  }
}
解説
  • GetIt: GetItはシングルトンパターンでインスタンスを管理し、locatorを使ってクラスのインスタンスにアクセスします。
  • registerLazySingleton: クラスのインスタンスを遅延初期化するためのメソッドです。最初にアクセスされたときに初期化されます。
  • locator<CounterService>(): どこからでもCounterServiceのインスタンスにアクセスできます。

依存性注入を使うべきタイミング

　依存性注入は、アプリケーションが大規模になり、複数のサービスやリポジトリを扱う場合に非常に有効です。小規模なアプリでは、シンプルにクラス内でインスタンスを生成するだけで済むことが多いですが、テスト可能なコードを書きたい場合や複数の環境で同じクラスを使い回す場合には、DIの導入が推奨されます。

まとめ

　Flutterでの依存性注入は、アプリケーションをよりモジュール化し、テスト可能で保守しやすいコードを実現するために重要な設計パターンです。ProviderやGetItを使うことで、依存性注入をシンプルかつ効率的に実装することができます。これらのツールを使いこなすことで、Flutterアプリケーションの品質を一段と高めることができるでしょう。

コメント