Java指令碼API執行指令碼程式防止死迴圈

前提概要

當我們使用java指令碼API執行指令碼的時候，在一些我們並不知道指令碼的程式邏輯並且無法修改指令碼的特殊的場景下，如果指令碼中存在死迴圈(endless loop)或者高資源消耗的耗時迴圈語句，程式執行將會佔用大量的系統資源，比如說CPU、磁碟IO等。如果指令碼程式是死迴圈並且程式同步地執行指令碼的話，那麼程式將會一直阻塞下去。

解決辦法

由於在這些場景下，我們無法控制指令碼的程式邏輯，無法改動指令碼的程式碼，所以有必要對指令碼的執行進行控制。在這裡我們可以通過非同步呼叫的方式，防止指令碼執行阻塞對主程式帶來的負面影響。並且通過新增超時機制，對指令碼執行超時的執行緒進行強制關閉，避免有死迴圈嫌疑的惡意指令碼對系統資源的惡意消耗。

程式示例

1.編寫指令碼執行執行緒

/**
 * 指令碼執行執行緒
 */
private static abstract class ScriptThread extends Thread {
    private boolean done = false;

    boolean isDone() {
        return done;
    }

    @Override
    public void run() {
        execute();
        this.done = true;
    }

    public abstract
 
 void execute();
}

說明：

• 執行緒中新增變數 done ， 用來標誌指令碼執行正常結束的情況。
• run方法中呼叫execute()方法，execute執行完成將done標誌位置為true。
• 通過isDOne()方法判斷執行緒是否正常結束。
• 建立ScriptThread物件需要實現execute()方法，方法內部新增執行指令碼的邏輯程式碼。

2.定義指令碼執行超時異常類

/**
 * 指令碼執行超時異常
 */
public static class ScriptTimeoutException extends Exception {
    private static
 
 final long serialVersionUID = 1L;
    private int timeout;

    public ScriptTimeoutException() {
        super("Script execute timeout.");
    }

    public ScriptTimeoutException(int timeout) {
        super("Script execute timeout.");
        this.timeout = timeout;
    }

    public int getTimeout() {
        return timeout;
    }

    public void setTimeout(int timeout) {
        this.timeout = timeout;
    }
}

說明：

• 指令碼執行超時後丟擲ScriptTimeoutException物件，用來區分異常型別。

3.編寫指令碼執行阻塞方法

/**
 * 阻塞等待指令碼執行結束，或者到達超時時間
 * 
 * <pre>
 *     指令碼執行超過等待時間，強制停止指令碼執行緒
 * </pre>
 *
 * @param task 指令碼執行執行緒
 * @return 1:指令碼正常執行結束 2:指令碼強制退出執行 0:其他
 */
@SuppressWarnings("deprecation")
private static int waitScriptRunning(ScriptThread task) {
    int result = 0;
    long start = System.currentTimeMillis();
    while (true) {
        if (task.isDone()) {//如果指令碼執行已經結束
            result = 1;
            break;
        }
        long current = System.currentTimeMillis();
        if (current - start >= waitTime) {//超過指令碼執行等待時間還未結束，取消執行，強制關閉執行緒
            if (!task.isDone()) {
                result = 2;
                task.stop();
            }
            break;
        }
        try {
            Thread.sleep(1000);
        } catch (Exception e) {
            logger.warn(e.getMessage(), e);
        }
    }
    return result;
}

說明：

• 呼叫該方法將阻塞等待，直到執行緒執行完畢或者執行緒超時，如果超時，則強制關閉執行緒。(JDK Thread#stop()方法不推薦使用，在當前的特殊場景下，我們無法修改指令碼邏輯，無法在指令碼內部控制執行緒的中斷，因此需要使用stop方法對執行緒進行強制退出。)

4.編寫指令碼執行方法

/**
 * 執行指令碼中的方法
 *
 * @param scriptLang   指令碼語言
 * @param script       需要執行的指令碼文字
 * @param functionName 執行的方法名
 * @param args         執行指令碼方法傳入的引數
 * @return 指令碼返回值
 * @throws Exception exception
 */
public static Object invokeScriptFunction(String scriptLang, String script, String functionName, Object... args)
        throws Exception {
    final Map<String, Object> map = new HashMap<>();

    ScriptThread scriptThread = new ScriptThread() {
        @Override
        public void execute() {
            try {
                ScriptEngine engine = getEngine(scriptLang);
                if (engine == null)
                    throw new Exception(String.format("Script engine not get! No support for script [%s].", scriptLang));
                engine.eval(script);
                map.put("value", ((Invocable) engine).invokeFunction(functionName, args));
            } catch (Exception e) {
                map.put("exception", e);
            }
        }
    };
    scriptThread.start();

    int result = waitScriptRunning(scriptThread);
    if (result == 2) {
        throw new ScriptTimeoutException(waitTime);
    }

    Object o = map.get("exception");
    if (o != null) {
        throw (Exception) o;
    }
    return map.get("value");
}

說明：

• 方法邏輯中首先新建指令碼執行執行緒並提交執行緒的執行，接著呼叫等待方法阻塞等待指令碼的執行，如果返回結果說明指令碼超時，則丟擲超時異常。
• 指令碼執行執行緒execute方法體中定義執行指令碼的邏輯，將執行指令碼正常情況下的返回值、異常情況下的異常物件儲存到map中。
• 如果指令碼執行正常結束沒有超時，則拿到map中的內容，若異常物件不為空則丟擲異常物件；若異常物件為空則將指令碼返回值返回。

附上Java指令碼執行工具專案地址