Python使用jpype的踩坑記錄

更新時間：2023年06月20日 09:57:55 作者：一夜奈何梁山

Pype是一個能夠讓 python 代碼方便地調用 Java 代碼的工具，這篇文章主要來和大家分享一下Python使用jpype會踩的一些坑，希望對大家有所幫助

一：需求

近期接到一個需求，對方部門給了java的jar包和demo。要求我們與他們進行HTTP通信需要使用他們的Java寫的加解密算法進行加密和簽名。我們的服務全部都是PY寫的，因此如果使用PY對對方提供的jar包進行重寫，風險大，而且開發(fā)周期長。為了快速的解決這樣的問題，我們采用另外的解決方案----- 使用jpype用py直接調用java的jar包。

二：jpype介紹

用途：python調用java包的工具

安裝：pip install JPype1

官方文檔：https://jpype.readthedocs.io/en/latest/userguide.html

依賴環(huán)境：服務器上必須具備Java環(huán)境，如果是容器化部署，需要先安裝Java。

三：jpype的使用

封裝jarloader.py 來啟動jvm和加載java的類。

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @Time   : 2023/4/4 11:36
# @Author : shanwen.ren@xiaoying.com
# @Notice : java包加載工具
import jpype
from threading import RLock


class JarLoader:
    __rlock = RLock()
    __started = False

    @classmethod
    def start_jvm(cls, classpath, *args):
        if cls.__started:
            return
        with cls.__rlock:
            if not cls.__started:
            	# 加載JVM, 在系統(tǒng)中自動查找
                jvmPath = jpype.getDefaultJVMPath()
                base_args = [jvmPath, "-ea", "-Dfile.encoding=utf-8"]
                base_args += list(args) if args else []
                # 啟動JVM
                jpype.startJVM(*base_args, convertStrings=False, classpath=classpath)
                cls.__started = True

    @staticmethod
    def load_class(client_path):
    	# 加載jar包中的類， 返回類， 注意返回的不是對象。 
        Klass = jpype.JClass(client_path)
        return Klass

    @classmethod
    def close(cls):
        jpype.shutdownJVM()  
        cls.__started = False

使用注意事項

class_paths 是所有的jar包列表

例如：

dir_path = os.path.dirname(__file__)
client_sdk_path = os.path.join(dir_path, "java_jars/pd-client-sdk-1.2.jar")
bcprov_path = os.path.join(dir_path, "java_jars/bcprov-jdk15on-1.67.jar")
bcpkix_path = os.path.join(dir_path, "java_jars/bcpkix-jdk15on-1.67.jar")
gson_path = os.path.join(dir_path, "java_jars/gson-2.10.1.jar")
jsch_path = os.path.join(dir_path, "jsch-0.1.55.jar")
class_paths = [client_sdk_path, bcprov_path, bcpkix_path, gson_path, jsch_path]

client_path 是jar包中的實現(xiàn)類路徑

例如：client_path = “cn.aaa.sdk.service.impl.XXXX類”

四：類型轉換問題

由官方文檔可只，某些類型是可以自動轉換的，而有些是不能轉換的。

例如：java類需要傳遞一個Long類型，但是Py3中沒有Long類型了，如果直接調用，拋出類型不一致的問題。

解決方案： python的Int類型先轉換成Jlon類型，然后直接塞到Java的類中。

例如: jpype.JLong(file_size)

五：容器部署問題

容器化部署的時候，需要依賴Java環(huán)境。

解決方案： Dockerfile文件中增加一下指令。

先下載jdk包：我用的是：jdk-8u181-linux-x64.tar.gz

FROM python:3.8.8 AS builder
# 安裝JVM,配置JAVA環(huán)境變量
ADD jdk-8u181-linux-x64.tar.gz  /usr/local/jdk
ENV JAVA_HOME=/usr/local/jdk/jdk1.8.0_181 PATH=$JAVA_HOME/bin:$PATH CLASSPATH=.:$JAVA_HOME/lib/dt.jar:$JAVA_HOME/lib/tools.ja