Java 利用腳本API運行Groovy腳本的方式

Java運行腳本語言的方式(以Groovy爲例)

介紹

運用java Script API可以非常方便的運行能夠在JVM運行的腳本程序，並通過其腳本引擎進行參數傳遞等。

Java Scripting API 包含一組類和接口，在 javax.script 包中定義。這是一個相對比較小的 Java 包，以 ScriptEngineManager 類作爲起點。一個 ScriptEngineManager 對象可以通過 JAR 文件服務發現機制來查找腳本引擎(有點類似於JDBC, slf4J等)，而實例化 ScriptEngine 對象的解析腳本使用專門的腳本語言編寫。更多關於 javax.script 包的詳細信息請看 Java SE規範http://docs.oracle.com/javase/8/docs/api/javax/script/package-summary.html

使用方法

maven引入Groovy引擎依賴

<!-- for executing groovy script -->
<dependencies>
    <dependency>
        <groupId>org.codehaus.groovy</groupId>
        <artifactId>groovy</artifactId>
        <version>2.4.12</version>
    </dependency>
    <dependency>
        <groupId>org.codehaus.groovy</groupId>
        <artifactId>groovy-jsr223</artifactId>
        <version>2.4.12</version>
        <scope>runtime</scope>
    </dependency>
</dependencies>

使用ScriptEngineManager獲取對應語言的腳本引擎

ScriptEngineManager manager = new ScriptEngineManager();
ScriptEngine engine = manager.getEngineByName("groovy");

通過engine對象執行腳本語句，調用腳本對象方法等

Bindings bindings = engine.createBindings();
bindings.put("name", "Johnson");
engine.eval("def getName(){return name;}", bindings);

示例封裝代碼

import java.io.Reader;
import java.util.HashMap;
import java.util.Map;

import javax.script.Bindings;
import javax.script.Invocable;
import javax.script.ScriptEngine;
import javax.script.ScriptEngineManager;
import javax.script.ScriptException;

/**
 * 執行腳本工具
 * 
 * Created by xuyh at 2017年7月18日 上午11:05:49.
 */
public class ScriptUtils {
    /**
     * 腳本語言groovy
     */
    public static final String SCRIPT_GROOVY = "groovy";
    /**
     * 腳本語言javascript
     */
    public static final String SCRIPT_JAVASCRIPT = "javaScript";

    private static ScriptEngineManager engineManager = new ScriptEngineManager();
    /**
     * 腳本引擎緩存
     */
    private static Map<String, ScriptEngine> scriptEngineMap = new HashMap<>();

    /**
     * 獲取腳本引擎
     * 
     * @param scriptLang 腳本語言 (groovy, javaScript, etc.)
     * @return
     */
    public static ScriptEngine getEngine(String scriptLang) {
        ScriptEngine engine = scriptEngineMap.get(scriptLang);
        if (engine == null) {
            engine = engineManager.getEngineByName(scriptLang);
            scriptEngineMap.put(scriptLang, engine);
        }
        return engine;
    }

    /**
     * 執行腳本中的方法
     * 
     * @param scriptLang 腳本語言
     * @param script 需要執行的腳本文本
     * @param bindings 給腳本設置的全局變量數據
     * @param functionName 執行的方法名
     * @return
     * @throws ScriptException 
     * @throws NoSuchMethodException 
     */
    public static Object invokeScriptFunction(String scriptLang, String script, String functionName,
            Map<String, Object> bindings)
            throws ScriptException, NoSuchMethodException {
        ScriptEngine engine = getEngine(scriptLang);
        Bindings data = engine.createBindings();
        for (String key : bindings.keySet()) {
            data.put(key, bindings.get(key));
        }
        engine.eval(script, data);
        return ((Invocable) engine).invokeFunction(functionName);
    }

    /**
     * 執行腳本中的方法
     * 
     * @param scriptLang 腳本語言
     * @param script 需要執行的腳本文本
     * @param args 執行腳本方法傳入的參數
     * @param functionName 執行的方法名
     * @return
     * @throws ScriptException 
     * @throws NoSuchMethodException 
     */
    public static Object invokeScriptFunction(String scriptLang, String script, String functionName, Object... args)
            throws ScriptException, NoSuchMethodException {
        ScriptEngine engine = getEngine(scriptLang);
        engine.eval(script);
        return ((Invocable) engine).invokeFunction(functionName, args);
    }

    /**
     * 執行腳本中的方法
     * 
     * @param scriptLang 腳本語言
     * @param bindings 給腳本設置的全局變量數據
     * @param script 需要執行的腳本文本
     * @param args 執行腳本方法傳入的參數
     * @param functionName 執行的方法名
     * @return
     * @throws ScriptException 
     * @throws NoSuchMethodException 
     */
    public static Object invokeScriptFunction(String scriptLang, Map<String, Object> bindings, String script,
            String functionName,
            Object... args) throws ScriptException, NoSuchMethodException {
        ScriptEngine engine = getEngine(scriptLang);
        Bindings data = engine.createBindings();
        for (String key : bindings.keySet()) {
            data.put(key, bindings.get(key));
        }
        engine.eval(script, data);
        return ((Invocable) engine).invokeFunction(functionName, args);
    }

    /**
     * 執行腳本中的方法
     * 
     * @param scriptLang 腳本語言
     * @param reader 需要執行的腳本文件
     * @param bindings 給腳本設置的全局變量數據
     * @param functionName 執行的方法名
     * @return
     * @throws ScriptException 
     * @throws NoSuchMethodException 
     */
    public static Object invokeFileScriptFunction(String scriptLang, Reader reader, String functionName,
            Map<String, Object> bindings)
            throws ScriptException, NoSuchMethodException {
        ScriptEngine engine = getEngine(scriptLang);
        Bindings data = engine.createBindings();
        for (String key : bindings.keySet()) {
            data.put(key, bindings.get(key));
        }
        engine.eval(reader, data);
        return ((Invocable) engine).invokeFunction(functionName);
    }

    /**
     * 執行腳本中的方法
     * 
     * @param scriptLang 腳本語言
     * @param reader 需要執行的腳本文件
     * @param args 執行腳本方法傳入的參數
     * @param functionName 執行的方法名
     * @return
     * @throws ScriptException 
     * @throws NoSuchMethodException 
     */
    public static Object invokeFileScriptFunction(String scriptLang, Reader reader, String functionName, Object... args)
            throws ScriptException, NoSuchMethodException {
        ScriptEngine engine = getEngine(scriptLang);
        engine.eval(reader);
        return ((Invocable) engine).invokeFunction(functionName, args);
    }

    /**
     * 執行腳本中的方法
     * 
     * @param scriptLang 腳本語言
     * @param bindings 給腳本設置的全局變量數據
     * @param reader 需要執行的腳本文件
     * @param args 執行腳本方法傳入的參數
     * @param functionName 執行的方法名
     * @return
     * @throws ScriptException 
     * @throws NoSuchMethodException 
     */
    public static Object invokeFileScriptFunction(String scriptLang, Map<String, Object> bindings, Reader reader,
            String functionName,
            Object... args) throws ScriptException, NoSuchMethodException {
        ScriptEngine engine = getEngine(scriptLang);
        Bindings data = engine.createBindings();
        for (String key : bindings.keySet()) {
            data.put(key, bindings.get(key));
        }
        engine.eval(reader, data);
        return ((Invocable) engine).invokeFunction(functionName, args);
    }
}