如何通过JNI从Rust调用Java方法？

时间：2019-06-30 00:45:09

标签： rust java-native-interface

我有一个Java库，其中的类com.purplefrog.batikExperiment.ToPixels具有方法static void renderToPixelsShape3(int width, int height, byte[] rgbs)。调用Java方法和访问新填充的rgbs数组需要什么Rust代码？

我打算从Rust ToPixels.renderToPixelsShape3函数调用main()，因此Rust代码将必须构造JNI环境。

3 个答案:

答案 0 :(得分：3)

这是一个简单的单文件项目，以演示如何使用jni crate：

Java方面

package org.example.mcve.standalone;

public class Mcve {
    static {
        System.load("/Users/svetlin/CLionProjects/mcve/target/debug/libmcve.dylib");
    }

    public static void main(String[] args) throws Exception {
        doStuffInNative();
    }

    public static native void doStuffInNative();

    public static void callback() {
        System.out.println("Called From JNI");
    }
}

  1. 在启动时加载本机库。我正在使用load，它需要一个绝对路径。另外，您可以使用loadLibrary，它仅需要库的名称，但是另一方面，它需要位于特定的位置。

  2. 为了能够从Java调用本机方法，您必须找到要在库中使用的签名。为此，您必须生成一个C头文件。这可以通过以下方式完成：

cd src/main/java/org/example/mcve/standalone/

javac -h Mcve.java

因此，您应该获得一个看起来像

的文件 
/* DO NOT EDIT THIS FILE - it is machine generated */
#include <jni.h>
/* Header for class org_example_mcve_standalone_Mcve */

#ifndef _Included_org_example_mcve_standalone_Mcve
#define _Included_org_example_mcve_standalone_Mcve
#ifdef __cplusplus
extern "C" {
#endif
/*
 * Class:     org_example_mcve_standalone_Mcve
 * Method:    doStuffInNative
 * Signature: ()V
 */
JNIEXPORT void JNICALL Java_org_example_mcve_standalone_Mcve_doStuffInNative
  (JNIEnv *, jclass);

#ifdef __cplusplus
}
#endif
#endif

铁锈一面

现在我们知道所需的方法签名了，我们可以创建Rust库！首先使用crate_type = "cdylib"创建一个Cargo.toml：

[package]
name = "mcve"
version = "0.1.0"
authors = ["Svetlin Zarev <svetlin.zarev@hidden.com>"]
edition = "2018"

[dependencies]
jni = "0.12.3"

[lib]
crate_type = ["cdylib"]

然后添加一个包含以下内容的lib.rs文件：

use jni::objects::JClass;
use jni::JNIEnv;

#[no_mangle]
#[allow(non_snake_case)]
pub extern "system" fn Java_org_example_mcve_standalone_Mcve_doStuffInNative(
    env: JNIEnv,
    _class: JClass,
) {
    let class = env
        .find_class("org/example/mcve/standalone/Mcve")
        .expect("Failed to load the target class");
    let result = env.call_static_method(class, "callback", "()V", &[]);

    result.map_err(|e| e.to_string()).unwrap();
}

请注意，我们使用了生成的头文件中的丑陋方法名称和签名。否则，JVM将无法找到我们的方法。

首先，我们加载所需的类。在这种情况下，这实际上不是必需的，因为我们传递了与名为_class的参数相同的类。然后，我们使用收到的env作为参数调用所需的java方法。

第一个参数是目标类。

第二个-目标方法名称。

第三个-描述参数类型和返回值：(arguments)return-type。您可以找到有关该语法和奥秘字母here的更多信息，在我们的情况下，我们没有任何参数，返回类型为V，这意味着VOID

第四个-包含实际参数的数组。由于该方法不会产生任何结果，因此我们传递了一个空数组。

现在构建Rust库，然后运行Java应用程序。结果，您必须在终端机Called From JNI

中看到

从main()在Rust中调用Java

首先，您必须生成一个JVM实例。您必须在jni crate上使用“调用”功能：

[dependencies.jni]
version = "0.12.3"
features = ["invocation", "default"]

您可能想使用.option()自定义jvm设置：

fn main() {
    let jvm_args = InitArgsBuilder::new()
        .version(JNIVersion::V8)
        .option("-Xcheck:jni")
        .build()
        .unwrap();

    let jvm = JavaVM::new(jvm_args).unwrap();
    let guard = jvm.attach_current_thread().unwrap();

    let system = guard.find_class("java/lang/System").unwrap();
    let print_stream = guard.find_class("java/io/PrintStream").unwrap();

    let out = guard
        .get_static_field(system, "out", "Ljava/io/PrintStream;")
        .unwrap();

    if let JValue::Object(out) = out {
        let message = guard.new_string("Hello World").unwrap();
        guard
            .call_method(
                out,
                "println",
                "(Ljava/lang/String;)V",
                &[JValue::Object(message.into())],
            )
            .unwrap();
    }
}

除了我们现在使用AttachGuard来调用Java方法而不是传递的JNIEnv对象之外，其他所有东西都是相同的。

这里最棘手的部分是在启动Rust应用程序之前正确设置LD_LIBRARY_PATH环境变量，否则它将无法找到libjvm.so。以我为例：

export LD_LIBRARY_PATH=/usr/lib/jvm/java-1.11.0-openjdk-amd64/lib/server/

但系统上的路径可能不同

答案 1 :(得分：2)

或者，您可以使用j4rs。

某种程度上“复杂”的东西是Java字节数组的创建。否则，其他一切都非常简单：

在Cargo.toml中：

j4rs = "0.12.0"

您的Rust主界面：

use std::convert::TryFrom;
use j4rs::{Instance, InvocationArg, Jvm, JvmBuilder};

fn main() -> Result<(), J4RsError> {
    // Create a Jvm
    let jvm = JvmBuilder::new().build()?;
    // Create the values for the byte array
    let rgbs: Vec<InvocationArg> = [0i8; 400 * 400 * 3]
       .iter()
       .map(|r| InvocationArg::try_from(r).unwrap()
                .into_primitive().unwrap())
       .collect();

    // Create a Java array from the above values
    let byte_arr = jvm.create_java_array("byte", &rgbs)?;
    // Invoke the static method
    jvm.invoke_static(
        "com.purplefrog.batikExperiment.ToPixels",
        "renderToPixelsShape3",
        &[
            InvocationArg::try_from(33_i32)?.into_primitive()?,
            InvocationArg::try_from(333_i32)?.into_primitive()?,
            InvocationArg::try_from(byte_arr)?
        ])?;

    Ok(())
}

答案 2 :(得分：0)

以Svetlin Zarev的回答为起点，我设法对此进行了扩展，并弄清楚了如何回答其余问题。我不认为这是一个明确的答案，因为我认为仍然存在缺点，因为我所做的只是用石头砸了，直到似乎起作用。

Cargo.toml是：

[package]
name = "rust_call_jni"
version = "0.1.0"
authors = ["Robert Forsman <git@thoth.purplefrog.com>"]
edition = "2018"


[dependencies.jni]
version="0.12.3"
features=["invocation"]

main.rs的第一部分几乎与Svetlin的相同：

use jni::{InitArgsBuilder, JNIVersion, JavaVM, AttachGuard, JNIEnv};
use jni::objects::{JValue, JObject};

fn main() -> Result<(), jni::errors::Error>
{
    let jvm_args = InitArgsBuilder::new()
            .version(JNIVersion::V8)
            .option("-Xcheck:jni")
            .option(&format!("-Djava.class.path={}", heinous_classpath()))
            .build()
            .unwrap_or_else(|e|
            panic!("{}", e));

    let jvm:JavaVM = JavaVM::new(jvm_args)?;

    let env:AttachGuard = jvm.attach_current_thread()?;
    let je:&JNIEnv = &env; // this is just so intellij's larval rust plugin can give me method name completion

    let cls = je.find_class("com/purplefrog/batikExperiment/ToPixels").expect("missing class");

由于我打算调用static void renderToPixelsShape3(int width, int height, byte[] rgbs)而不是System.out.println(String)，因此代码开始分歧：

let width = 400;
let height = 400;
let rgbs = env.new_byte_array(width*height*3)?;
let rgbs2:JObject = JObject::from(rgbs);

let result = je.call_static_method(cls, "renderToPixelsShape3", "(II[B)V", &[
    JValue::from(width),
    JValue::from(height),
    JValue::from(rgbs2),
])?;

println!("{:?}", result);

let blen = env.get_array_length(rgbs).unwrap() as usize;
let mut rgbs3:Vec<i8> = vec![0; blen];
println!("byte array length = {}", blen);

env.get_byte_array_region(rgbs, 0, &mut rgbs3)?;

我不确定我是否正确地完成了阵列复制，但是它似乎可以正常工作。经验丰富的Rust / Java编码器可能会发现一些错误（并发表评论）。

然后总结一下这个毛发，让我们将字节写到文件中，以便我们可以在GIMP中查看图像：

    {
        use std::fs::File;
        use std::path::Path;
        use std::io::Write;
        let mut f = File::create(Path::new("/tmp/x.ppm")).expect("why can't I create the image file?");
        f.write_all(format!("P6\n{} {} 255\n", width, height).as_bytes()).expect("failed to write image header");
        let tmp:&[u8] =unsafe { &*(rgbs3.as_slice() as *const _ as *const [u8])};
        f.write_all( tmp).expect("failed to write image payload");
        println!("wrote /tmp/x.ppm");
    }

    return Ok(());
}

请告诉我有一个更好的方式来写Vec<i8>到一个文件中（因为尽管这是该解决方案，展示了在谷歌的搜索结果让我伤心诉诸于unsafe块） 。

我省略了heinous_classpath()的定义，因为那只是类路径的大约30个jar的列表。我想知道一个maven命令行来为我计算这些代码，而无需进行应用程序组装并将它们从shell脚本中复制出来，但这是一个不同的Google搜索。

我要重申的是，我希望研究锈蚀超过3周的人可以改进此代码。

相关问题
最新问题