Nodejs调用python的几种方案

nodejs可以使用JavaScript进行后端应用开发，同时使用electron可以开发桌面应用，可以说是相当强大。如果要在nodejs中读取本地文件则可以使用fs模块进行，ffi模块可以调用C开发的动态库，也可以实现更多的本地化操作，但是C开发动态库难度比较大成本比较高，这时候可以考虑使用python代替。python可以说是相当简单，它的库非常丰富，几乎可以满足你能想到的需求，因此python代替C库开发是不错的选择，下面介绍几种nodejs调用python的方法。

一、child_process子进程执行python

这种方案是nodejs提供的子进程解决方案，就是新建一个进程然后通过标准输入输出进行通信。在创建子进程时child_process底层创建两个pipe管道进行进程通信，相当于管道是nodejs主进程向python子进程发送消息，一个是python子进程向nodejs主进程发送消息。

const { spawn } = require('child_process');
const process = spawn('cmd');
// 执行python程序
process.stdin.write(`python ${__dirname}/py_scripts/main.py\n`)
// 接收子进程标准输出
process.stdout.on('data', function (data){
  console.log(data.toString());
});

这种方式执行python脚本不能传输中文字符，读取python的标准输出不是即时的，而是会一次读取多个结果，比如python的print输出十个a，一次读取可能读取到5个a，第二次再读取5个a，虽然不是即时通信，但是因为是pipe通信所以不会漏读消息。还有另一个问题是任务管理器中会显示一个cmd或者bash的进程，linux中bash输入的命令或内容通过日志文件可以查看nodejs与python通信的内容。

二、python创建服务器使用网络通信

这种方案是python使用flask模块创建服务器应用，开启服务器后就可以通过地址进行访问。nodejs中请求http://127.0.0.1:8080/home/hello连接，然后python返回一个json数据，nodejs解析json即可完成通信。这种方式基于http网络通信，只能nodejs主动请求，python不能主动发送消息给nodejs。

from flask import Flask, request, redirect, url_for, render_template

# 创建Flask服务
app = Flask(__name__)

# 访问URL：http://127.0.0.1:8080/home/hello
# 返回结果：{"data":"welcome to use flask.","msg":"hello"}
@app.route('/home/<name>')
def home(name):
    return {
        "msg": name,
        "data": "welcome to use flask."
    }

if __name__ == "__main__":
    # 启动Flask服务，指定主机IP和端口
    app.run(host='127.0.0.1', port=8080)

三、使用nodejs的node-pyrunner模块

node-pyrunner是NodeJs的npm模块，该模块可以实现JavaScript与Python的交互，可以利用libuv线程池以及异步特性提高开发和执行的效率。因为是嵌入python所以是底层v8与python直接通信，JavaScript可以同步或异步执行Python语句和调用Python函数；在Python中同样可以执行JavaScript语句和调用JavaScript的函数。

优点

• 不创建新进程执行python
• 为python引入异步编程
• 可使用python虚拟环境
• python中可执行JavaScript脚本
• JavaScript中可执行python脚本
• Python可以直接操作electron的DOM

快速上手

https://github.com/hileez/node-pyrunner-quick-start

这是快速创建node-pyrunner的应用，包括在nodejs中使用和electron中使用。

使用文档
https://github.com/hileez/node-pyrunner

参考案例：

系统资源监视器

安装npm包

npm install node-pyrunner

index.js

const pyrunner = require('node-pyrunner')
// 配置初始化信息
// python_home 默认: [AppHome]/python/win32/x64/3.10.10
// win32/x64 自动根据平台和架构改变
pyrunner.config['python_home'] = './python/win32/x64/3.10.10';
pyrunner.config['module_search_paths'][0] = './pyscript'; //默认: [AppHome]/pyscript
pyrunner.config['module_search_paths'].push('./myscript');
pyrunner.init(); // 初始化

// 执行python脚本
pyrunner.runScriptSync("print('main runSync pyscript')");
pyrunner.runScript("print('main run pyscript')");

// 使用app.py模块
let appModule = pyrunner.import('app');

// 同步调用app.py的hello函数
appModule.callSync('hello', ['pyrunner']);

// 异步调用app.py的callJsFunc函数
appModule.call('callJsFunc', [1, 2],
  (data) => {
    console.log(data);
  },
  (err) => {
    console.log(err);
  }
);

// python调用的JS函数，必须是函数名=函数体，表示该函数在global对象之下，否则python无法调用
sayHello = function (num1, num2) {
    let total = num1 + num2;
    return ++total;
}

app.py

import nodepyrunner

def hello(str):
    print(f'hello:{str}')

def callBack(data):
    nodepyrunner.runScript("console.log('Python callBack data:" + str(data) + "');")
    return 1 # 回调的Py函数返回值在JS中为空的JS函数，即此返回值将不会有任何操作

def callJsFunc(num1, num2):
    state = nodepyrunner.callJs(target='sayHello', args=[num1, num2], callback=[__name__, 'callBack']) # 返回False失败，True成功