如何在Java中调用Python代码

极少数时候，我们会碰到类似这样的问题：与A同学合作写代码， A同学只会写Python，不熟悉Java ，而你只会写Java不擅长Python，并且发现难以用Java来重写对方的代码，这时，就不得不想方设法“调用对方的代码”。

下面，我通过一些简单的小例子来说明：如何在Java中调用Python代码。

主要内容如下：

• 什么是 Jython ？
• 一个 HelloPython 示例程序
• 如何在 JVM 中执行 Python 脚本
• 在 JVM 中调用 Python 编写的函数
• 在本地环境中调用 Python 脚本

什么是Jython？ 

Jython（原JPython），可以理解为一个由Java语言编写的Python解释器。

要使用Jython，只需要将Jython-x.x.x.jar文件置于classpath中即可 --> 官网下载

当然，通过Maven导入也OK，如下：

<dependency>
    <groupId>org.python</groupId>
    <artifactId>jython-standalone</artifactId>
    <version>2.7.0</version>
</dependency>

一个HelloPython程序

import org.python.util.PythonInterpreter;

public class HelloPython {
    public static void main(String[] args) {
        PythonInterpreter interpreter = new PythonInterpreter();
        interpreter.exec("print('hello')");
    }
}

什么是PythonInterpreter呢？它的中文意思即“Python解释器”。我们知道Python程序都是由解释器执行的，上面的代码在JVM中创建一个“Python解释器”对象，用于模拟Python解释器的行为，并通过exec("Python语句") 直接在JVM中执行Python代码，代码的输出结果为：hello。该程序运行速度相较正常的Java或者Python程序都要慢那么一点。

在JVM中执行Python脚本

interpreter.execfile("D:/labs/mytest/hello.py");  

如上，将exec改为execfile就可以了。需要注意的是，这个 .py文件不能含有第三方模块，因为这个“Python脚本”说到底仍是在JVM环境下执行的（而非依赖于本地计算机环境），如果 .py 程序中包含有第三方模块（例如 NumPy）将会在编译期报错：java ImportError: No module named xxx

在JVM中调用Python编写的函数

先写一个hello.py的Python代码：

def hello():
    return 'Hello'

在Java代码中调用这个Python函数：

import org.python.core.PyFunction;
import org.python.core.PyObject;
import org.python.util.PythonInterpreter;

public class HelloPython {
    public static void main(String[] args) {
        PythonInterpreter interpreter = new PythonInterpreter();
        interpreter.execfile("D:/labs/hello.py");

        PyFunction pyFunction = interpreter.get("hello", PyFunction.class); // 第一个参数为期望获得的函数（变量）的名字，第二个参数为期望返回的对象类型
        PyObject pyObject = pyFunction.__call__(); // 调用函数

        System.out.println(pyObject);
    }
}

上面的代码执行结果为：Hello

可以发现：即便只是调用一个函数，也必须先加载整个 .py文件，之后才能通过Jython包中所定义的类获取、调用这个函数。

如果Python函数需要参数，必须先将Java代码中的参数转化为对应的“Python类型”（姑且可以称作 Jython 类型 (●'◡'●)，例如：

__call__(new PyInteger(a), new PyInteger(b))

a，b的类型均为Java中的int型，还有一些Jython类型诸如：PyString、PyList等，详细信息可以参考官方的API文档。

在本地环境中调用Python脚本

由于Jython运行过慢并且不支持第三方的Python模块，也许通过Java执行一段终端命令来调用Python脚本才是实际会用的方式。以下为和舍友合作写的“手写识别”程序中的一个代码片段（Python做识别，Java写界面）：

import java.io.*;

class PyCaller {
    private static final String DATA_SWAP = "temp.txt";
    private static final String PY_URL = System.getProperty("user.dir") + "\\test.py";

    public static void writeImagePath(String path) {
        PrintWriter pw = null;
        try {
            pw = new PrintWriter(new FileWriter(new File(DATA_SWAP)));
        } catch (IOException e) {
            e.printStackTrace();
        }

        pw.print(path);
        pw.close();
    }

    public static String readAnswer() {
        BufferedReader br;
        String answer = null;
        try {
            br = new BufferedReader(new FileReader(new File(DATA_SWAP)));
            answer = br.readLine();
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }

        return answer;
    }

    public static void execPy() {
        Process proc = null;
        try {
            proc = Runtime.getRuntime().exec("python " + PY_URL);
            proc.waitFor();
        } catch (IOException e) {
            e.printStackTrace();
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }

    // 测试码
    public static void main(String[] args) throws IOException, InterruptedException {
        writeImagePath("D:\\labs\\mytest\\test.jpg");
        execPy();
        System.out.println(readAnswer());
    }
}

运行流程：Java Swing 界面接收用户输入 --> Java 将用户输入写到本地文件中 --> Java 调用本地 Python 脚本 --> Python 从本地文件拿到用户输入 --> Python 处理用户输入得到最终结果 --> Python 把最终结果写到本地文件 --> Java 对 Python 脚本的调用结束 --> Java 从本地文件中取出最终结果 --> Java 把最终结果返回给用户

完整代码链接：http://pan.baidu.com/s/1sl4l68H

---

后续补。这块内容已经写了好多年了。但是发现居然有出乎意料的浏览量。感觉有很多不妥之处。恐怕会对新手产生误导（万一 。。。），所以特意补上一段。上面的内容是基于大学初期的一次课设作业，当时好像是必须强行进行合作写代码，完成一个什么任务。。现在好多年过去了，我至今没有发现什么场景是真的需要Jython。而用Java执行终端命令来调Python现在看来也是非常不妥的。总之，实际开发中1000%有更漂亮的方法。上述方法可能仅适合写一些玩具式程序，甚至写玩具式程序都感觉未免“脏”了一些。。。所以， 仅  供 参 考。