Java集成Jython及动态执行指定脚本

Posted 2022-11-02 上帝De助手

首先Jython是支持Python语法，但是却跑在JVM之上。因此它可以集成Python、Java两大阵营的基础库。但由于Jython目前最新版本也只是2.7.2，因为对于Python的很多库在Jython中用不了的，但是java的库基本上都是可以直接用的。

Jython本身有2个发布版本，一个是installer（用于安装到PC端，类似于CPython的安装包），一个是standalone（用于Java集成开发，通过开放的编程API来执行Jython解释）。

如果只是执行Python的普通脚本，或者仅仅使用到Python的标准内建库，并不准备依赖Python的三方库进行开发，那么在Java项目中只需要引入standalone包即可（maven依赖）。

添加完依赖后，就可以通过PythonInterpreter类来调用Jython解释器执行Python代码了。

Properties props = new Properties();
props.put("python.home","C:\\\\jython2.7.2");
props.put("python.console.encoding", "UTF-8");
props.put("python.security.respectJavaAccessibility", "false");
props.put("python.import.site","true");

Properties properties = System.getProperties();
PythonInterpreter.initialize(properties, props, new String[0]);
PythonInterpreter pi1 = new PythonInterpreter();

# 执行Python表达式，有返回值，不会影响Python解释器上下文内容
pi1.eval("1 + 1"); 
# 执行Python命令，无返回值，会影响Python解释器上下文件内容      
pi1.exec("a = 1 + 1");
# 执行指定的Python脚本
pi1.execfile("/path/to/python/file.py");

上面是Java中调用Jython执行Python代码的基本用法。除此之外有时候还需要进行一些配置和参数传递等能力。具体来说，可以给Jython解释传递执行参数，也就是python代码中sys.args可以接收到的内容。关键配置如下：

PythonInterpreter.initialize(
            properties, 
            props, 
            new String[2] "hello", "world"    # Python脚本中通过sys.argv接收
);

也可以给Jython解释配置Python库的检索路径，也就是Python代码中sys.path可以接收到的内容。关键代码如下：

Properties props = new Properties();
# 如果本地通过installer安装了Jython，可以配置相关路径
# 后期如果需要使用到Python的三方库，可以直接安装到该路径下
# 之后通过下面的方式引入到Jython的包路径中
props.put("python.home","C:\\\\jython2.7.2");    # 本地安装的JYTHON.HOME路径
props.put("python.import.site","true");        # 此处必须为true

PythonInterpreter pi1 = new PythonInterpreter(Py.java2py(binding));
PySystemState sys = pi1.getSystemState();
sys.path.add("D:\\\\python");     // 添加自定义扩展库路径

pi1.exec("import sys");
pi1.exec("path = sys.path");
PyObject pathList = pi1.get("path");
System.out.println(pathList.toString());

如果想复用现有的Java三方库，可以只需要把对应的包引入到当前Java项目中，或者添加到classpath的路径中即可。

此外，在启动Jython解释器时还可以设置Jython解释器中的全局变量，也就是通过globals()函数可以获取到的内容。具体配置如下：

PythonInterpreter.initialize(properties, props, new String[0]);
Map<String, Object> binding = new HashMap<>();
binding.put("a", 1);
binding.put("b", 2);
PythonInterpreter pi1 = new PythonInterpreter(Py.java2py(binding));
pi1.exec("vars = globals()")
System.out.println(pi1.get("vars").toString());

上面绑定数据的效果就是，在Jython解释器中全局可以默认访问的变量a和b，也就是所谓的内建变量，不需要引用和申明直接就可以使用。

参考文档：

在Java中调用Python - nuccch - 博客园

Chapter 10: Jython and Java Integration — Definitive Guide to Jython latest documentation