Node-Java 项目技术文档

本文档将详细介绍如何安装、使用以及调用 Node-Java 项目，帮助用户更好地理解和使用该项目的功能。

1. 安装指南

安装 Node-Java

要安装 Node-Java，请执行以下命令：

npm install java

确保你的系统中已安装 Node.js。

注意事项

• Node-gyp 需要使用 Python 2.x，而不是 Python 3.x。如果遇到相关问题，请参考 node-gyp issues。
• 如果安装时出现 "Call to 'node findJavaHome.js' returned exit status 1" 错误，尝试在 node-java 目录下运行 node findJavaHome.js 查看完整的错误信息。
• 如果遇到 "jni.h" 找不到的问题，确保已安装 JDK 而不仅是 JRE。如果你使用 OpenJDK，请安装 openjdk-7-jdk 包，而不是 openjdk-7-jre。

2. 项目使用说明

Node-Java 提供了一个桥接 API，用于连接现有的 Java API。以下是一些基本的使用示例：

推荐项目

• node-java-maven：使用 Maven 依赖管理来管理 node-java 的类路径。

快速示例

var java = require("java");
java.classpath.push("commons-lang3-3.1.jar");
java.classpath.push("commons-io.jar");

var list1 = java.newInstanceSync("java.util.ArrayList");
console.log(list1.sizeSync()); // 0
list1.addSync('item1');
console.log(list1.sizeSync()); // 1

3. 项目 API 使用文档

以下是 Node-Java 的一些常用 API 方法：

创建对象

var list = java.newInstanceSync("java.util.ArrayList");

添加元素到列表

list.addSync('item1');

获取列表大小

console.log(list.sizeSync()); // 输出列表大小

异步方法

java.newInstance("java.util.ArrayList", function(err, list) {
  if (err) throw err;
  list.addSync("item1");
  list.addSync("item2");
  console.log(list.toStringSync()); // [item1, item2]
});

使用 Java 类

var ArrayList = java.import('java.util.ArrayList');
var list3 = new ArrayList();
list3.addSync('item1');
list3.equalsSync(list1); // true

异常处理

try {
  java.methodThatThrowsExceptionSync();
} catch(ex) {
  console.log(ex.cause.getMessageSync());
}

异步选项

var java = require("java");
java.asyncOptions = {
  asyncSuffix: undefined,
  syncSuffix: "",
  promiseSuffix: "Promise",
  promisify: require('util').promisify
};

4. 项目安装方式

以下是 Node-Java 的不同安装方式：

Ubuntu 安装

sudo apt install make g++
npm i -g java --unsafe-perm

OSX 安装

如果遇到运行时问题，可能是因为 Oracle JDK 没有将自己广告为可用于 JNI。请参考 Issue 90 了解更多信息。

Windows 安装

确保在 64 位安装中使用 32 位 JDK。

Docker

docker run -it joeferner/node-java bash

然后在内置 Docker 容器中创建一个目录，并运行：

npm install --unsafe-perm java

Java 1.8 支持

手动编译 Java 1.8 支持需要执行以下步骤：

./compile-java-code.sh
./compile-java8-code.sh
node-gyp configure build
npm test

以上就是 Node-Java 项目的安装指南、使用说明以及 API 使用文档。希望对用户有所帮助。