Aviator是一个轻量级、高性能的Java表达式执行引擎, 本文内容主要来自于官方文档html
简介
Aviator是一个高性能、轻量级的 java 语言实现的表达式求值引擎, 主要用于各类表达式的动态求值。如今已经有不少开源可用的 java 表达式求值引擎,为何还须要 Avaitor 呢?
Aviator的设计目标是轻量级和高性能,相比于Groovy、JRuby的笨重, Aviator很是小, 加上依赖包也才450K,不算依赖包的话只有 70K; 固然, Aviator的语法是受限的, 它不是一门完整的语言, 而只是语言的一小部分集合。
其次, Aviator的实现思路与其余轻量级的求值器很不相同, 其余求值器通常都是经过解释的方式运行, 而Aviator则是直接将表达式编译成Java 字节码, 交给JVM去执行。简单来讲, Aviator的定位是介于Groovy这样的重量级脚本语言和IKExpression这样的轻量级表达式引擎 之间。
Aviator支持大部分运算操做符, 包括算术操做符、关系运算符、逻辑操做符、位运算符、正则匹配操做符(=~)、三元表达式(?:), 而且支持操做符的优先级和括号强制优先级, 具体请看后面的操做符列表, 支持自定义函数.java
包依赖
Aviator依赖了commons-beanutils, 使用Aviator能够添加下面的maven依赖:正则表达式
<dependency> <groupId>com.googlecode.aviator</groupId> <artifactId>aviator</artifactId> <version>2.3.3</version> </dependency>
使用手册
执行表达式
Aviator的使用都是集中经过com.googlecode.aviator.AviatorEvaluator这个入口类来处理, 最简单的例子, 执行一个计算1+2+3的表达式:express
import com.googlecode.aviator.AviatorEvaluator; public class TestAviator { public static void main(String[] args) { Long result = (Long) AviatorEvaluator.execute("1+2+3"); System.out.println(result); } }
细心的朋友确定注意到结果是Long,而不是Integer。这是由于Aviator的数值类型仅支持Long和Double, 任何整数都将转换成Long, 任何浮点数都将转换为Double, 包括用户传入的变量数值。这个例子的打印结果将是正确答案6。编程
使用变量
想让Aviator对你say hello吗? 很简单, 传入你的名字, 让Aviator负责字符串的相加:数组
public class TestAviator { public static void main(String[] args) { String yourName = "Michael"; Map<String, Object> env = new HashMap<String, Object>(); env.put("yourName", yourName); String result = (String) AviatorEvaluator.execute(" 'hello ' + yourName ", env); System.out.println(result); // hello Michael } }
上面的例子演示了怎么向表达式传入变量值, 表达式中的yourName是一个变量, 默认为null, 经过传入Map<String,Object>的变量绑定环境, 将yourName设置为你输入的名称。 env 的key是变量名, value是变量的值。
上面例子中的'hello '是一个Aviator的String, Aviator的String是任何用单引号或者双引号括起来的字符序列, String能够比较大小(基于unicode顺序), 能够参与正则匹配, 能够与任何对象相加, 任何对象与String相加结果为String。 String中也能够有转义字符,如\n、\\、\' 等。缓存
AviatorEvaluator.execute(" 'a\"b' "); // 字符串 a"b AviatorEvaluator.execute(" \"a\'b\" "); // 字符串 a'b AviatorEvaluator.execute(" 'hello ' + 3 "); // 字符串 hello 3 AviatorEvaluator.execute(" 'hello '+ unknow "); // 字符串 hello null
exec 方法
Aviator 2.2 开始新增长一个exec方法, 能够更方便地传入变量并执行, 而不须要构造env这个map了:maven
String name = "dennis"; AviatorEvaluator.exec(" 'hello ' + yourName ", name); // hello dennis
只要在exec中按照变量在表达式中的出现顺序传入变量值就能够执行, 不须要构建Map了。ide
调用函数
Aviator 支持函数调用, 函数调用的风格相似 lua, 下面的例子获取字符串的长度:函数式编程
AviatorEvaluator.execute("string.length('hello')"); // 5
string.length('hello')是一个函数调用, string.length是一个函数, 'hello'是调用的参数。
再用string.substring来截取字符串:
AviatorEvaluator.execute("string.contains(\"test\", string.substring('hello', 1, 2))"); // true
经过string.substring('hello', 1, 2)获取字符串'e', 而后经过函数string.contains判断e是否在'test'中。能够看到, 函数能够嵌套调用。
Aviator 的内置函数列表请看后面。
自定义函数
Aviator 除了内置的函数以外,还容许用户自定义函数,只要实现com.googlecode.aviator.runtime.type.AviatorFunction接口, 并注册到AviatorEvaluator便可使用. AviatorFunction接口十分庞大, 一般来讲你并不须要实现全部的方法, 只要根据你的方法的参 数个数, 继承AbstractFunction类并override相应方法便可。
能够看一个例子,咱们实现一个add函数来作数值的相加:
public class TestAviator { public static void main(String[] args) { //注册函数 AviatorEvaluator.addFunction(new AddFunction()); System.out.println(AviatorEvaluator.execute("add(1, 2)")); // 3.0 System.out.println(AviatorEvaluator.execute("add(add(1, 2), 100)")); // 103.0 } } class AddFunction extends AbstractFunction { @Override public AviatorObject call(Map<String, Object> env, AviatorObject arg1, AviatorObject arg2) { Number left = FunctionUtils.getNumberValue(arg1, env); Number right = FunctionUtils.getNumberValue(arg2, env); return new AviatorDouble(left.doubleValue() + right.doubleValue()); } public String getName() { return "add"; } }
注册函数经过AviatorEvaluator.addFunction方法, 移除能够经过removeFunction。
编译表达式
上面提到的例子都是直接执行表达式, 事实上 Aviator 背后都帮你作了编译并执行的工做。 你能够本身先编译表达式, 返回一个编译的结果, 而后传入不一样的env来复用编译结果, 提升性能, 这是更推荐的使用方式:
public class TestAviator { public static void main(String[] args) { String expression = "a-(b-c)>100"; // 编译表达式 Expression compiledExp = AviatorEvaluator.compile(expression); Map<String, Object> env = new HashMap<String, Object>(); env.put("a", 100.3); env.put("b", 45); env.put("c", -199.100); // 执行表达式 Boolean result = (Boolean) compiledExp.execute(env); System.out.println(result); // false } }
经过compile方法能够将表达式编译成Expression的中间对象, 当要执行表达式的时候传入env并调用Expression的execute方法便可。 表达式中使用了括号来强制优先级, 这个例子还使用了>用于比较数值大小, 比较运算符!=、==、>、>=、<、<=不只能够用于数值, 也能够用于String、Pattern、Boolean等等, 甚至是任何用户传入的两个都实现了java.lang.Comparable接口的对象之间。
编译后的结果你能够本身缓存, 也能够交给 Aviator 帮你缓存, AviatorEvaluator内部有一个全局的缓存池, 若是你决定缓存编译结果, 能够经过:
public static Expression compile(String expression, boolean cached)
将cached设置为true便可, 那么下次编译同一个表达式的时候将直接返回上一次编译的结果。
使缓存失效经过:
public static void invalidateCache(String expression)
方法。
访问数组和集合
能够经过中括号去访问数组和java.util.List对象, 能够经过map.key访问java.util.Map中key对应的value, 一个例子:
public static void main(String[] args) { final List<String> list = new ArrayList<String>(); list.add("hello"); list.add(" world"); final int[] array = new int[3]; array[0] = 0; array[1] = 1; array[2] = 3; final Map<String, Date> map = new HashMap<String, Date>(); map.put("date", new Date()); Map<String, Object> env = new HashMap<String, Object>(); env.put("list", list); env.put("array", array); env.put("mmap", map); System.out.println(AviatorEvaluator.execute("list[0]+list[1]", env)); // hello world System.out.println(AviatorEvaluator.execute("'array[0]+array[1]+array[2]=' + (array[0]+array[1]+array[2])", env)); // array[0]+array[1]+array[2]=4 System.out.println(AviatorEvaluator.execute("'today is ' + mmap.date ", env)); // today is Wed Feb 24 17:31:45 CST 2016 }
三元操做符
Aviator 不提供if else语句, 可是提供了三元操做符?:用于条件判断,使用上与 java 没有什么不一样:
AviatorEvaluator.exec("a>0? 'yes':'no'", 1); // yes
Aviator 的三元表达式对于两个分支的结果类型并不要求一致,能够是任何类型,这一点与 java 不一样。
正则表达式匹配
Aviator 支持类 Ruby 和 Perl 风格的表达式匹配运算,经过=~操做符, 以下面这个例子匹配 email 并提取用户名返回:
public static void main(String[] args) { String email = "killme2008@gmail.com"; Map<String, Object> env = new HashMap<String, Object>(); env.put("email", email); String username = (String) AviatorEvaluator.execute("email=~/([\\w0-8]+)@\\w+[\\.\\w+]+/ ? $1 : 'unknow' ", env); System.out.println(username); // killme2008 }
email与正则表达式/([\\w0-8]+@\\w+[\\.\\w+]+)/经过=~操做符来匹配,结果为一个 Boolean 类 型, 所以能够用于三元表达式判断,匹配成功的时候返回$1,指代正则表达式的分组 1,也就是用户名,不然返回unknown。
Aviator 在表达式级别支持正则表达式,经过//括起来的字符序列构成一个正则表达式,正则表 达式能够用于匹配(做为=~的右操做数)、比较大小,匹配仅能与字符串进行匹配。匹配成功后, Aviator 会自动将匹配成功的分组放入$num的变量中,其中$0 指代整个匹配的字符串,而$1表示第一个分组,以此类推。
Aviator 的正则表达式规则跟 Java 彻底同样,由于内部其实就是使用java.util.regex.Pattern作编译的。
变量的语法糖
Aviator 有个方便用户使用变量的语法糖, 当你要访问变量a中的某个属性b, 那么你能够经过a.b访问到, 更进一步, a.b.c将访问变量a的b属性中的c属性值, 推广开来也就是说 Aviator 能够将变量声明为嵌套访问的形式。TestAviator类符合JavaBean规范, 而且是 public 的，咱们就可使用语法糖:
public class TestAviator { int i; float f; Date date; // 构造方法 public TestAviator(int i, float f, Date date) { this.i = i; this.f = f; this.date = date; } // getter and setter public static void main(String[] args) { TestAviator foo = new TestAviator(100, 3.14f, new Date()); Map<String, Object> env = new HashMap<String, Object>(); env.put("foo", foo); System.out.println(AviatorEvaluator.execute("'foo.i = '+foo.i", env)); // foo.i = 100 System.out.println(AviatorEvaluator.execute("'foo.f = '+foo.f", env)); // foo.f = 3.14 System.out.println(AviatorEvaluator.execute("'foo.date.year = '+(foo.date.year+1990)", env)); // foo.date.year = 2106 } }
nil 对象
nil是 Aviator 内置的常量,相似 java 中的null,表示空的值。nil跟null不一样的在于,在 java 中null只能使用在==、!=的比较运算符,而nil还可使用>、>=、<、<=等比较运算符。 Aviator 规定,任何对象都比nil大除了nil自己。用户传入的变量若是为null,将自动以nil替代。
AviatorEvaluator.execute("nil == nil"); //true AviatorEvaluator.execute(" 3> nil"); //true AviatorEvaluator.execute(" true!= nil"); //true AviatorEvaluator.execute(" ' '>nil "); //true AviatorEvaluator.execute(" a==nil "); //true, a 是 null
nil与String相加的时候,跟 java 同样显示为 null
日期比较
Aviator 并不支持日期类型,若是要比较日期,你须要将日期写字符串的形式,而且要求是形如 “yyyy-MM-dd HH:mm:ss:SS”的字符串,不然都将报错。 字符串跟java.util.Date比较的时候将自动转换为Date对象进行比较:
public static void main(String[] args) { Map<String, Object> env = new HashMap<String, Object>(); final Date date = new Date(); String dateStr = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss:SS").format(date); env.put("date", date); env.put("dateStr", dateStr); Boolean result = (Boolean) AviatorEvaluator.execute("date==dateStr", env); System.out.println(result); // true result = (Boolean) AviatorEvaluator.execute("date > '2010-12-20 00:00:00:00' ", env); System.out.println(result); // true result = (Boolean) AviatorEvaluator.execute("date < '2200-12-20 00:00:00:00' ", env); System.out.println(result); // true result = (Boolean) AviatorEvaluator.execute("date==date ", env); System.out.println(result); // true }
也就是说String除了能跟String比较以外,还能跟nil和java.util.Date对象比较。
大数计算和精度
从 2.3.0 版本开始,aviator 开始支持大数字计算和特定精度的计算, 本质上就是支持java.math.BigInteger和java.math.BigDecimal两种类型, 这两种类型在 aviator 中简称 为big int和decimal类型。 相似99999999999999999999999999999999这样的数字在 Java 语言里是没办法编译经过 的, 由于它超过了Long类型的范围, 只能用BigInteger来封装。可是 aviator 经过包装,可 以直接支持这种大整数的计算,例如:
public static void main(String[] args) { System.out.println(AviatorEvaluator.exec("99999999999999999999999999999999 + 99999999999999999999999999999999")); }
结果为类型big int的: 199999999999999999999999999999998
字面量表示
big int和decimal的表示与其余数字不一样,两条规则:
- 以大写字母
N为后缀的整数都被认为是big int,如1N,2N,9999999999999999999999N等, 都是big int类型。 - 超过
long范围的整数字面量都将自动转换为big int类型。 - 以大写字母
M为后缀的数字都被认为是decimal, 如1M,2.222M, 100000.9999M等, 都是decimal类型。
用户也能够经过变量传入这两种类型来参与计算。
运算
big int和decimal的运算,跟其余数字类型long,double没有什么区别,操做符仍然是同样的。 aviator重载了基本算术操做符来支持这两种新类型:
public static void main(String[] args) { Object rt = AviatorEvaluator.exec("9223372036854775807100.356M * 2"); System.out.println(rt + " " + rt.getClass()); // 18446744073709551614200.712 class java.math.BigDecimal rt = AviatorEvaluator.exec("92233720368547758074+1000"); System.out.println(rt + " " + rt.getClass()); // 92233720368547759074 class java.math.BigInteger BigInteger a = new BigInteger(String.valueOf(Long.MAX_VALUE) + String.valueOf(Long.MAX_VALUE)); BigDecimal b = new BigDecimal("3.2"); BigDecimal c = new BigDecimal("9999.99999"); rt = AviatorEvaluator.exec("a+10000000000000000000", a); System.out.println(rt + " " + rt.getClass()); // 92233720368547758089223372036854775807 class java.math.BigInteger rt = AviatorEvaluator.exec("b+c*2", b, c); System.out.println(rt + " " + rt.getClass()); // 20003.19998 class java.math.BigDecimal rt = AviatorEvaluator.exec("a*b/c", a, b, c); System.out.println(rt + " " + rt.getClass()); // 2.951479054745007313280155218459508E+34 class java.math.BigDecimal }
类型转换和提高
当big int或者decimal和其余类型的数字作运算的时候,按照long < big int < decimal < double的规则作提高, 也就是说运算的数字若是类型不一致, 结果的类型为二者之间更“高”的类型。例如:
1 + 3N, 结果为big int的4N1 + 3.1M,结果为decimal的4.1M1N + 3.1M,结果为decimal的4.1M1.0 + 3N,结果为double的4.01.0 + 3.1M,结果为double的4.1
decimal 的计算精度
Java 的java.math.BigDecimal经过java.math.MathContext支持特定精度的计算,任何涉及到金额的计算都应该使用decimal类型。
默认 Aviator 的计算精度为MathContext.DECIMAL128,你能够自定义精度, 经过:
AviatorEvaluator.setMathContext(MathContext.DECIMAL64);
便可设置,更多关于decimal的精度问题请看java.math.BigDecimal的 javadoc 文档。
强大的 seq 库
aviator 拥有强大的操做集合和数组的 seq 库。整个库风格相似函数式编程中的高阶函数。在 aviator 中, 数组以及java.util.Collection下的子类都称为seq,能够直接利用 seq 库进行遍历、过滤和聚合等操做。
例如,假设我有个 list:
public static void main(String[] args) { Map<String, Object> env = new HashMap<String, Object>(); ArrayList<Integer> list = new ArrayList<Integer>(); list.add(3); list.add(20); list.add(10); env.put("list", list); Object result = AviatorEvaluator.execute("count(list)", env); System.out.println(result); // 3 result = AviatorEvaluator.execute("reduce(list,+,0)", env); System.out.println(result); // 33 result = AviatorEvaluator.execute("filter(list,seq.gt(9))", env); System.out.println(result); // [10, 20] result = AviatorEvaluator.execute("include(list,10)", env); System.out.println(result); // true result = AviatorEvaluator.execute("sort(list)", env); System.out.println(result); // [3, 10, 20] AviatorEvaluator.execute("map(list,println)", env); }
咱们能够:
- 求长度:
count(list) - 求和:
reduce(list,+,0),reduce函数接收三个参数,第一个是seq,第二个是聚合的函数,如+等,第三个是聚合的初始值 - 过滤:
filter(list,seq.gt(9)), 过滤出list中全部大于9的元素并返回集合;seq.gt函数用于生成一个谓词,表示大于某个值 - 判断元素在不在集合里:
include(list,10) - 排序:
sort(list) - 遍历整个集合:
map(list,println),map接受的第二个函数将做用于集合中的每一个元素,这里简单地调用println打印每一个元素
两种运行模式
默认 AviatorEvaluator 以执行速度优先:
AviatorEvaluator.setOptimize(AviatorEvaluator.EVAL);
你能够修改成编译速度优先,这样不会作编译优化:
AviatorEvaluator.setOptimize(AviatorEvaluator.COMPILE);
调试信息
从 2.1.1.版本开始,Aviator容许设置输出每一个表达式生成的字节码,只要设置trace为true便可:
AviatorEvaluator.setTrace(true);
方便用户作跟踪和调试。默认是输出到标准输出,你能够改变输出指向:
AviatorEvaluator.setTraceOutputStream(new FileOutputStream(new File("aviator.log")));
语法手册
下面是 Aviator 详细的语法规则定义。
数据类型
Number类型: 数字类型,支持四种类型,分别是long,double,java.math.BigInteger(简称 big int)和java.math.BigDecimal(简 称 decimal),规则以下:- 任何以大写字母
N结尾的整数都被认为是big int - 任何以大写字母
M结尾的数字都被认为是decimal - 其余的任何整数都将被转换为
Long - 其余任何浮点数都将被转换为
Double - 超过
long范围的整数字面量都将自动转换为big int类型
- 任何以大写字母
其中 big int 和 decimal 是 2.3.0 版本开始引入的。数字还支持十六进制(以0x或者0X开头的数字), 以及科学计数法,如1e-3等。 不支持其余进制。
String类型: 字符串类型,单引号或者双引号括起来的文本串,如'hello world', 变量若是传入的是String或者Character也将转为String类型Bool类型: 常量true和false,表示真值和假值,与 java 的Boolean.TRUE和Boolean.False对应Pattern类型: 正则表达式, 以//括起来的字符串,如/\d+/,内部 实现为java.util.Pattern- 变量类型: 与 Java 的变量命名规则相同,变量的值由用户传入
nil类型: 常量nil,相似 java 中的null,可是nil比较特殊,nil不只能够参与==、!=的比较, 也能够参与>、>=、<、<=的比较,Aviator 规定任何类型都大于nil除了nil自己,nil==nil返回true。 用户传入的变量值若是为null,那么也将做为nil处理,nil打印为null
操做符
算术运算符
Aviator 支持常见的算术运算符,包括+ - * / %五个二元运算符,和一元运算符-(负)。其中- * / %和一元的-仅能做用于Number类型。+不只能用于Number类型,还能够用于String的相加,或者字符串与其余对象的相加。
Aviator 规定,任何类型与String相加,结果为String。
逻辑运算符
Avaitor 的支持的逻辑运算符包括,一元否认运算符!,以及逻辑与的&&,逻辑或的||。逻辑运算符的操做数只能为Boolean。&&和||都执行短路规则。
关系运算符
Aviator 支持的关系运算符包括<, <=, >, >=以及==和!= 。
关系运算符能够做用于Number之间、String之间、Pattern之间、Boolean之间、变量之间以及其余类型与nil之间的关系比较, 不一样类型除了nil以外不能相互比较。
位运算符
Aviator 支持全部的 Java 位运算符,包括&, |, ^, ~, >>, <<, >>>。
匹配运算符
匹配运算符=~用于String和Pattern的匹配,它的左操做数必须为String,右操做数必须为Pattern。 匹配成功后,Pattern的分组将存于变量$num,num为分组索引。
三元运算符
Aviator 没有提供if else语句,可是提供了三元运算符?:,形式为bool ? exp1: exp2。 其中bool必须为Boolean类型的表达式, 而exp1和exp2能够为任何合法的 Aviator 表达式,而且不要求exp1和exp2返回的结果类型一致。
内置函数
| 函数名称 | 说明 |
|---|---|
| sysdate() | 返回当前日期对象 java.util.Date |
| rand() | 返回一个介于 0-1 的随机数,double 类型 |
| print([out],obj) | 打印对象,若是指定 out,向 out 打印, 不然输出到控制台 |
| println([out],obj) | 与 print 相似,可是在输出后换行 |
| now() | 返回 System.currentTimeMillis |
| long(v) | 将值的类型转为 long |
| double(v) | 将值的类型转为 double |
| str(v) | 将值的类型转为 string |
| date_to_string(date,format) | 将 Date 对象转化化特定格式的字符串,2.1.1 新增 |
| string_to_date(source,format) | 将特定格式的字符串转化为 Date 对 象,2.1.1 新增 |
| string.contains(s1,s2) | 判断 s1 是否包含 s2,返回 Boolean |
| string.length(s) | 求字符串长度,返回 Long |
| string.startsWith(s1,s2) | s1 是否以 s2 开始,返回 Boolean |
| string.endsWith(s1,s2) | s1 是否以 s2 结尾,返回 Boolean |
| string.substring(s,begin[,end]) | 截取字符串 s,从 begin 到 end,若是忽略 end 的话,将从 begin 到结尾,与 java.util.String.substring 同样。 |
| string.indexOf(s1,s2) | java 中的 s1.indexOf(s2),求 s2 在 s1 中 的起始索引位置,若是不存在为-1 |
| string.split(target,regex,[limit]) | Java 里的 String.split 方法一致,2.1.1 新增函数 |
| string.join(seq,seperator) | 将集合 seq 里的元素以 seperator 为间隔 链接起来造成字符串,2.1.1 新增函数 |
| string.replace_first(s,regex,replacement) | Java 里的 String.replaceFirst 方法, 2.1.1 新增 |
| string.replace_all(s,regex,replacement) | Java 里的 String.replaceAll 方法 , 2.1.1 新增 |
| math.abs(d) | 求 d 的绝对值 |
| math.sqrt(d) | 求 d 的平方根 |
| math.pow(d1,d2) | 求 d1 的 d2 次方 |
| math.log(d) | 求 d 的天然对数 |
| math.log10(d) | 求 d 以 10 为底的对数 |
| math.sin(d) | 正弦函数 |
| math.cos(d) | 余弦函数 |
| math.tan(d) | 正切函数 |
| map(seq,fun) | 将函数 fun 做用到集合 seq 每一个元素上, 返回新元素组成的集合 |
| filter(seq,predicate) | 将谓词 predicate 做用在集合的每一个元素 上,返回谓词为 true 的元素组成的集合 |
| count(seq) | 返回集合大小 |
| include(seq,element) | 判断 element 是否在集合 seq 中,返回 boolean 值 |
| sort(seq) | 排序集合,仅对数组和 List 有效,返回排 序后的新集合 |
| reduce(seq,fun,init) | fun 接收两个参数,第一个是集合元素, 第二个是累积的函数,本函数用于将 fun 做用在集合每一个元素和初始值上面,返回 最终的 init 值 |
| seq.eq(value) | 返回一个谓词,用来判断传入的参数是否跟 value 相等,用于 filter 函数,如filter(seq,seq.eq(3)) 过滤返回等于3 的元素组成的集合 |
| seq.neq(value) | 与 seq.eq 相似,返回判断不等于的谓词 |
| seq.gt(value) | 返回判断大于 value 的谓词 |
| seq.ge(value) | 返回判断大于等于 value 的谓词 |
| seq.lt(value) | 返回判断小于 value 的谓词 |
| seq.le(value) | 返回判断小于等于 value 的谓词 |
| seq.nil() | 返回判断是否为 nil 的谓词 |
| seq.exists() | 返回判断不为 nil 的谓词 |