跨越语言边界—Java如何调用JavaScript函数

相信很多人都听过这个样一个笑话：

Java 和 JavaScript 有什么关系？

它们俩的关系就好像 雷锋 和雷峰塔一样。

前不久，作者在开发一个新的项目时，就遇上了这样一个不常见的需求：甲方要求所有的数据传输，都必须通过指定的js文件进行加密与解密。因为作者本身是Java开发人员，很少接触JS。项目初期，我一度考虑专门开辟一个服务进行加密解密使用，但是后来网上一搜索，发现Java 调用 JavaScript 的方案已经特别成熟了。今天，我们就来探究Java 究竟是如何运行 JavaScript 代码的。

前置知识

Java与JavaScript之间的互操作性一直是开发领域中的一个关键问题。为了实现这种互操作性，开发人员已经开发了多种技术和方法，使Java能够调用JavaScript函数并与JavaScript代码交互。

1. Java applets： 在早期的Web开发中，Java applets是一种常见的技术，允许Java代码嵌入到Web页面中，与JavaScript代码进行通信。通过Java applets，Java代码可以通过JavaScript调用浏览器中的JavaScript函数，实现与页面的交互。
2. Rhino引擎： Rhino是Mozilla基金会开发的纯Java JavaScript引擎。它允许Java代码与JavaScript代码无缝交互，通过Rhino可以在Java中执行JavaScript函数，同时可以将Java对象传递给JavaScript并获取JavaScript返回的结果。
3. GraalVM： GraalVM是一个高性能的多语言虚拟机，包括了JavaScript引擎。它使用即时编译技术，通常比Rhino和Java标准库的javax.script包性能更好。GraalVM不仅支持Java与JavaScript的互操作，还支持多种其他语言，使得多语言交互变得更加容易。
4. Nashorn（已弃用）： 在Java 8及更早的版本中，Nashorn是默认的JavaScript引擎，允许Java与JavaScript交互。然而，由于性能问题，Nashorn在Java 11中被标记为不推荐使用，并在Java 15中被删除。

因为目前大部分的开发同时使用的仍然是Java 8，因此本片文章的讲解，还是以 Nashorn 引擎为例。

示例代码

首先直接展示一下demo code:

 public static void main(String[] args) throws ScriptException, NoSuchMethodException {
        ScriptEngine engine = new ScriptEngineManager().getEngineByName("JavaScript");
        engine.eval("function juejinDemo(name) { return 'Hello, ' + name + '!'; }");
        Invocable invocable = (Invocable) engine;
        String result = (String) invocable.invokeFunction("juejinDemo", "juejin");
        System.out.println(result);
    }

具体的：

1. ScriptEngine engine = new ScriptEngineManager().getEngineByName("JavaScript")

   首先，创建了一个ScriptEngine实例，这个实例用于执行JavaScript代码。通过ScriptEngineManager来获取，通过getEngineByName指定引擎的名称为"JavaScript"，这样就获得了JavaScript引擎的实例。

2. engine.eval("function juejinDemo(name) { return 'Hello, ' + name + '!'; }");

   接下来，使用engine.eval()方法执行了一段JavaScript代码。这段JavaScript代码定义了一个名为juejinDemo的函数，该函数接受一个参数name，并返回一个拼接了问候词的字符串。

3. Invocable invocable = (Invocable) engine;

   将ScriptEngine实例强制转换为Invocable类型。Invocable是javax.script包中的一个接口，用于在Java代码中调用脚本函数。

4. String result = (String) invocable.invokeFunction("juejinDemo", "juejin");

   使用invocable.invokeFunction()方法调用之前在JavaScript中定义的函数。这里我们调用了juejinDemo函数，传递了一个字符串参数"juejin"。invokeFunction方法返回了函数执行的结果，这里是一个字符串。

详细讲解

我们从示例代码中，可以得到几个重要的函数：

• new ScriptEngineManager().getEngineByName("JavaScript")
  这段代码的目的是根据传入的脚本引擎名称（短名称）查找并返回对应的脚本引擎实例。
  我按照源码进行了整理，具体的实现逻辑如下图：

具体的：

1. 首先检查传入的shortName参数是否为null，如果是，则抛出NullPointerException异常。这是为了确保传入的参数不为空。
2. 接下来尝试从已注册的引擎名称中查找与传入的shortName匹配的引擎。这是通过nameAssociations对象实现的，其中存储了引擎名称与引擎工厂（ScriptEngineFactory）之间的关联关系。如果找到匹配的引擎名称，它获取相应的工厂，并通过工厂创建一个脚本引擎。然后，它将全局绑定（Bindings）设置到脚本引擎中，以确保脚本引擎在执行时可以访问这些绑定。最后，它返回创建的脚本引擎实例。
3. 如果在已注册的引擎名称中没有找到匹配，它会继续搜索未注册的引擎名称。它遍历engineSpis，这是一个包含所有已安装脚本引擎工厂（ScriptEngineFactory）的列表。对于每个工厂，它尝试获取工厂支持的引擎名称列表，并检查是否有与传入的shortName匹配的名称。如果找到匹配的引擎名称，它使用工厂创建脚本引擎，并将全局绑定设置到脚本引擎中。
4. 如果遍历完所有的引擎工厂仍然没有找到匹配的引擎，最终返回null，表示未找到匹配的脚本引擎。

• engine.eval("function juejinDemo(name) { return 'Hello, ' + name + '!'; }")

  调用ScriptEngine的eval方法，该方法接受一个字符串参数，其中包含要执行的JavaScript代码。
  当调用engine.eval()方法来执行JavaScript代码时，Nashorn首先会对传递的JavaScript代码进行词法分析和语法分析，将其转换为抽象语法树（AST）。然后，Nashorn会将AST编译成可执行的字节码。

• invocable.invokeFunction("juejinDemo", "juejin")

  invokeFunction 方法被调用，在 JavaScript 引擎中查找名为 "juejinDemo" 的函数，然后将传递的参数 "juejin" 传递给该函数。

如何在项目中实际使用

在实际项目中如何选择JavaScript引擎是一个值得再写一篇文章的内容。就之前调研和实际的使用中，作者建议，如果你真的有使用Java调用JavaScript 的需求的时候，需要考虑以下内容：

1. 是否接受额外的项目依赖

   javax.script是Java标准库的一部分，因此无需额外的依赖。而Rhino和GraalVM 都需要进行jar包引入。如果只需要基本的脚本执行能力，javax.script包足够了。

2. 处理的数据是否对性能要求较大

   javax.script包通常比其他专门的脚本引擎性能稍低，特别是对于大型和复杂的脚本。而 Rhino 和 GraalVM 都拥有众多的引擎优化，如果需要更高性能和更强大的JavaScript支持，Rhino或GraalVM可能更适合你的项目。 GraalVM特别适用于多语言应用程序和需要高性能的情况。

总结

Java调用JavaScript虽然在日常开发中相对较小众，但仍然具有重要性，并且在某些场景下不可或缺。这种技术可以扩展Java应用程序的功能，特别是在与前端开发有关的项目中。我们应深入了解所使用的技术，考虑性能、安全性和维护性等因素。此外，应根据项目的具体需求和复杂性来决定是否使用Java与JavaScript的互操作性。