Chrome扩展Native Messaging配置与参数传递异常问题排查

问题原因分析 #

1. 初始sys.stdin.read()卡住的原因 #

Chrome原生消息的输入流并非普通文本流，每个消息前会附带4字节无符号大端整数的长度标识。直接调用sys.stdin.read()会持续等待流结束（EOF），但Chrome在保持连接状态下不会主动发送EOF，导致程序一直阻塞。只有扩展重载时连接断开，才会触发EOF让read()返回。

2. 添加send_message后控制台报错的原因 #

报错核心是exe向Chrome发送消息的格式不符合原生消息规范：

• 必须先发送4字节无符号大端整数（表示后续JSON字符串的字节长度）
• 再发送UTF-8编码的合法JSON字符串
  如果跳过长度前缀、JSON格式错误或输出未强制刷新，Chrome就会抛出"Error when communicating with the native messaging host"错误。

正确实现方案 #

一、Python端（exe）的标准读写逻辑 #

1. 读取Chrome发送的消息

import sys
import struct
import json

def read_chrome_message():
    # 读取4字节长度前缀
    length_bytes = sys.stdin.read(4)
    if not length_bytes:
        return None
    # 解析长度（无符号大端格式）
    message_length = struct.unpack('=I', length_bytes)[0]
    # 读取对应长度的JSON数据并解析
    message_content = sys.stdin.read(message_length).decode('utf-8')
    return json.loads(message_content)

2. 向Chrome发送消息

def send_to_chrome(message):
    # 序列化为JSON字节流
    json_bytes = json.dumps(message).encode('utf-8')
    # 生成4字节长度前缀
    length_prefix = struct.pack('=I', len(json_bytes))
    # 先写长度，再写JSON内容，强制刷新输出避免缓存
    sys.stdout.buffer.write(length_prefix)
    sys.stdout.buffer.write(json_bytes)
    sys.stdout.buffer.flush()

3. 完整业务逻辑示例

import sys
import struct
import json

def read_chrome_message():
    length_bytes = sys.stdin.read(4)
    if not length_bytes:
        return None
    message_length = struct.unpack('=I', length_bytes)[0]
    message_content = sys.stdin.read(message_length).decode('utf-8')
    return json.loads(message_content)

def send_to_chrome(message):
    json_bytes = json.dumps(message).encode('utf-8')
    length_prefix = struct.pack('=I', len(json_bytes))
    sys.stdout.buffer.write(length_prefix)
    sys.stdout.buffer.write(json_bytes)
    sys.stdout.buffer.flush()

def main():
    # 读取扩展传递的参数
    input_data = read_chrome_message()
    if not input_data:
        return
    
    # 业务逻辑：将参数保存到txt
    with open('user_input.txt', 'w', encoding='utf-8') as f:
        f.write(json.dumps(input_data, indent=2))
    
    # 向扩展发送成功通知
    send_to_chrome({"status": "success", "msg": "参数已保存至user_input.txt"})

if __name__ == "__main__":
    main()

二、Chrome扩展端适配 #

1. background.js连接与消息处理

let nativePort = null;

chrome.runtime.onMessage.addListener((req, sender, sendRes) => {
    if (req.action === 'launchNativeApp') {
        // 连接原生主机（替换为你的主机配置名）
        nativePort = chrome.runtime.connectNative('com.yourdomain.yourapp');
        
        // 监听原生消息
        nativePort.onMessage.addListener((res) => {
            console.log('原生返回:', res);
            // 向content.js转发结果
            chrome.tabs.sendMessage(sender.tab.id, {type: 'nativeResult', data: res});
            // 任务完成后主动断开连接
            nativePort.disconnect();
        });
        
        // 监听连接错误
        nativePort.onDisconnect.addListener(() => {
            if (chrome.runtime.lastError) {
                console.error('连接失败:', chrome.runtime.lastError.message);
                chrome.tabs.sendMessage(sender.tab.id, {type: 'nativeError', msg: chrome.runtime.lastError.message});
            }
        });
        
        // 发送参数到原生程序
        nativePort.postMessage(req.params);
    }
});

2. 配置文件与权限检查

• 确保manifest.json添加原生消息权限：

  "permissions": [
      "nativeMessaging",
      "tabs"
  ],
  "externally_connectable": {
      "matches": ["chrome-extension://你的扩展ID/*"]
  }
  

• 原生主机配置文件的allowed_origins必须严格匹配扩展ID，path指向正确的exe路径。

三、Python打包exe注意事项 #

用PyInstaller打包时，需确保stdin/stdout正常工作：

# 打包为单文件，调试时可去掉--noconsole查看日志
pyinstaller --onefile --noconsole your_script.py

排查技巧 #

• 命令行测试Python脚本：手动构造符合格式的输入（先写4字节长度，再写JSON），验证脚本逻辑是否正常。
• 查看Chrome扩展背景页控制台：获取更详细的错误堆栈信息。
• 检查原生主机配置文件：确认name、allowed_origins、path均配置正确。

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