Aviator——轻量级JAVA规则引擎

Aviator是一个高性能、轻量级的java语言实现的表达式求值引擎，主要用于各种表达式的动态求值。现在已经有很多开源可用的java表达式求值引擎，为什么还需要Avaitor呢？

简介

Aviator的设计目标是轻量级和高性能 ，相比于Groovy、JRuby的笨重，Aviator非常小，加上依赖包也才450K,不算依赖包的话只有70K；当然，Aviator的语法是受限的，它不是一门完整的语言，而只是语言的一小部分集合。

其次，Aviator的实现思路与其他轻量级的求值器很不相同，其他求值器一般都是通过解释的方式运行，而Aviator则是直接将表达式编译成Java字节码，交给JVM去执行。简单来说，Aviator的定位是介于Groovy这样的重量级脚本语言和IKExpression这样的轻量级表达式引擎之间。

特性

Aviator的特性

• 支持大部分运算操作符，包括算术操作符、关系运算符、逻辑操作符、位运算符、正则匹配操作符(=~)、三元表达式?: ，并且支持操作符的优先级和括号强制优先级，具体请看后面的操作符列表。
• 支持大整数和精度运算（2.3.0版本引入）
• 支持函数调用和自定义函数
• 内置支持正则表达式匹配，类似Ruby、Perl的匹配语法，并且支持类Ruby的$digit指向匹配分组。
• 自动类型转换，当执行操作的时候，会自动判断操作数类型并做相应转换，无法转换即抛异常。
• 支持传入变量，支持类似a.b.c的嵌套变量访问。
• 函数式风格的seq库，操作集合和数组
• 性能优秀

Aviator的限制：

• 没有if else、do while等语句，没有赋值语句，仅支持逻辑表达式、算术表达式、三元表达式和正则匹配。
• 不支持八进制数字字面量，仅支持十进制和十六进制数字字面量。

相关资料

# 官网地址
https://github.com/killme2008/aviator
# 开发文档
https://www.yuque.com/boyan-avfmj/aviatorscript/cpow90

依赖包

        <dependency>
            <groupId>com.googlecode.aviator</groupId>
            <artifactId>aviator</artifactId>
            <version>5.2.5</version>
        </dependency>

使用

示例：比如，在灰度规则里 手机尾号为9和0，用户id>901，注册时间大于‘2021-06-25’ 的用户进入灰度环境 硬编码好说，策略也还好，但是如果加上或运算，策略也不好处理， 表达式最好了

    @Test
    public void grayRule(){
        Map<String,Object> map = new HashMap<>();
        final Date date = new Date();
        String dateStr = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss:SS").format(date);
        map.put("mobileTail","9");
        map.put("userId",901);
        map.put("registerTime",dateStr);
        map.put("mobile","15600000269");
        map.put("sex",1);
        map.put("age",28);
        // 手机尾号
        String expression = "(string.endsWith('9,0',mobileTail) && userId>=901 && registerTime>'2021-06-25 00:00:00')";
        Boolean flag = (Boolean) AviatorEvaluator.execute(expression, map);
        Assert.assertTrue("规则验证通过",flag);
    }

执行方式一：直接表达式+参数

AviatorEvaluator.execute() 
或
AviatorEvaluator.getInstance().execute()

最终底层：
AviatorEvaluatorInstance.execute()

script脚本+ 参数

执行方式二：script脚本+参数

script脚本script.av

str = "";
if (age <=1 ){
  str = "婴儿";
} elsif (age>1 && age<=6) {
   str = "儿童";
} elsif (age>6 && age<=17) {
  str = "青少年";
} elsif (age>18 && age<=40){
  str = "青年";
} elsif (age>40 && age<=48){
  str = "壮年";
} elsif (age>48 && age<=65){
  str = "中年";
} elsif (age>65){
  str = "老年";
}
return str="#{name}处在#{str}期";

调用脚本执行

@Test
public void script2() throws IOException {
    //编译脚本
    //路径是文件系统的绝对路径或相对路径，
    //相对路径的时候，必须项目的根目录开始的相对路径
    //classpath下的绝对或相对路径
    Expression compiledExp = AviatorEvaluator.getInstance().compileScript("src/test/resources/script.av");
    //执行脚本，参数可以map，也可以通过newEnv kv对的方式塞入，最终还是map
    final Object o = compiledExp.execute(compiledExp.newEnv("age", 12, "name", "yxk"));
    System.out.println(o);
}

输出结果

输出结果

> yxk处在青少年期

内置函数

aviator内置了很多函数，具体可以看官网 https://www.yuque.com/boyan-avfmj/aviatorscript/ashevw
比如：上面用的string.endsWith(‘9,0’,mobileTail)

@Test
public void function_in(){
    long num =(Long) AviatorEvaluator.getInstance().execute("math.round(4.3)");
    Assert.assertEquals("4.3四舍五入后", 4L ,num);
    Map<String,Object> map = new HashMap<>();
    map.put("str","yxkong");
    map.put("head","yxk");
    Boolean flag = (Boolean) AviatorEvaluator.getInstance().execute("string.contains(str,head)",map);
    Assert.assertTrue("yxkong包含yxk",flag);
}

自定义函数

//定义函数
class AddFunction extends AbstractFunction {
@Override
public AviatorObject call(Map<String, Object> env, AviatorObject arg1, AviatorObject arg2) {
    long num1 = FunctionUtils.getNumberValue(arg1, env).longValue();
    long num2 = FunctionUtils.getNumberValue(arg2, env).longValue();
    return AviatorLong.valueOf(num1+num2);
}

@Override
public String getName() {
    return "add";
}
}

测试

@Test
public void function_my(){
    // 注册自定义函数
    AviatorEvaluator.addFunction(new AddFunction());
    long num =(Long) AviatorEvaluator.getInstance().execute("add(3,4)");
    Assert.assertEquals("3+4", 7L,num);
}

操作符列表

序号	操作符	结合性	操作数限制
0	() [ ]	从左到右	()用于函数调用，[ ]用于数组和java.util.List的元素访问，要求[indx]中的index必须为整型
1	! - ~	从右到左	! 能用于Boolean,- 仅能用于Number,~仅能用于整数
2	* / % 从左到右	Number之间
3	+ -	从左到右	+ - 都能用于Number之间, + 还能用于String之间，或者String和其他对象
4	<< >> >>>	从左到右	仅能用于整数
5	< <= > >=	从左到右	Number之间、String之间、Pattern之间、变量之间、其他类型与nil之间
6	== != =~	从左到右	==和!=作用于Number之间、String之间、Pattern之间、变量之间、其他类型与nil之间以及String和java.util.Date之间，=~仅能作用于String和Pattern之间
7	&	从左到右	整数之间
8	^	从左到右	整数之间
9	¦	从左到右	整数之间
10	&&	从左到右	Boolean之间，短路
11	¦¦	从左到右	Boolean之间，短路
12	? :	从右到左	第一个操作数的结果必须为Boolean，第二和第三操作数结果

内置函数

函数名称	说明
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的谓词

常量和变量

值	说明
true	真值
false	假值
nil	空值
$digit	正则表达式匹配成功后的分组，1表示第一个分组 etc.