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

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

概述

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

使用前后的对比

使用前（手动设置 Override）

在使用多个 Provider 的情况下，手动设置多个 Override 变量会显得繁琐。

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(),
        ),
    );
}

使用后（通过生成的变量简化设置）

通过使用 override_pod 插件，可以将所有 Override 变量集中管理，简化代码。

import 'package:flutter_riverpod/flutter_riverpod.dart';

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

这样不仅减少了代码量，还提高了可维护性。

开始使用

1. 配置 pubspec.yaml

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

dependencies:
  override_pod_annotation:

dev_dependencies:
  override_pod_generator:
  build_runner:

使用步骤

1. 定义变量并使用注解

在需要覆盖的 Provider 文件中，使用 @overridePod 注解来定义变量。例如，在 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;
}

2. 使用 build_runner 生成代码

运行以下命令以生成所需的代码：

$ flutter pub run build_runner build

3. 导入生成的文件并使用

在主文件（如 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 文件配置 override_pod_generator 的选项：

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