Flutter多实例场景下Dart与Native实例绑定问题求助

问题本质 #

onAttachedToEngine是Flutter插件绑定到Flutter引擎时仅触发一次的初始化方法，和Dart实例的创建完全无关，因此不能在这里为每个Dart实例生成Native实例。要实现Dart实例与Native实例一一绑定，核心思路是通过唯一实例ID映射来管理多实例，Native端维护一个ID到Native实例的映射表，Dart端每次调用方法时携带自身的实例ID，Native端根据ID找到对应实例执行逻辑。

一、MethodChannel 实现多实例绑定 #

实现步骤 #

1. Dart端为每个实例生成唯一ID（推荐用UUID）
2. 所有MethodChannel调用都携带该实例ID
3. Native端维护Map<String, NativeInstance>，根据ID创建、查找、销毁Native实例

Dart端代码

import 'package:uuid/uuid.dart';
import 'package:flutter/services.dart';

final _uuidGenerator = Uuid();

class TestFlutter {
  final String _instanceId;
  final MethodChannel _channel = const MethodChannel("xyz/Flutter");

  TestFlutter() : _instanceId = _uuidGenerator.v4();

  Future<void> setup(String param) async {
    await _channel.invokeMethod('setup', {
      'instanceId': _instanceId,
      'param': param,
    });
  }

  Future<String> doSomething() async {
    return await _channel.invokeMethod('doSomething', {
      'instanceId': _instanceId,
    });
  }

  // 必须调用该方法释放Native实例，避免内存泄漏
  Future<void> dispose() async {
    await _channel.invokeMethod('dispose', {
      'instanceId': _instanceId,
    });
  }
}

// 使用示例
final _instance1 = TestFlutter();
final _instance2 = TestFlutter();

_instance1.setup("abc");
_instance2.setup("abcd");

Native端（Android）代码

import java.util.HashMap;
import java.util.Map;
import io.flutter.plugin.common.MethodCall;
import io.flutter.plugin.common.MethodChannel;
import io.flutter.plugin.common.FlutterPlugin;

public class YourPlugin implements FlutterPlugin, MethodChannel.MethodCallHandler {
    private MethodChannel channel;
    private Map<String, NativeTestInstance> instanceMap = new HashMap<>();

    @Override
    public void onAttachedToEngine(FlutterPluginBinding flutterPluginBinding) {
        channel = new MethodChannel(flutterPluginBinding.getBinaryMessenger(), "xyz/Flutter");
        channel.setMethodCallHandler(this);
    }

    @Override
    public void onMethodCall(MethodCall call, MethodChannel.Result result) {
        String instanceId = call.argument("instanceId");
        if (instanceId == null) {
            result.error("INVALID_ARG", "instanceId is required", null);
            return;
        }

        switch (call.method) {
            case "setup":
                String param = call.argument("param");
                NativeTestInstance nativeInstance = new NativeTestInstance(param);
                instanceMap.put(instanceId, nativeInstance);
                result.success(null);
                break;
            case "doSomething":
                NativeTestInstance targetInstance = instanceMap.get(instanceId);
                if (targetInstance != null) {
                    result.success(targetInstance.process(param));
                } else {
                    result.error("INSTANCE_NOT_FOUND", "No native instance bound to this ID", null);
                }
                break;
            case "dispose":
                instanceMap.remove(instanceId);
                result.success(null);
                break;
            default:
                result.notImplemented();
        }
    }

    // 自定义Native业务实例类
    private static class NativeTestInstance {
        private final String param;

        public NativeTestInstance(String param) {
            this.param = param;
        }

        public String process(String input) {
            return "Processed with param: " + this.param + ", input: " + input;
        }
    }

    @Override
    public void onDetachedFromEngine(FlutterPluginBinding binding) {
        channel.setMethodCallHandler(null);
        instanceMap.clear(); // 插件销毁时清理所有实例
    }
}

二、Pigeon 实现多实例绑定 #

Pigeon默认是单实例设计，但可以通过在方法参数中携带实例ID来实现多实例映射，逻辑和MethodChannel一致，只是代码结构更规范。

实现步骤 #

1. 修改Pigeon API定义，让所有方法携带实例ID参数
2. Dart端生成唯一ID并随方法调用传入
3. Native端维护实例映射表，根据ID处理对应实例逻辑

Pigeon定义文件（test_api.dart）

import 'package:pigeon/pigeon.dart';

@ConfigurePigeon(PigeonOptions(
  dartOut: 'lib/test_api.dart',
  javaOut: 'android/src/main/java/com/yourpackage/TestApi.java',
  javaOptions: JavaOptions(package: 'com.yourpackage'),
))
class SetupParams {
  String instanceId;
  String param;
}

@HostApi()
abstract class TestApi {
  void setup(SetupParams params);
  String doSomething(String instanceId);
  void dispose(String instanceId);
}

Dart端代码

import 'package:uuid/uuid.dart';
import 'test_api.dart';

final _uuidGenerator = Uuid();

class TestFlutter {
  final String _instanceId;
  final TestApi _api = TestApi();

  TestFlutter() : _instanceId = _uuidGenerator.v4();

  Future<void> setup(String param) async {
    await _api.setup(SetupParams(
      instanceId: _instanceId,
      param: param,
    ));
  }

  Future<String> doSomething() async {
    return await _api.doSomething(_instanceId);
  }

  Future<void> dispose() async {
    await _api.dispose(_instanceId);
  }
}

// 使用示例
final _instance1 = TestFlutter();
final _instance2 = TestFlutter();

_instance1.setup("abc");
_instance2.setup("abcd");

Native端（Android）代码

import com.yourpackage.TestApi;
import com.yourpackage.SetupParams;
import java.util.HashMap;
import java.util.Map;
import io.flutter.plugin.common.FlutterPlugin;

public class YourPlugin implements TestApi, FlutterPlugin {
    private Map<String, NativeTestInstance> instanceMap = new HashMap<>();

    @Override
    public void setup(SetupParams params) {
        String instanceId = params.getInstanceId();
        String param = params.getParam();
        instanceMap.put(instanceId, new NativeTestInstance(param));
    }

    @Override
    public String doSomething(String instanceId) {
        NativeTestInstance targetInstance = instanceMap.get(instanceId);
        if (targetInstance != null) {
            return targetInstance.process();
        }
        throw new RuntimeException("No native instance bound to ID: " + instanceId);
    }

    @Override
    public void dispose(String instanceId) {
        instanceMap.remove(instanceId);
    }

    private static class NativeTestInstance {
        private final String param;

        public NativeTestInstance(String param) {
            this.param = param;
        }

        public String process() {
            return "Pigeon processed: " + this.param;
        }
    }

    @Override
    public void onAttachedToEngine(FlutterPluginBinding binding) {
        TestApi.setup(binding.getBinaryMessenger(), this);
    }

    @Override
    public void onDetachedFromEngine(FlutterPluginBinding binding) {
        instanceMap.clear();
    }
}

关键注意事项 #

1. 内存泄漏防护：Dart端必须在实例不再使用时调用dispose方法，Native端及时移除映射表中的实例
2. ID唯一性：推荐用UUID生成实例ID，避免重复；如果用自增ID，要注意多线程安全
3. 错误处理：Native端必须判断实例ID是否存在，避免空指针异常；Dart端要处理Native返回的错误

内容的提问来源于stack exchange，提问作者Jim