Flutter自定义Pod配置插件override_pod_annotation的使用

override_pod 插件是一个用于生成 Override 变量的工具，主要用于 Riverpod。该插件通过注解自动聚合定义的 Override 变量到一个数组中，并将其导出到生成的文件中。

概述

在覆盖 Riverpod 的 Provider 时，你需要在 ProviderScope 的 overrides 属性中设置 Override 变量来覆盖 Provider。如果你需要覆盖多个 Provider，手动设置多个变量可能会变得繁琐，但使用 override_pod 可以简化这一过程。

覆盖前

import 'package:flutter_riverpod/flutter_riverpod.dart';

void main() {
    runApp(
        ProviderScope(
            overrides: [
                fooProvider.overrideWith(FooProviderImpl.new),
                barProvider.overrideWith(BarProviderImpl.new),
                bazProvider.overrideWith(BazProviderImpl.new),
                quxProvider.overrideWith(QuxProviderImpl.new),
                quuxProvider.overrideWith(QuuxProviderImpl.new),
                corgeProvider.overrideWith(CorgeProviderImpl.new),
                graultProvider.overrideWith(GraultProviderImpl.new),
            ],
            child: const MyApp(),
        ),
    );
}

覆盖后

import 'package:flutter_riverpod/flutter_riverpod.dart';

void main() {
    runApp(
        ProviderScope(
            overrides: packagePodOverrides,
            child: const MyApp(),
        ),
    );
}

这样可以大大简化代码。

开始使用

在你的 pubspec.yaml 文件中添加以下依赖：

dependencies:
  override_pod_annotation:

dev_dependencies:
  override_pod_generator:
  build_runner:

使用方法

1. 使用注解定义变量。例如，在 foo/lib/src/repository/foo.dart 文件中：

import 'package:override_pod_annotation/override_pod_annotation.dart';

@overridePod
final pod = fooRepositoryProvider.overrideWith(FooRepositoryImpl.new);

class FooRepositoryImpl implements FooRepository {
    const FooRepositoryImpl(this.ref);
    final FooRepositoryRef ref;
}

1. 使用 build_runner 生成代码：

$ flutter pub run build_runner build

1. 导入生成的文件并使用生成的代码来覆盖 Pod。例如，在 lib/main.dart 文件中：

import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:foo/override_pod.gen.dart';

void main() {
    runApp(
        ProviderScope(
            overrides: fooPodOverrides,
            child: const MyApp(),
        ),
    );
}

配置选项

你可以在 build.yaml 文件中配置选项。

targets:
  $default:
    builders:
      override_pod_generator:
        options:
          input_file: lib/repository/**.dart
          output_file: pods.gen.dart
          output_value_name: pods
          annotation_class: package:override_pod_generator/src/annotation.dart#Pods

input_file

• 指定输入文件的路径。
• 默认值为 lib/**.dart。

output_file

• 指定输出文件的路径。
• 默认值为 lib/override_pod.gen.dart。

output_value_name

• 指定输出文件中的变量名。
• 默认值为 ${package_name}PodOverrides。

annotation_class

• 指定注解类。
• 默认值为 OverridePod。

构建项目

如果要构建项目，可以运行以下命令：

$ make bootstrap

此外，你可以使用以下命令运行测试：

$ melos test