Flutter中IsolateNameServer注册端口后lookupPortByName返回null问题

针对你遇到的IsolateNameServer.lookupPortByName始终返回null的问题，以下是核心排查点和解决方法：

1. 确保ReceivePort被长期持有 #

如果receivePort是局部变量，方法执行完成后会被垃圾回收，导致注册的端口失效，最终lookup返回null。

• 解决方法：将ReceivePort声明为全局变量，或者作为State类的成员变量：

// 全局变量示例
final ReceivePort receivePort = ReceivePort();

// 或者在State类中
class _YourWidgetState extends State<YourWidget> {
  final ReceivePort receivePort = ReceivePort();
  
  // ... 其他代码
}

2. 检查端口名称的拼写一致性 #

你的代码中使用的端口名称是_notficationListener_（缺少一个字母i，正确拼写应为_notificationListener_）。如果其他逻辑（比如NotificationsListener内部）使用的是正确拼写，会导致端口查找不匹配。

• 解决方法：用常量统一管理端口名称，避免拼写错误：

const String notificationPortName = "_notificationListener_";

3. 优化端口注册逻辑 #

你的代码在else分支中重复注册端口，但未判断receivePort是否已添加监听器，可能导致重复监听。同时无需重复初始化NotificationsListener，除非确实需要重置：

void setupNotificationListener() async {
  const portName = "_notificationListener_";

  // 注册端口（仅当不存在时）
  if (IsolateNameServer.lookupPortByName(portName) == null) {
    print('Registering fresh port');
    IsolateNameServer.registerPortWithName(receivePort.sendPort, portName);
  } else {
    // 可选：替换已存在的端口映射
    IsolateNameServer.removePortNameMapping(portName);
    IsolateNameServer.registerPortWithName(receivePort.sendPort, portName);
  }

  // 仅当未添加监听器时，设置监听逻辑
  if (!receivePort.hasListeners) {
    receivePort.listen((message) {
      print("Message received: $message");
      onData(message);
    });
  }

  // 初始化监听器（仅需执行一次）
  NotificationsListener.initialize(callbackHandle: _callback);
  final bool? isRunning = await NotificationsListener.isRunning;

  if (kDebugMode) {
    print("Service is ${isRunning == false ? "not" : ""} running");
    print("Port lookup result: ${IsolateNameServer.lookupPortByName(portName)}");
  }

  started = isRunning!;
}

4. 确认Isolate间的端口访问权限 #

IsolateNameServer的端口注册是全局的，但要注意：

• 端口必须由当前Isolate创建的ReceivePort提供，跨Isolate注册的端口需要确保创建ReceivePort的Isolate仍然存活。
• 如果NotificationsListener创建了后台Isolate，要确保后台Isolate通过IsolateNameServer.lookupPortByName获取端口时，主Isolate的receivePort仍然存在。

5. 清理资源避免泄漏 #

当不再需要监听时，记得关闭ReceivePort并移除端口映射：

void disposeListener() {
  const portName = "_notificationListener_";
  IsolateNameServer.removePortNameMapping(portName);
  receivePort.close();
}

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