Flutter 中 PluginRegistry.Registrar 的移除与迁移指南在 Flutter 3.29 版

在 Flutter 3.29 版本中，PluginRegistry.Registrar 已被完全移除。这一变化意味着所有基于旧 API 的插件都需要迁移到新的 FlutterPlugin 接口。

背景与原因

自 Flutter 1.12 版本开始，Flutter 团队就引入了新的 Android 插件 API，以替代旧的 PluginRegistry.Registrar。旧 API 的主要问题是它依赖于 BuildContext，在某些情况下（如 Flutter 尚未附加到任何 Activity 时）可能会返回 null，导致运行时错误。新的 FlutterPlugin 接口则提供了更简洁、更稳定的生命周期管理方式。

影响

在 Flutter 3.29 中，旧的 PluginRegistry.Registrar 已被完全移除。如果你的项目或依赖的插件仍在使用旧 API，可能会导致编译失败或运行时错误。例如，以下是一个典型的错误信息：

error: cannot find symbol
public static void registerWith(PluginRegistry.Registrar registrar) {
                                      ^
symbol:   class Registrar
location: interface PluginRegistry

这种错误表明代码中仍然使用了已被移除的 Registrar 类。

迁移指南

为了确保插件与 Flutter 3.29 兼容，你需要将旧的插件代码迁移到新的 FlutterPlugin 接口。以下是迁移的步骤和示例代码：

1. 替换 `registerWith` 方法

旧的插件注册方式是通过 registerWith 方法实现的，例如：

public class MyPlugin implements MethodCallHandler {
    private final Registrar registrar;

    private MyPlugin(Registrar registrar) {
        this.registrar = registrar;
    }

    public static void registerWith(Registrar registrar) {
        final MethodChannel channel = new MethodChannel(registrar.messenger(), "my_plugin");
        channel.setMethodCallHandler(new MyPlugin(registrar));
    }
}

在新的 API 中，你需要实现 FlutterPlugin 接口，并在 onAttachedToEngine 方法中初始化 MethodChannel：

public class MyPlugin implements FlutterPlugin, MethodCallHandler {
    private MethodChannel channel;

    @Override
    public void onAttachedToEngine(@NonNull FlutterPluginBinding binding) {
        channel = new MethodChannel(binding.getBinaryMessenger(), "my_plugin");
        channel.setMethodCallHandler(this);
    }

    @Override
    public void onDetachedFromEngine(@NonNull FlutterPluginBinding binding) {
        channel.setMethodCallHandler(null);
        channel = null;
    }

    @Override
    public void onMethodCall(MethodCall call, @NonNull Result result) {
        // Handle method calls
    }
}

2. 更新插件注册方式

如果你的插件需要与 Android 的 Activity 交互，还需要实现 ActivityAware 接口。例如：

public class MyPlugin implements FlutterPlugin, MethodCallHandler, ActivityAware {
    private MethodChannel channel;
    private Activity activity;

    @Override
    public void onAttachedToEngine(@NonNull FlutterPluginBinding binding) {
        channel = new MethodChannel(binding.getBinaryMessenger(), "my_plugin");
        channel.setMethodCallHandler(this);
    }

    @Override
    public void onDetachedFromEngine(@NonNull FlutterPluginBinding binding) {
        channel.setMethodCallHandler(null);
        channel = null;
    }

    @Override
    public void onAttachedToActivity(@NonNull ActivityPluginBinding binding) {
        activity = binding.getActivity();
    }

    @Override
    public void onDetachedFromActivityForConfigChanges() {
        activity = null;
    }

    @Override
    public void onReattachedToActivityForConfigChanges(@NonNull ActivityPluginBinding binding) {
        activity = binding.getActivity();
    }

    @Override
    public void onDetachedFromActivity() {
        activity = null;
    }

    @Override
    public void onMethodCall(MethodCall call, @NonNull Result result) {
        // Handle method calls
    }
}

3. 清理旧代码

在迁移完成后，确保删除所有与 PluginRegistry.Registrar 相关的代码。例如，移除以下方法：

public static void registerWith(Registrar registrar) {
    // Old registration code
}

注意事项

确保依赖的插件已更新：如果你的项目依赖了第三方插件，确保这些插件已迁移到新的 API。
测试插件功能：迁移完成后，务必对插件进行充分测试，确保其在不同场景下（如配置更改、后台运行等）的兼容性。
更新 Flutter SDK：确保你的 Flutter SDK 版本至少为 3.29。

总结

Flutter 3.29 中移除了旧的 PluginRegistry.Registrar API，这是为了提供更稳定、更高效的插件生命周期管理。通过上述迁移步骤，你可以轻松将旧的插件代码更新为新的 FlutterPlugin 接口。这一变化不仅提高了插件的稳定性，还为未来的 Flutter 开发奠定了更好的基础。

如果你在迁移过程中遇到问题，可以参考官方文档或社区讨论。

Flutter 中 PluginRegistry.Registrar 的移除与迁移指南