当前位置：首页 > news >正文

Hutool - Script：脚本执行封装，以 JavaScript 为例

news 来源：原创 2025/4/29 4:41:39

一、简介

在 Java 开发中，有时需要动态执行脚本代码，比如 JavaScript 脚本，来实现一些灵活的业务逻辑，如动态规则计算、数据处理等。Java 本身提供了 javax.script 包来支持脚本执行，但使用起来较为繁琐。Hutool - Script 模块对 Java 的脚本执行功能进行了封装，提供了更简洁易用的 API，让开发者可以方便地执行各种脚本，这里主要介绍 JavaScript 脚本的执行。

二、引入依赖

如果你使用 Maven 项目，在 pom.xml 中添加以下依赖：

<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-all</artifactId>
    <version>5.8.16</version>
</dependency>

若使用 Gradle 项目，在 build.gradle 中添加：

implementation 'cn.hutool:hutool-all:5.8.16'

三、基本使用示例

1. 执行简单的 JavaScript 脚本

import cn.hutool.script.ScriptUtil;

public class SimpleScriptExecution {
    public static void main(String[] args) {
        // 定义 JavaScript 脚本
        String script = "var a = 5; var b = 3; a + b;";
        // 执行脚本并获取结果
        Object result = ScriptUtil.eval(script);
        System.out.println("脚本执行结果: " + result);
    }
}

在上述代码中，首先定义了一个简单的 JavaScript 脚本，该脚本定义了两个变量 a 和 b，并计算它们的和。然后使用 ScriptUtil.eval 方法执行该脚本，该方法会返回脚本执行的结果，最后将结果输出。

2. 执行带函数调用的 JavaScript 脚本

import cn.hutool.script.ScriptUtil;

public class FunctionScriptExecution {
    public static void main(String[] args) {
        // 定义包含函数的 JavaScript 脚本
        String script = "function add(a, b) { return a + b; } add(7, 8);";
        // 执行脚本并获取结果
        Object result = ScriptUtil.eval(script);
        System.out.println("函数调用脚本执行结果: " + result);
    }
}

这里定义了一个 JavaScript 函数 add 用于计算两个数的和，然后调用该函数并传入参数。同样使用 ScriptUtil.eval 方法执行脚本并获取结果。

四、向脚本传递参数

1. 传递单个参数

import cn.hutool.script.ScriptUtil;

import javax.script.ScriptException;
import java.util.HashMap;
import java.util.Map;

public class PassSingleParameter {
    public static void main(String[] args) throws ScriptException {
        // 定义 JavaScript 脚本，使用传入的参数
        String script = "var num = param * 2; num;";
        // 定义参数
        Map<String, Object> params = new HashMap<>();
        params.put("param", 10);
        // 执行脚本并传递参数
        Object result = ScriptUtil.eval(script, params);
        System.out.println("传递单个参数脚本执行结果: " + result);
    }
}

在这个示例中，脚本中使用了一个名为 param 的参数，通过 Map 对象将参数传递给 ScriptUtil.eval 方法，脚本会使用传入的参数进行计算并返回结果。

2. 传递多个参数

import cn.hutool.script.ScriptUtil;

import javax.script.ScriptException;
import java.util.HashMap;
import java.util.Map;

public class PassMultipleParameters {
    public static void main(String[] args) throws ScriptException {
        // 定义 JavaScript 脚本，使用传入的多个参数
        String script = "var sum = param1 + param2; sum;";
        // 定义参数
        Map<String, Object> params = new HashMap<>();
        params.put("param1", 5);
        params.put("param2", 6);
        // 执行脚本并传递参数
        Object result = ScriptUtil.eval(script, params);
        System.out.println("传递多个参数脚本执行结果: " + result);
    }
}

与传递单个参数类似，通过 Map 对象可以传递多个参数给脚本，脚本可以使用这些参数进行相应的计算。

五、处理脚本异常

在执行脚本时，可能会出现各种异常，如语法错误、类型错误等。Hutool - Script 会将脚本执行过程中的异常抛出，开发者可以进行捕获和处理。

import cn.hutool.script.ScriptUtil;

import javax.script.ScriptException;

public class ScriptExceptionHandling {
    public static void main(String[] args) {
        // 定义包含语法错误的 JavaScript 脚本
        String script = "var a = 5; var b = 3; a + b; // 故意添加语法错误: ;;;";
        try {
            // 执行脚本
            Object result = ScriptUtil.eval(script);
            System.out.println("脚本执行结果: " + result);
        } catch (ScriptException e) {
            System.err.println("脚本执行出错: " + e.getMessage());
        }
    }
}

在上述代码中，脚本包含语法错误，使用 try - catch 块捕获 ScriptException 异常，并输出异常信息，方便开发者进行调试。

六、注意事项

脚本安全：执行外部传入的脚本时，要注意脚本的安全性，避免执行恶意脚本导致安全漏洞，如注入攻击等。
性能考虑：频繁执行脚本可能会影响程序的性能，尤其是复杂的脚本。在性能敏感的场景下，要谨慎使用脚本执行功能。
脚本引擎选择：Hutool - Script 默认使用 Java 内置的脚本引擎，对于 JavaScript 脚本，使用的是 Nashorn 引擎（Java 8 及以前）或 GraalVM JavaScript 引擎（Java 11 及以后）。如果需要更高性能或特定功能，可以考虑使用其他脚本引擎。

通过使用 Hutool - Script，开发者可以方便地在 Java 项目中执行 JavaScript 等脚本，为项目增加了更多的灵活性和动态性。