2020-12-30
在做项目的时候,经常会碰到这个问题,主要程序是用java写的,有些功能使用python写的,整个项目需要把java代码和python代码进行整合,在一个项目里面运行,这就涉及到java调用python的问题。
java调用python程序有几种思路:需要先搭建好 java 及 python 的编译执行环境。
前两种都是本地调用。第三种是通过微服务的方式。
1. 一个解决思路是在java项目中引入jython,然后使用python解释器运行jython代码。
2. 在java程序中直接调用python程序,这样无论python程序引入什么样的库(模块),只要程序可以直接通过python xxx.py运行,则在Java程序中也能运行。java通过Runtime类调用python命令执行。
3. 通过python发布微服务,java请求的方式调用。即接口调用。会占用网络资源。
4. 可能还有其他方法
若果在您的代码中不包含第三方依赖的话,引入jython这未尝不是一种比较方便快捷的方案,在这里就不做讨论了。当在python脚本中包含第三方依赖时,目前的解决方案是通过Runtime工具执行cmd命令来调用本地python解释器,然后通过在本地安装需要的依赖包并在python脚本中正常导入即可。
1. 一个解决思路是在java项目中引入jython
然后使用python解释器运行jython代码
2.1 注意事项
在使用jython实现Java调用python程序,如果python程序中包含有第三方库(如numpy),则会报如下错误:
Exception in thread "main" Traceback (innermost last):
File "pyfile/detect.py", line 3, in ?
ImportError: no module named numpy
2.2 引入Jython
此方法需要引用org.python包,需要下载Jpython。在这里先介绍一下Jpython。下面引入百科的解释:
- Jython是一种完整的语言,而不是一个Java翻译器或仅仅是一个Python编译器,它是一个Python语言在Java中的完全实现。Jython也有很多从CPython中继承的模块库。最有趣的事情是Jython不像CPython或其他任何高级语言,它提供了对其实现语言的一切存取。所以Jython不仅给你提供了Python的库,同时也提供了所有的Java类。这使其有一个巨大的资源库。
这里我建议下载最新版本的Jpython,因为可以使用的python函数库会比老版本的多些,目前最新版本为2.7。
下载jar包请点击Download Jython 2.7.0 - Standalone Jar
下载安装程序请点击Download Jython 2.7.0 - Installer
如果使用maven依赖添加的话,使用下面的语句
<dependency> <groupId>org.python</groupId> <artifactId>jython-standalone</artifactId> <version>2.7.0</version> </dependency>
2.3 示例1
1)可以直接在java类中写python语句了,具体代码如下:
import org.python.util.PythonInterpreter; public class Test { public static void main(String[] args) { PythonInterpreter interpreter = new PythonInterpreter(); interpreter.exec("a=[5,2,3,9,4,0]; "); interpreter.exec("print(sorted(a));"); //此处python语句是3.x版本的语法 } }
2)运行结果
[0, 2, 3, 4, 5, 9]
2.4 示例2 - 无参数
1)首先在本地建立一个python脚本,命名为printhello.py,写了一个简单的两个数做加法的函数,代码如下:
if __name__ == \'__main__\': print("hello")
2)python的功能函数已经写好,接下来我们写一个java的测试类(同样需要用到Jpython包),来测试一下是否可以运行成功。代码如下:
import org.python.util.PythonInterpreter; public class Test { public static void main(String[] args) { // TODO Auto-generated method stub PythonInterpreter interpreter = new PythonInterpreter(); interpreter.execfile("D:\\Projects\\java\\javacallpython\\printhello.py"); } }
3) 运行结果
hello
2.5 示例3 - 有参数
1)首先在本地建立一个python脚本,命名为add.py,写了一个简单的两个数做加法的函数,代码如下:
def add(a,b): return a + b
2)python的功能函数已经写好,接下来我们写一个java的测试类(同样需要用到Jpython包),来测试一下是否可以运行成功。代码如下:
import org.python.core.PyFunction; import org.python.core.PyInteger; import org.python.core.PyObject; import org.python.util.PythonInterpreter; public class Test { public static void main(String[] args) { // TODO Auto-generated method stub PythonInterpreter interpreter = new PythonInterpreter(); interpreter.execfile("D:\\Projects\\java\\javacallpython\\add.py"); // 第一个参数为期望获得的函数(变量)的名字,第二个参数为期望返回的对象类型 PyFunction pyFunction = interpreter.get("add", PyFunction.class); int a = 5, b = 10; //调用函数,如果函数需要参数,在Java中必须先将参数转化为对应的“Python类型” PyObject pyobj = pyFunction.__call__(new PyInteger(a), new PyInteger(b)); System.out.println("the anwser is: " + pyobj); } }
3)运行结果
the anwser is: 15
当python调用其他第三方包时候,使用iython会报以下错误(这里以numpy为例):
Exception in thread "main" Traceback (most recent call last):
File "D:\Projects\java\IdeaProjects\javacallpython\src\main\java\testnp.py", line 2, in <module>
import numpy as np
ImportError: No module named numpy
2. 在java程序中直接调用python程序
这样无论python程序引入什么样的库(模块),只要程序可以直接通过python xxx.py运行,则在Java程序中也能运行。下面重点介绍在Java中直接调用python程序的方法。
2.1 java中的核心代码,Runtime.getRuntime().exec(),如果python的入口函数不需要参数的话,可以直接将调用py文件的字符写入,示例
Runtime.getRuntime().exec(“python”,” D:\\pyworkspace\\main.py”)
2.2 需要注意的一些问题,要保证在命令行模式下,键入命令
python D:/pyworkspace/main.py
程序可以正常运行。也就是要保证有一个配置好的python环境。这个示例程序比较简单,如果是一个比较复杂的python项目,可能涉及到的模块比较多,用到的库也很多,需要将python环境配置完整,先在命令行下运行,无误后再在java程序中调用。
2.3 示例1
1)我们要调用的python代码:
import sys def main(abc): print(abc) if __name__ == \'__main__\': for i in range(1, len(sys.argv)): strs = sys.argv[i] main(strs)
程序目录名称为D:/pyworkspace/main.py,函数main有参数,参数通过sys传入,也就是在java中定义好参数,然后通过sys,将参数传给main函数,把参数打印出来。
2)Java程序代码
import java.io.BufferedReader; import java.io.IOException; import java.io.InputStreamReader; public class Main { public static void main(String[] args) { // TODO Auto-generated method stub Process proc; try { String[] args1 = new String[] { "python", "D:\\pyworkspace\\main.py", "hello,test java and python"}; proc=Runtime.getRuntime().exec(args1); //用输入输出流来截取结果 BufferedReader in = new BufferedReader(new InputStreamReader(proc.getInputStream())); String line = null; while ((line = in.readLine()) != null) { System.out.println(line); } in.close(); proc.waitFor(); } catch (IOException e) { e.printStackTrace(); } catch (InterruptedException e) { e.printStackTrace(); } } }
可以看到核心代码就是
String[] args1 = new String[] { "python", "D:\\pyworkspace\\main.py", "hello,test java and python"};
proc=Runtime.getRuntime().exec(args1);
Runtime.getRuntime().exec()的参数是一个字符串数组,相当于执行
python D:/pyworkspace/main.py,
往main.py中传递参数"hello,test java and python"。
3)运行结果
hello,test java and python
3.
就是python提供服务调用接口,java去调用该接口来获得该服务并获取返回结果。
以后有机会补充。
4.
总结
虽然在Java中调用Python可以有多种方式解决,甚至因为Jython的出现更显得非常便利。但是这种程序间嵌套调用的方式不可取,首先抛开调用性能不说,增加了耦合复杂度。更加有效的方式应该是通过RCP或者RESTful接口进行解耦,这样各司其职,也便于扩展,良好的架构是一个项目能够健康发展的基础。在微服务架构大行其道的今天,这种程序间嵌套调用的方式将会逐渐被淘汰。