Java執行groovy指令碼的兩種方式

蒲公英不是夢 發表於 2021-04-21

記錄Java執行groovy指令碼的兩種方式,簡單粗暴:

一種是通過指令碼引擎ScriptEngine提供的eval(String)方法執行指令碼內容;一種是執行groovy指令碼;

二者都通過Invocable來傳遞引數並獲取執行結果;

Invocable:指令碼引擎的直譯器介面,提供invokeFunctioninvokeMethod兩種傳遞引數並獲取執行結果的方法,Java JDK API文件解釋如下:
Java執行groovy指令碼的兩種方式

invokeFunction:
Java執行groovy指令碼的兩種方式

invokeMethod:
Java執行groovy指令碼的兩種方式

以下為案例:

引入依賴

<dependency>
	<groupId>org.codehaus.groovy</groupId>
	<artifactId>groovy-all</artifactId>
	<version>1.2.74</version>
</dependency>

定義指令碼內容並執行

public void testByFunction(){
    // 初始化Bindings
    Bindings bindings = engine.createBindings();
    // 繫結引數
    bindings.put("date", new Date());
    final String name = "groovy";
    // 定義groovy指令碼中執行方法的名稱
    final String scriptName = "execute";
    // 定義groovy指令碼內容
    final String scriptContent = "def " + scriptName +"(name){" +
                                 "    println(\"now dateTime is: ${date.getTime()}\");" +
                                 "    println(\"my name is $name\");" +
                                 "    return date.getTime() > 0;" +
                                 "}";
    try {
        // 執行指令碼
        engine.eval(scriptContent, bindings);
        // 獲取執行結果
        Invocable invocable = (Invocable) engine;
        Boolean flag = (Boolean) invocable.invokeFunction(scriptName, name);
        System.out.println("---------------------------------------");
        System.out.println("result is: " + flag);
    } catch (ScriptException | NoSuchMethodException e) {
        e.printStackTrace();
    }
}

執行結果:
Java執行groovy指令碼的兩種方式

  • invokeFunction方法的第一個引數為指令碼的函式名稱,把scriptName拎出來通過建立String物件再賦值進去,方便你看懂函式名稱到底是哪個;
  • scriptContent${date.getTime()}$name的意思一樣,grovvy中的字串可以識別${}$佔位符;
  • bindings繫結引數與invokeFunction方法的第二個引數的區別是,前者是指令碼內全域性的,而後者是定義在函式內的;

例如把指令碼內容定義為這樣:
Java執行groovy指令碼的兩種方式

執行結果就是這樣了:
Java執行groovy指令碼的兩種方式

例項化指令碼物件並執行

public void testByMethod(){
    try {
        // 初始化groovy指令碼物件
        final TestGroovy testGroovy = new TestGroovy();
        // 定義groovy指令碼中執行方法的名稱
        final String scriptName = "execute";
        // 定義引數
        final Date arg_1 = new Date();
        final String arg_2 = "groovy";
        // 執行指令碼並獲取結果
        Invocable invocable = (Invocable) engine;
        Boolean flag = (Boolean) invocable.invokeMethod(testGroovy, scriptName, arg_1, arg_2);
        System.out.println("---------------------------------------");
        System.out.println("result is: " + flag);
    } catch (ScriptException |NoSuchMethodException e) {
        e.printStackTrace();
    }
}

TestGroovy.groovy指令碼內容:

package com.dandelion.groovy

class TestGroovy {
   static def execute(Date date, String name){
        println("now dateTime is: ${date.getTime()}");
        println("my name is $name");
        return date.getTime() < 0;
    }
}

執行結果:
Java執行groovy指令碼的兩種方式

  • invokeMethod方法的第一個引數是指令碼物件,第二個引數是指令碼中的函式名稱,之後為繫結的引數;

原始碼:

package com.dandelion.test;

import com.dandelion.groovy.TestGroovy;

import javax.script.*;
import java.util.Date;

/**
 * ================================
 * 測試groovy指令碼的執行方式
 * @Author Him
 * @Date 2021-04-21
 * @Time 01:12
 * ================================
 */
public class TestScriptEngine {

    // 查詢並建立指定指令碼引擎
    private ScriptEngine engine = new ScriptEngineManager().getEngineByName("groovy");

    public void testByFunction(){
        // 初始化Bindings
        Bindings bindings = engine.createBindings();
        // 繫結引數
        bindings.put("date", new Date());
        // 定義groovy指令碼中執行方法的名稱
        final String scriptName = "execute";
        // 定義groovy指令碼內容
        final String scriptContent = "def " + scriptName +"(){" +
                                     "    println(\"now dateTime is: ${date.getTime()}\");" +
                                     "    return date.getTime() > 0;" +
                                     "}";
        try {
            // 執行指令碼
            engine.eval(scriptContent, bindings);
            // 獲取執行結果
            Invocable invocable = (Invocable) engine;
            Boolean flag = (Boolean) invocable.invokeFunction(scriptName);
            System.out.println("---------------------------------------");
            System.out.println("result is: " + flag);
        } catch (ScriptException | NoSuchMethodException e) {
            e.printStackTrace();
        }
    }

    public void testByMethod(){
        try {
            // 初始化groovy指令碼物件
            final TestGroovy testGroovy = new TestGroovy();
            // 定義groovy指令碼中執行方法的名稱
            final String scriptName = "execute";
            // 定義引數
            final Date arg_1 = new Date();
            final String arg_2 = "groovy";
            // 執行指令碼並獲取結果
            Invocable invocable = (Invocable) engine;
            Boolean flag = (Boolean) invocable.invokeMethod(testGroovy, scriptName, arg_1, arg_2);
            System.out.println("---------------------------------------");
            System.out.println("result is: " + flag);
        } catch (ScriptException |NoSuchMethodException e) {
            e.printStackTrace();
        }
    }

    public static void main(String[] args) {
        TestScriptEngine engine = new TestScriptEngine();
        engine.testByFunction();
    }
}

不正之處,請多多指教~