Aviator 表达式求值引擎——使用自定义函数应对复杂的业务场景

Aviator 是一个高性能、轻量级的 Java 语言实现的表达式求值引擎，主要用于各种表达式的动态求值。

Aviator 的实现思路与其它轻量级的求值器不同，其它求值器是通过解释的方式运行，而 Aviator 是直接将表达式编译成Java字节码，交给JVM去执行。

Aviator 支持大部分运算操作符，包括算术操作符、关系运算符、逻辑运算符、位运算符、三元表达式、正则表达式匹配等；并且支持操作符的优先级和括号强制优先级，还支持自定义函数去实现更复杂的功能逻辑。

导入依赖

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

调用函数

Aviator 支持函数调用，下面的例子获取字符串的长度：

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' 中，可以看到函数可以嵌套调用。

内置函数

函数名称	说明
sysdate()	返回当前日期对象java.util.Date
rand()	返回一个介于0-1的随机数，double类型
print([out],obj)	打印对象，如果指定out，向out打印，否则输出到控制台
println([out],obj)	与print类似，但是在输出后换行
now()	返回System.currentTimeMillis
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一样。
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接收两个参数，第一个是集合元素，第二个是累积的init，本函数用于将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的谓词``

以上是 Aviator 提供给我们的内置函数，但如果面临复杂的业务场景，这些函数可能无法解决我们的需求，这时就可以使用到自定义函数。

自定义函数

自定义函数只需要实现 com.googlecode.aviator.runtime.type.AviatorFunction 接口，并注册到 AviatorEvaluator 即可使用。AviatorFunction 接口十分庞大，通常来说你并不需要实现所有的方法，只要根据你的方法的参数个数，继承AbstractFunction类并重写相应方法即可。

样例

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";
    }
}

实战场景

实体类

商城类 Mall

@Data
@Builder
public class Mall {

    private Long mallId;

    private String name;

    private String city;

    private List<Product> productList;
}

商品类 Product

@Data
@Builder
public class Product {

    private Long productId;

    private String name;
}

商城包含多个商品，业务场景是要判断这个商城所在是否为“深圳”并且存在某个商品名称为 “手机”。

public class MyTest {

    public static void main(String[] args) {
        Product product1 = Product.builder().productId(301L).name("滑板").build();
        Product product2 = Product.builder().productId(302L).name("手机").build();
        Mall mall = Mall.builder().mallId(101L).name("天天商城").city("深圳")
                .productList(Arrays.asList(product1, product2)).build();
        
        AviatorEvaluator.addFunction(new ProductNameContainsFunction()); //注册自定义函数
        String filter = "city == \"深圳\" && productNameContains(\"手机\")";
        Map<String, Object> map = BeanUtil.beanToMap(mall, false, false);
        Boolean execute = (Boolean) AviatorEvaluator.execute(filter, map, true);
        System.out.println(execute);
    }

    static class ProductNameContainsFunction extends AbstractFunction {
        @Override
        public AviatorObject call(Map<String, Object> env, AviatorObject arg) {
            AviatorJavaType aviatorJavaType = new AviatorJavaType("productList");
            List<Product> productList = (List<Product>) FunctionUtils.getJavaObject(aviatorJavaType, env);
            if (productList == null || productList.isEmpty()) {
                return AviatorBoolean.valueOf(false);
            }
            String targetName = FunctionUtils.getStringValue(arg, env);
            List<String> projectNameList = productList.stream().map(Product::getName).collect(Collectors.toList());
            return AviatorBoolean.valueOf(projectNameList.contains(targetName));
        }

        public String getName() {
            return "productNameContains";
        }
    }
}

在实际项目开发中，我们可以在配置管理系统上配置 filter 过滤表达式，利用 Aviator 表达式求值引擎实现过滤条件动态管理，更加灵活的适应业务规则。