[Flutter] build_runnerとMockitoを使ってlibフォルダにMockファイルを生成する

概要

Flutterでbuild_runnerパッケージを使って開発する時必要なコードを生成したりします。特に、テストコードではMockitoを使ってテスト用のMockを作成する時よく使います。

build_runner: https://pub.dev/packages/build_runner
Mockito: https://pub.dev/packages/mockito

今回のブログポストではbuild_runnerとMockitoパッケージを使ってlibフォルダにMockファイルを生成する方法について説明します。

Libフォルダ中でMock生成する

普通はbuild_runnerとMockitoパッケージを使ってMockを作る時にはテスト用なので、libフォルダ中のファイルでは使えことができないです。しかし、私ように他のユーザのためパッケージを作る時には次のようにlibフォルダ中のファイルでもMockを使う時があります。

run_with_network_images/lib/src/run_with_network_images.dart

...
@GenerateMocks([
  HttpClient,
  HttpClientRequest,
  HttpClientResponse,
  HttpHeaders,
  StreamSubscription,
])
R runWithNetworkImages<R>(R Function() body) {
  return HttpOverrides.runZoned(
    body,
    createHttpClient: (_) => _createMockImageHttpClient(),
  );
}
...

今回のブログポストではこのようにlibフォルダ中にMockを生成する方法について説明します。

build.yamlファイル

build_runnerはbuild.yamlファイルで色んな設定をすることができます。このbuild.yamlファイルを使うとlibフォルダ中にあるファイルでもMockを生成することができます。

libフォルダ中にあるファイルでもMockを生成するため、./build.yamlファイルを生成して次のように修正します。

targets:
  $default:
    builders:
      mockito|mockBuilder:
        generate_for:
          - 'lib/src/run_with_network_images.dart'

このようにbuild_runnerがMockitoを使ってMockファイルを作る対象にlibフォルダ中のファイルを指定すると、libフォルダ中のファイルでもMockを生成することができます。

完了

これでbuild_runnerとMockitoパッケージを使ってlibフォルダにMockファイルを生成する方法について見てみました。このようなことはあまりないですが、build.yamlファイルを使ってbuild_runnerを設定することができると言うことを知っておくと良いと思います。

Github Sponsor

Buy me a coffee

私のブログが役に立ちましたか？下にコメントを残してください。それは私にとって大きな大きな力になります！