Java中使用脚本语言

背景:近期有一个需求,根据不同的券商计算佣金,由于不同的券商计算方式不同,设计到的字段也有很大的不确定性,如A股费用有:佣金、转户费、印花税,美股有平台费、佣金(可以按交易金额、交易股数计算、也可以按照月订单计算)、证监会规费、交收费、活动费等等。按照常规的方法来做就是预先定义好所有字段,然后根据不同的券商把计算方法固化在代码中,这种做法的弊端就是很难维护,今天要介绍的方法就可以完美解决这一问题。

  最近几年,Java领域最大的变化就是基于JVM的语言正在开始流行,Java已经进入了混合编程时代。今天我们介绍的就是Java在多语言方面的一个尝试,在Java中使用脚本语言。

1、可用的脚本引擎
Java 6提供对执行脚本语言的支持,这个支持来自于JSR223规范,对应的包是javax.script。默认情况下,Java 6只支持JavaScript脚本,它底层的实现是Mozilla Rhino,它是个纯Java的JavaScript实现。可以通过下面的代码列出当前环境中支持的脚本引擎:

1
2
3
4
5
6
7
8
9
10
11
12
ScriptEngineManager manager = new ScriptEngineManager();  
ListScriptEngineFactory> factories = manager.getEngineFactories();
for (ScriptEngineFactory f : factories) {
System.out.println(
"egine name:"+f.getEngineName()+
",engine version:"+f.getEngineVersion()+
",language name:"+f.getLanguageName()+
",language version:"+f.getLanguageVersion()+
",names:"+f.getNames()+
",mime:"+f.getMimeTypes()+
",extension:"+f.getExtensions());
}

输出结果:
egine name:Mozilla Rhino,engine version:1.6 release 2
,language name:ECMAScript
,language version:1.6
,names:[js, rhino, JavaScript, javascript, ECMAScript, ecmascript]
,mime:[application/javascript, application/ecmascript, text/javascript, text/ecmascript]
,extension:[js]
可以看到,Java内置只支持JavaScript一种脚本。但是,只要遵循 JSR223,便可以扩展支持多种脚本语言,可以从https://scripting.dev.java.net/上查找当前已被支持的脚本的第三方库。

2、hello script
接下来给出在Java中使用JavaScript的Hello world示例:

1
2
3
4
5
6
7
8
ScriptEngineManager manager = new ScriptEngineManager ();  
ScriptEngine engine = manager.getEngineByName ("js");
String script = "print ('hello script')";
try {
engine.eval (script);
} catch (ScriptException e) {
e.printStackTrace();
}

使用的API还是很简单的,ScriptEngineManager是ScriptEngine的工厂,实例化该工厂的时候会加载可用的所有脚本引擎。从工厂中创建ScriptEngine可以使用getEngineByName、getEngineByExtension或 getEngineByMimeType来得到,只要参数名字能对上。执行脚本调用eval方法即可(效果等同于JavaScript中的eval)。

3、传递变量
可以向脚本中传递变量,使得Java代码可以和脚本代码交互,示例如下:

1
2
3
4
5
6
7
8
9
10
ScriptEngineManager manager = new ScriptEngineManager();  
ScriptEngine engine = manager.getEngineByName("js");
engine.put("a", 4);
engine.put("b", 6);
try {
Object maxNum = engine.eval("function max_num(a,b){return (a>b)?a:b;}max_num(a,b);");
System.out.println("max_num:" + maxNum);
} catch (Exception e) {
e.printStackTrace();
}

输出内容:max_num:6
对于上面put的变量,它作用于自身engine范围内,也就是ScriptContext.ENGINE_SCOPE,put 的变量放到一个叫Bindings的Map中,可以通过 engine.getBindings(ScriptContext.ENGINE_SCOPE).get(“a”);得到put的内容。和ENGINE_SCOPE相对,还有个ScriptContext.GLOBAL_SCOPE 作用域,其作用的变量是由同一ScriptEngineFactory创建的所有ScriptEngine共享的全局作用域。

4、动态调用
上面的例子中定义了一个JavaScript函数max_num,可以通过Invocable接口来多次调用脚本库中的函数,Invocable接口是 ScriptEngine可选实现的接口。下面是个使用示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
ScriptEngineManager manager = new ScriptEngineManager();  
ScriptEngine engine = manager.getEngineByName("js");
try {
String str = "
function calculate(totalAmount, totalPrice) {
var commission = totalAmount * 0.0049;
commission = commission < 0.99 ? 0.99 : commission;
var platformFee = totalAmount * 0.005;
platformFee = platformFee < 1 ? 1 : platformFee;
var transferFee = totalAmount * 0.003;
var exchangeFee = totalPrice * 0.000013;
exchangeFee = exchangeFee < 0.01 ? 0.01 : exchangeFee;
var activityFee = totalAmount * 0.000119;
activityFee = activityFee < 0.01 ? 0.01 : activityFee;

var total = commission + platformFee + transferFee + exchangeFee + activityFee;
return total.toFixed(2)
}";
engine.eval(str);
Invocable invoke = (Invocable) engine;
Object maxNum = invoke.invokeFunction("calculate",100,1850);
System.out.println(maxNum);
} catch (Exception e) {
// TODO: handle exception
}

上面的invokeFunction,第一个参数调用的脚本函数名,后面跟的可变参数是对应的脚本函数参数。
Invocable还有个很酷的功能,就是动态实现接口,它可以从脚本引擎中得到Java Interface 的实例;也就是说,可以定义个一个Java接口,其实现是由脚本完成。以上面的例子为例,定义接口JSLib,该接口中的函数和JavaScript中的函数签名保持一致:

1
2
3
public interface JSLib {  
public int max_num(int a,int b);
}

调用示例

1
2
3
4
5
6
7
8
9
10
11
ScriptEngineManager manager = new ScriptEngineManager();  
ScriptEngine engine = manager.getEngineByName("js");
try {
engine.eval("function max_num(a,b){return (a>b)?a:b;}");
Invocable invoke = (Invocable) engine;
JSLib jslib = invoke.getInterface(JSLib.class);
int maxNum = jslib.max_num(4,6);
System.out.println(maxNum);
} catch (Exception e) {
// TODO: handle exception
}

5、使用Java对象
可以在JavaScript中使用Java代码,这确实是很酷的事情。在Rhino中,可以通过importClass导入一个类,也可以通过importPackage导入一个包,也可以直接使用全路经的类。在创建对象时,new也不是必须的。示例代码如下:

1
2
3
4
5
6
7
8
ScriptEngineManager manager = new ScriptEngineManager();  
ScriptEngine engine = manager.getEngineByName("js");
try {
String script = "var list = java.util.ArrayList();list.add(\"kafka0102\");print(list.get(0));";
engine.eval(script);
} catch (Exception e) {
e.printStackTrace();
}

6、编译执行
脚本引擎默认是解释执行的,如果需要反复执行脚本,可以使用它的可选接口Compilable来编译执行脚本,以获得更好的性能,示例代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
ScriptEngineManager manager = new ScriptEngineManager();  
ScriptEngine engine = manager.getEngineByName("js");
try {
Compilable compEngine = (Compilable) engine;
CompiledScript script = compEngine.compile("function max_num(a,b){return (a>b)?a:b;}");
script.eval();
Invocable invoke = (Invocable) engine;
Object maxNum = invoke.invokeFunction("max_num",4,6);
System.out.println(maxNum);
} catch (Exception e) {
e.printStackTrace();
}

7、总结
除了上面提到的特性,脚本引擎还有一些不错的功能,比如可以执行脚本文件,可以由多线程异步执行脚本等功能。引入脚本引擎,可以对一些配置扩展和业务规则做更强大而灵活的支持,也方便使用者选择自己熟悉的脚本语言来编写业务规则等。

JouyPub wechat
欢迎订阅「K叔区块链」 - 专注于区块链技术学习