JAVA执行javascript方法，执行js表达式，执行js函数，不仅能执行函数，还可以传递参数，java对象注入到js代码中运行，java通过线程启动js函数eval，invokeFunction

傷城~ 2023-10-10 15:05 34阅读 0赞

之前在一次机缘巧合的情况下，需要时用JAVA执行js方法，查阅了一些文档，找到了相关解决方法，这里和大家分享一下。  
在JDK1.6中为我们提供了一个`ScriptEngineManager`类，ScriptEngineManager 为 ScriptEngine 类实现一个发现和实例化机制，还维护一个键/值对[集合][Link 1]来存储所有 Manager 创建的引擎所共享的状态。此类使用服务提供者机制枚举所有的 ScriptEngineFactory 实现。  
ScriptEngineManager 提供了一个方法，可以返回一个所有工厂实现和基于语言名称、文件扩展名和 mime 类型查找工厂的实用方法所组成的数组。  
键/值对的 Bindings（即由管理器维护的 “Global Scope”）对于 ScriptEngineManager 创建的所有 ScriptEngine 实例都是可用的。Bindings 中的值通常公开于所有脚本中。

通过上面的描述，我们就应该知道了，需要时用到的类为`ScriptEngineManager`和`ScriptEngine`。

我们先来看一下`ScriptEngineManager`，

构造方法如下：

<table> 
 <thead> 
  <tr> 
   <th>方法名</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>ScriptEngineManager()</td> 
   <td>如果调用者可访问线程上下文 ClassLoader，则调用此构造方法的效果与调用 ScriptEngineManager(Thread.currentThread().getContextClassLoader()) 相同</td> 
  </tr> 
  <tr> 
   <td>ScriptEngineManager(ClassLoader loader)</td> 
   <td>此构造方法使用服务调用者机制加载对于给定 ClassLoader 可见的 ScriptEngineFactory 实现</td> 
  </tr> 
 </tbody> 
</table>

方法摘要如下：

<table> 
 <thead> 
  <tr> 
   <th>返回值</th> 
   <th>方法名</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Object</td> 
   <td>get(String key)</td> 
   <td>获取 Global Scope 中指定键的值</td> 
  </tr> 
  <tr> 
   <td>Bindings</td> 
   <td>getBindings()</td> 
   <td>getBindings</td> 
  </tr> 
  <tr> 
   <td>ScriptEngine</td> 
   <td>getEngineByExtension(String extension)</td> 
   <td>查找并创建一个给定扩展的 ScriptEngine</td> 
  </tr> 
  <tr> 
   <td>ScriptEngine</td> 
   <td>getEngineByMimeType(String mimeType)</td> 
   <td>查找并创建一个给定 mime 类型的 ScriptEngine</td> 
  </tr> 
  <tr> 
   <td>ScriptEngine</td> 
   <td>getEngineByName(String shortName)</td> 
   <td>查找并创建一个给定名称的 ScriptEngine</td> 
  </tr> 
  <tr> 
   <td>List&lt;ScriptEngineFactory&gt;</td> 
   <td>getEngineFactories()</td> 
   <td>返回一个数组，该数组的元素是发现机制找到的所有 ScriptEngineFactory 类的实例</td> 
  </tr> 
  <tr> 
   <td>void</td> 
   <td>put(String key, Object value)</td> 
   <td>设置 Global Scope 中指定的键/值对</td> 
  </tr> 
  <tr> 
   <td>void</td> 
   <td>registerEngineExtension(String extension, ScriptEngineFactory factory)</td> 
   <td>注册一个 ScriptEngineFactory 来处理扩展</td> 
  </tr> 
  <tr> 
   <td>void</td> 
   <td>registerEngineMimeType(String type, ScriptEngineFactory factory)</td> 
   <td>注册一个 ScriptEngineFactory 来处理 mime 类型。</td> 
  </tr> 
  <tr> 
   <td>void</td> 
   <td>registerEngineName(String name, ScriptEngineFactory factory)</td> 
   <td>注册一个ScriptEngineFactory 来处理语言名称</td> 
  </tr> 
  <tr> 
   <td>void</td> 
   <td>setBindings(Bindings bindings)</td> 
   <td>setBindings 存储 globalScope 字段中的指定 Bindings</td> 
  </tr> 
 </tbody> 
</table>

我们首先来看一下，JDK为我们提供了哪些可用的脚本引擎工厂，写一段代码测试一下：

@Test
    public void getScriptEngineFactory()
    {
       ScriptEngineManager manager = new ScriptEngineManager();
       List<ScriptEngineFactory> factories = manager.getEngineFactories();
       for (ScriptEngineFactory factory : factories)
       {
          System.out.println(factory.getNames());
       }
    }

运行结果如下：
    
    [nashorn, Nashorn, js, JS, JavaScript, javascript, ECMAScript, ecmascript]

通过控制台输出的结果，我们知道JDK已经为我们实现了js相关的脚本引擎，我们直接使用就可以了，解决了引擎的问题，下面我们再来看看脚本引擎如何使用，这就需要`ScriptEngine`了。

ScriptEngine 是基础接口，该接口的方法在此规范的每个实现中都必须具有完整的功能。  
这些方法提供基本的脚本功能。为这个简单接口编写的应用程序应该对每个实现稍做修改就能够运行。这包括执行脚本的方法，以及设置和获取值的方法。  
这些值是两种类型的键/值对。组成第一种类型的键/值对中的键是此规范或个别实现中保留和定义的键。包含保留键的键/值对中的值具有指定的含义。  
另一种类型由那些创建 Java 语言 Bindings 的键/值对组成，值通常通过相应键或其装饰的形式用脚本表示。

方法摘要如下：

<table> 
 <thead> 
  <tr> 
   <th>返回值</th> 
   <th>方法名</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Bindings</td> 
   <td>createBindings()</td> 
   <td>返回一个未初始化的 Bindings</td> 
  </tr> 
  <tr> 
   <td>Object</td> 
   <td>eval(Reader reader)</td> 
   <td>除了脚本的源是以 Reader 形式提供的外，与 eval(String) 相同</td> 
  </tr> 
  <tr> 
   <td>Object</td> 
   <td>eval(Reader reader, Bindings n)</td> 
   <td>除了脚本的源是以 Reader 形式提供的外，与 eval(String, Bindings) 相同</td> 
  </tr> 
  <tr> 
   <td>Object</td> 
   <td>eval(Reader reader, ScriptContext context)</td> 
   <td>与 eval(String, ScriptContext) 相同，其中脚本的源是从 Reader 读取的</td> 
  </tr> 
  <tr> 
   <td>Object</td> 
   <td>eval(String script)</td> 
   <td>执行指定的脚本</td> 
  </tr> 
  <tr> 
   <td>Object</td> 
   <td>eval(String script, Bindings n)</td> 
   <td>执行脚本，脚本执行期间使用 Bindings 参数作为 ScriptEngine 的 ENGINE_SCOPE Bindings</td> 
  </tr> 
  <tr> 
   <td>Object</td> 
   <td>eval(String script, ScriptContext context)</td> 
   <td>立即执行脚本，该脚本的源是作为第一个参数传递的 String</td> 
  </tr> 
  <tr> 
   <td>Object</td> 
   <td>get(String key)</td> 
   <td>获取在此引擎的状态中设置的值</td> 
  </tr> 
  <tr> 
   <td>Bindings</td> 
   <td>getBindings(int scope)</td> 
   <td>返回指定值的范围</td> 
  </tr> 
  <tr> 
   <td>ScriptContext</td> 
   <td>getContext()</td> 
   <td>返回 ScriptEngine 的默认 ScriptContext，在没有指定 ScriptContext 时，该 ScriptEngine 的 Bindings、Reader 和 Writer 被用于脚本执行</td> 
  </tr> 
  <tr> 
   <td>ScriptEngineFactory</td> 
   <td>getFactory()</td> 
   <td>返回此 ScriptEngine 所属的类的 ScriptEngineFactory</td> 
  </tr> 
  <tr> 
   <td>void</td> 
   <td>put(String key, Object value)</td> 
   <td>设置 ScriptEngine 的状态中的键/值对，它创建一个将在脚本执行中使用或者以其他方式使用的 Java Language Binding，具体取决于该键是否被保留</td> 
  </tr> 
  <tr> 
   <td>void</td> 
   <td>setBindings(Bindings bindings, int scope)</td> 
   <td>设置将由脚本使用的指定值的范围。</td> 
  </tr> 
  <tr> 
   <td>void</td> 
   <td>setContext(ScriptContext context)</td> 
   <td>设置 ScriptEngine 的默认 ScriptContext，在没有指定 ScriptContext 时，该 ScriptEngine 的 Bindings、Reader 和 Writer 被用于脚本执行</td> 
  </tr> 
 </tbody> 
</table>

下面我们通过代码来演示具体的使用方法

首先我们先来看一下如何执行一段简单的js表达式：

@Test
    public void invokeExpression() throws ScriptException
    {
       ScriptEngineManager manager = new ScriptEngineManager();
       ScriptEngine engine = manager.getEngineByName("js");
       String js = "1 + 2";
       Integer result = (Integer) engine.eval(js);
       System.out.println(result);
    }

通过这段代码，我们很容易的就实现了java执行js的一段表达式。  
在java中，我们不仅可以运行js的表达式，我们还可以执行js函数

@Test
    public void invokeFunction() throws ScriptException, NoSuchMethodException
    {
       ScriptEngineManager manager = new ScriptEngineManager();
       ScriptEngine engine = manager.getEngineByName("js");
       String js = "function welcom(){return 'welcom';}";
       engine.eval(js);
       Invocable invocable = (Invocable) engine;
       String result = (String) invocable.invokeFunction("welcom");
       System.out.println(result);
    }

这里我们用到了`Invocable`接口，`Invocable`由 ScriptEngines 实现的可选接口，该 ScriptEngines 的方法允许在以前执行过的脚本中调用程序。当然啦，我们不仅能执行函数，还可以传递参数：

@Test
       public void invokeFunctionWithParam() throws ScriptException, NoSuchMethodException
    {
       ScriptEngineManager manager = new ScriptEngineManager();
       ScriptEngine engine = manager.getEngineByName("js");
       String js = "function welcom(name){return 'welcom ' + name;}";
       engine.eval(js);
       Invocable invocable = (Invocable) engine;
       String result = (String) invocable.invokeFunction("welcom", "jianggujin");
       System.out.println(result);
    }

除此之外，我们还可以将java对象注入到js代码中运行：

@Test
    public void inject() throws ScriptException, NoSuchMethodException
    {
       ScriptEngineManager manager = new ScriptEngineManager();
       ScriptEngine engine = manager.getEngineByName("js");
       Date date = new Date();
       System.out.println(date.getTime());
       engine.put("date", date);
       String js = "function getTime(){return date.getTime();}";
       engine.eval(js);
       Invocable invocable = (Invocable) engine;
       Long result = (Long) invocable.invokeFunction("getTime");
       System.out.println(result);
    }

是不是很神奇呢？下面再介绍一种更神奇的，java通过线程启动js函数：

public void runThread() throws ScriptException, NoSuchMethodException
    {
       ScriptEngineManager manager = new ScriptEngineManager();
       ScriptEngine engine = manager.getEngineByName("js");
       engine.put("out", System.out);
       String js = "var obj=new Object();obj.run=function(){out.println('thread...')}";
       engine.eval(js);
       Object obj = engine.get("obj");
       Invocable inv = (Invocable) engine;
       Runnable r = inv.getInterface(obj, Runnable.class);
       Thread t = new Thread(r);
       t.start();
    }

下面贴出完整的测试代码：

import java.util.Date;
    import java.util.List;
     
    import javax.script.Invocable;
    import javax.script.ScriptEngine;
    import javax.script.ScriptEngineFactory;
    import javax.script.ScriptEngineManager;
    import javax.script.ScriptException;
     
    /**
     * 运行javascript
     * 
     * @author jianggujin
     *
     */
    public class RunJavascript
    {
     
       public void getScriptEngineFactory()
       {
          ScriptEngineManager manager = new ScriptEngineManager();
          List<ScriptEngineFactory> factories = manager.getEngineFactories();
          for (ScriptEngineFactory factory : factories)
          {
             System.out.println(factory.getNames());
          }
       }
     
       public void invokeExpression() throws ScriptException
       {
          ScriptEngineManager manager = new ScriptEngineManager();
          ScriptEngine engine = manager.getEngineByName("js");
          String js = "1 + 2";
          Integer result = (Integer) engine.eval(js);
          System.out.println(result);
       }
     
       public void invokeFunction() throws ScriptException, NoSuchMethodException
       {
          ScriptEngineManager manager = new ScriptEngineManager();
          ScriptEngine engine = manager.getEngineByName("js");
          String js = "function welcom(){return 'welcom';}";
          engine.eval(js);
          Invocable invocable = (Invocable) engine;
          String result = (String) invocable.invokeFunction("welcom");
          System.out.println(result);
       }
     
       public void invokeFunctionWithParam() throws ScriptException, NoSuchMethodException
       {
          ScriptEngineManager manager = new ScriptEngineManager();
          ScriptEngine engine = manager.getEngineByName("js");
          String js = "function welcom(name){return 'welcom ' + name;}";
          engine.eval(js);
          Invocable invocable = (Invocable) engine;
          String result = (String) invocable.invokeFunction("welcom", "jianggujin");
          System.out.println(result);
       }
     
       public void inject() throws ScriptException, NoSuchMethodException
       {
          ScriptEngineManager manager = new ScriptEngineManager();
          ScriptEngine engine = manager.getEngineByName("js");
          Date date = new Date();
          System.out.println(date.getTime());
          engine.put("date", date);
          String js = "function getTime(){return date.getTime();}";
          engine.eval(js);
          Invocable invocable = (Invocable) engine;
          Long result = (Long) invocable.invokeFunction("getTime");
          System.out.println(result);
       }
     
       public void runThread() throws ScriptException, NoSuchMethodException
       {
          ScriptEngineManager manager = new ScriptEngineManager();
          ScriptEngine engine = manager.getEngineByName("js");
          engine.put("out", System.out);
          String js = "var obj=new Object();obj.run=function(){out.println('thread...')}";
          engine.eval(js);
          Object obj = engine.get("obj");
          Invocable inv = (Invocable) engine;
          Runnable r = inv.getInterface(obj, Runnable.class);
          Thread t = new Thread(r);
          t.start();
       }
     
       public static void main(String[] args) throws NoSuchMethodException, ScriptException
       {
          new RunJavascript().runThread();
       }
     
    }

[Link 1]: https://so.csdn.net/so/search?q=%E9%9B%86%E5%90%88&spm=1001.2101.3001.7020