Java 调用 Python 脚本:实现 HelloWorld

作为程序员,我们经常会遇到需要在Java项目中调用Python脚本的场景。可能是为了复用现成的Python工具库,也可能是需要利用Python在数据处理上的优势。本文不聊太多理论,直接上手三种实用的调用方式,从基础到进阶,一步步实现Java与Python的"HelloWorld"交互。

一、环境准备

在开始之前,确保你的开发环境满足以下条件:

  • Java环境 :JDK 8+(推荐11),配置好JAVA_HOME
  • Python环境 :Python 3.6+,配置好PATH(命令行输入python --version能正常显示版本)
  • 开发工具:任意IDE,文本编辑器(用于写Python脚本)

验证环境的小技巧:

bash 复制代码
# 检查Java
java -version
# 检查Python
python --version  # 或python3 --version(根据系统配置)

如果Python命令无法识别,大概率是没配置环境变量。Windows用户可以在"设置-系统-关于-高级系统设置-环境变量"中添加Python安装路径;Linux/Mac用户可以在~/.bashrc~/.zshrc中添加export PATH=$PATH:/usr/local/python3/bin(替换为实际路径)。

二、基础调用:使用 Runtime.exec()

这是最直接的调用方式,通过Java的Runtime类启动Python进程执行脚本。适合简单场景,无需复杂交互。

2.1 实现步骤

步骤1:编写Python脚本

创建hello.py,放在Java项目的根目录(或指定绝对路径):

python 复制代码
# 接收Java传递的参数
import sys

if __name__ == "__main__":
    # 获取Java传入的参数(第0个参数是脚本名)
    name = sys.argv[1] if len(sys.argv) > 1 else "World"
    # 输出结果(会被Java捕获)
    print(f"Hello, {name}! From Python")

步骤2:编写Java调用代码

创建JavaCallPythonByRuntime.java

java 复制代码
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;

public class JavaCallPythonByRuntime {
    public static void main(String[] args) {
        // 1. 定义Python脚本路径和参数
        String pythonScriptPath = "hello.py";
        String param = "Java";  // 要传递给Python的参数

        // 2. 构建命令数组(推荐用数组形式,避免空格问题)
        String[] cmd = new String[]{"python", pythonScriptPath, param};

        try {
            // 3. 启动Python进程
            Process process = Runtime.getRuntime().exec(cmd);

            // 4. 读取Python的输出(必须读取,否则可能导致进程阻塞)
            InputStream inputStream = process.getInputStream();
            BufferedReader reader = new BufferedReader(
                new InputStreamReader(inputStream, "UTF-8")  // 指定编码,避免中文乱码
            );
            String line;
            while ((line = reader.readLine()) != null) {
                System.out.println("Python输出:" + line);
            }

            // 5. 等待进程执行完成并获取退出码(0表示成功)
            int exitCode = process.waitFor();
            System.out.println("进程退出码:" + exitCode);

        } catch (IOException | InterruptedException e) {
            e.printStackTrace();
        }
    }
}

2.2 代码解析

  • 命令数组 :用String[]而不是单字符串,避免路径或参数包含空格时解析错误(比如脚本路径是D:\my script\hello.py)。
  • 输入流处理 :Python的print输出会写入进程的输入流,Java必须读取这些内容,否则缓冲区满了会导致进程卡住。
  • 编码设置InputStreamReader指定UTF-8,解决Windows系统下默认GBK编码导致的中文乱码问题。
  • 退出码process.waitFor()返回的退出码能帮我们判断脚本是否正常执行(非0通常表示出错)。

三、进阶调用:使用 ProcessBuilder

ProcessBuilder是JDK 5引入的类,比Runtime.exec()更灵活,支持设置工作目录、环境变量等,适合复杂场景。

3.1 实现步骤

步骤1:复用Python脚本

继续使用前面的hello.py,稍作修改支持从环境变量读取配置:

python 复制代码
import sys
import os

if __name__ == "__main__":
    name = sys.argv[1] if len(sys.argv) > 1 else "World"
    # 读取Java设置的环境变量
    app_name = os.getenv("APP_NAME", "UnknownApp")
    print(f"[{app_name}] Hello, {name}! From Python")

步骤2:编写Java代码

创建JavaCallPythonByProcessBuilder.java

java 复制代码
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.Map;

public class JavaCallPythonByProcessBuilder {
    public static void main(String[] args) {
        try {
            // 1. 创建ProcessBuilder,指定命令和参数
            ProcessBuilder pb = new ProcessBuilder(
                "python", "hello.py", "JavaDeveloper"
            );

            // 2. 设置工作目录(脚本所在目录,不设置则默认当前目录)
            pb.directory(new java.io.File("./scripts"));  // 假设脚本放在scripts子目录

            // 3. 设置环境变量(给Python脚本传递配置)
            Map<String, String> env = pb.environment();
            env.put("APP_NAME", "JavaCallPythonDemo");

            // 4. 重定向错误流到输入流(方便统一处理输出和错误)
            pb.redirectErrorStream(true);

            // 5. 启动进程
            Process process = pb.start();

            // 6. 读取输出
            try (BufferedReader reader = new BufferedReader(
                new InputStreamReader(process.getInputStream(), "UTF-8")
            )) {
                String line;
                while ((line = reader.readLine()) != null) {
                    System.out.println("Python输出:" + line);
                }
            }

            // 7. 等待进程完成
            int exitCode = process.waitFor();
            System.out.println("进程退出码:" + exitCode);

        } catch (IOException | InterruptedException e) {
            e.printStackTrace();
        }
    }
}

3.2 代码解析

  • 工作目录pb.directory()指定脚本所在目录,避免路径混乱。比如脚本放在./scripts,就不用写全路径了。
  • 环境变量 :通过pb.environment()设置的变量,Python可以用os.getenv()获取,适合传递配置信息(如API密钥、环境标识)。
  • 错误流重定向redirectErrorStream(true)将错误信息合并到输入流,不用单独处理getErrorStream(),简化代码。
  • 资源自动关闭try-with-resources语法确保BufferedReader自动关闭,避免资源泄漏。

四、服务化调用:HTTP接口通信

当Java和Python需要频繁交互,或需要跨服务器调用时,将Python脚本封装成HTTP服务是更优的方案。这里用Flask搭建简单接口。

4.1 实现步骤

步骤1:搭建Python HTTP服务

首先安装Flask:

bash 复制代码
pip install flask

创建hello_service.py

python 复制代码
from flask import Flask, request

app = Flask(__name__)

@app.route('/hello', methods=['GET'])
def hello():
    # 从请求参数获取name
    name = request.args.get('name', 'World')
    return f"Hello, {name}! From Python Service"

if __name__ == '__main__':
    # 启动服务,允许外部访问
    app.run(host='0.0.0.0', port=5000, debug=True)

步骤2:编写Java HTTP客户端

创建JavaCallPythonByHttp.java,使用JDK自带的HttpClient(JDK 11+):

java 复制代码
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.time.Duration;

public class JavaCallPythonByHttp {
    public static void main(String[] args) {
        // 1. 创建HttpClient
        HttpClient client = HttpClient.newBuilder()
                .connectTimeout(Duration.ofSeconds(5))
                .build();

        // 2. 构建请求(Python服务地址)
        String name = "JavaHttpClient";
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("http://localhost:5000/hello?name=" + name))
                .timeout(Duration.ofSeconds(3))
                .GET()
                .build();

        try {
            // 3. 发送请求并获取响应
            HttpResponse<String> response = client.send(
                request, HttpResponse.BodyHandlers.ofString()
            );

            // 4. 处理响应
            if (response.statusCode() == 200) {
                System.out.println("Python服务响应:" + response.body());
            } else {
                System.err.println("请求失败,状态码:" + response.statusCode());
            }

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

4.2 代码解析

  • Python服务 :用Flask创建/hello接口,通过request.args获取Java传递的参数,返回字符串。debug=True方便开发时自动重启。
  • Java客户端 :JDK 11的HttpClient比传统的HttpURLConnection更简洁,支持异步调用(sendAsync),这里用同步send更直观。
  • 跨机器调用 :只要Python服务的host设为0.0.0.0,并开放5000端口,Java可以通过服务器IP访问(如http://192.168.1.100:5000/hello)。

五、三种方法对比与选择建议

调用方式 优点 缺点 适用场景
Runtime.exec() 简单直接,无需额外依赖 灵活性差,不便于设置环境和工作目录 简单脚本,一次性调用
ProcessBuilder 支持环境变量、工作目录,错误流合并 代码稍复杂,仍需处理进程通信 复杂脚本,需要传递配置信息
HTTP接口 松耦合,支持跨机器,可异步 需要维护HTTP服务,有网络开销 频繁交互,分布式系统,跨语言调用

实际开发中:

  • 临时脚本调用用ProcessBuilder
  • 长期维护的功能推荐HTTP服务化,便于独立部署和升级;
  • 避免在高并发场景用进程调用(频繁创建销毁进程开销大)。

六、避坑指南

  1. 路径中的空格 :Windows路径如果有空格(如Program Files),用ProcessBuilder时会自动处理,但用Runtime.exec()单字符串命令可能出错,推荐始终用数组形式传参。

  2. Python输出缓冲区:如果Python脚本输出大量内容,会先存到缓冲区,Java读取不及时会导致脚本卡住。解决方法:

    • Python中手动刷新缓冲区:print(..., flush=True)
    • Java中用线程异步读取输出
  3. 版本兼容:确保Java调用的Python版本和开发时一致(比如同时用Python 3.9),避免语法不兼容问题。

  4. 异常捕获 :生产环境中必须捕获所有可能的异常(IOExceptionInterruptedException等),并记录日志,方便排查问题。

总结

本文介绍了三种Java调用Python脚本实现HelloWorld的方法,从简单的进程调用到服务化通信,覆盖了不同场景的需求。核心是根据项目实际情况选择合适的方案:简单场景用ProcessBuilder,分布式场景用HTTP接口。

实际开发中,建议先做小范围测试,重点关注参数传递、异常处理和性能表现。只要把这些细节处理好,Java和Python的协作会非常顺畅。

相关推荐
BillKu15 分钟前
Spring Boot 3中JWT密钥安全存储方案
spring boot·后端·安全
找不到、了40 分钟前
Java设计模式之《原型模式》--深、浅copy
java·设计模式·原型模式
独泪了无痕42 分钟前
一文搞懂MyBatis中的TypeHandler
数据库·后端·mybatis
蜀中廖化44 分钟前
机器学习:基于OpenCV和Python的智能图像处理 实战
python·opencv·机器学习
java1234_小锋2 小时前
一周学会Matplotlib3 Python 数据可视化-绘制热力图(Heatmap)
开发语言·python·信息可视化·matplotlib·matplotlib3
R-G-B3 小时前
【P27 4-8】OpenCV Python——Mat类、深拷贝(clone、copyTo、copy)、浅拷贝,原理讲解与示例代码
人工智能·python·opencv·浅拷贝·深拷贝·opencv python·mat类
etcix3 小时前
wrap cpp variant as dll for c to use
java·c语言·开发语言
我在北国不背锅4 小时前
基于Java的Markdown转Word工具(标题、段落、表格、Echarts图等)
java·word·echarts·markdown