规则引擎之--Google Aviator

前言

在日常的项目开发中，会有各种规则的计算，有时候我们会大量使用if else来做判断，这会使代码看起来很臃肿，代码结构也比较复杂，为了解决这些问题，由此诞生了规则引擎，如drools、Groovy、Aviator、Easy-rules、LiteFlow。这些规则引擎各有优势，在我们项目中，是使用的Google 的Aviator，使用下来发现，有几个比较明显的优点：

 1.引入方便，不需要多余的配置

 2.对于业务无入侵，结构比较轻巧

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

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

支持大部分运算操作符，包括算术操作符、关系运算符、逻辑操作符、位运算符、正则匹配操作符(=~)、三元表达式?: ，并且支持操作符的优先级和括号强制优先级。

Aviator的限制：

没有if else、do while等语句，没有赋值语句，仅支持逻辑表达式、算术表达式、三元表达式和正则匹配。

不支持八进制数字字面量，仅支持十进制和十六进制数字字面量。

下面为Aviator规则简单使用demo：

  模拟一个场景，有一个积分计算规则：

    普通用户：总积分=单次消费产生的积分*注册年限

    Vip1用户：总积分=单次消费产生的积分*注册年限*10

    Vip2用户：总积分=单次消费产生的积分*注册年限*20

1.引入相关的依赖

   <!-- 谷歌aviator规则引擎 -->
        <dependency>
            <groupId>com.googlecode.aviator</groupId>
            <artifactId>aviator</artifactId>
            <version>5.3.3</version>
        </dependency>

2.编写规则函数，继承AbstractFunction，并重写call() 和getName（）方法

call()方法有多个重载方法，可以根据实际情况重写，getName() 自定义一个返回名字即可

vip1规则函数：

package com.example.ftweb.rule.function;

import com.googlecode.aviator.runtime.function.AbstractFunction;
import com.googlecode.aviator.runtime.function.FunctionUtils;
import com.googlecode.aviator.runtime.type.AviatorDecimal;
import com.googlecode.aviator.runtime.type.AviatorObject;
import org.apache.commons.lang3.StringUtils;

import java.math.BigDecimal;
import java.util.Map;
import java.util.Objects;

/**
 * @author aaa
 * @date 2023-12-04 10:18
 * @description 一级vip计算
 */
public class Vip1Function extends AbstractFunction {

    private static final long serialVersionUID = 4218704464136946205L;


    /**
     * 返回结果
     * @param env 参数map
     * @param arg1  map里的key名
     * @param arg2 map里的key名
     * @param arg3 map里的key名
     * @return {@link AviatorObject}
     */
    @Override
    public AviatorObject call(Map<String, Object> env, AviatorObject arg1, AviatorObject arg2, AviatorObject arg3) {
        // 获取对象参数
//        Object javaObject = FunctionUtils.getJavaObject(arg1, env);
        BigDecimal bigDecimal = (BigDecimal) FunctionUtils.getJavaObject(arg1, env);
        Integer value = (Integer) FunctionUtils.getNumberValue(arg2, env);
        String type = FunctionUtils.getStringValue(arg3, env);

        if (StringUtils.equals("V1", type)) {
            if (Objects.isNull(bigDecimal)) {
                bigDecimal = BigDecimal.ONE;
            }
            bigDecimal = bigDecimal.multiply(new BigDecimal(value)).multiply(BigDecimal.TEN);
            return new AviatorDecimal(bigDecimal);
        }
        return null;

    }

    /**
     * @return {@link String}
     */
    @Override
    public String getName() {
        return "vip1";
    }
}

Vip2规则函数：

package com.example.ftweb.rule.function;

import com.googlecode.aviator.runtime.function.AbstractFunction;
import com.googlecode.aviator.runtime.function.FunctionUtils;
import com.googlecode.aviator.runtime.type.AviatorDecimal;
import com.googlecode.aviator.runtime.type.AviatorObject;
import org.apache.commons.lang3.StringUtils;

import java.math.BigDecimal;
import java.util.Map;
import java.util.Objects;

/**
 * @author aaa
 * @date 2023-12-04 10:18
 * @description 二级vip计算
 */
public class Vip2Function extends AbstractFunction {

    private static final long serialVersionUID = -8782657886354529640L;


    /**
     * 返回结果
     * @param env 参数map
     * @param arg1  map里的key名
     * @param arg2 map里的key名
     * @param arg3 map里的key名
     * @return {@link AviatorObject}
     */
    @Override
    public AviatorObject call(Map<String, Object> env, AviatorObject arg1, AviatorObject arg2, AviatorObject arg3) {
        BigDecimal bigDecimal = (BigDecimal) FunctionUtils.getJavaObject(arg1, env);
        Integer year = (Integer) FunctionUtils.getNumberValue(arg2, env);
        String type = FunctionUtils.getStringValue(arg3, env);
        if (StringUtils.equals("V2", type)) {
            if (Objects.isNull(bigDecimal)) {
                bigDecimal = BigDecimal.ONE;
            }
            bigDecimal = bigDecimal.multiply(new BigDecimal(year)).multiply(new BigDecimal(20));
            return new AviatorDecimal(bigDecimal);
        }
        return null;

    }

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

普通用户：

package com.example.ftweb.rule.function;

import com.googlecode.aviator.runtime.function.AbstractFunction;
import com.googlecode.aviator.runtime.function.FunctionUtils;
import com.googlecode.aviator.runtime.type.AviatorDecimal;
import com.googlecode.aviator.runtime.type.AviatorObject;
import org.apache.commons.lang3.StringUtils;

import java.math.BigDecimal;
import java.util.Map;
import java.util.Objects;

/**
 * @author aaa
 * @date 2023-12-04 10:44
 * @description 普通用户积分计算
 */
public class NormalFunction  extends AbstractFunction {
    private static final long serialVersionUID = -5862571263644261319L;


    /**
     * 返回结果
     * @param env 参数map
     * @param arg1  map里的key名
     * @param arg2 map里的key名
     * @param arg3 map里的key名
     * @return {@link AviatorObject}
     */
    @Override
    public AviatorObject call(Map<String, Object> env, AviatorObject arg1, AviatorObject arg2, AviatorObject arg3) {
        BigDecimal bigDecimal = (BigDecimal) FunctionUtils.getJavaObject(arg1, env);
        Integer year = (Integer) FunctionUtils.getNumberValue(arg2, env);
        String type = FunctionUtils.getStringValue(arg3, env);
        if (StringUtils.equals("normal", type)) {
            if (Objects.isNull(bigDecimal)) {
                bigDecimal = BigDecimal.ONE;
            }
            bigDecimal = bigDecimal.multiply(new BigDecimal(year));
            return new AviatorDecimal(bigDecimal);
        }
        return null;
    }

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

3.将规则函数写入处理器

package com.example.ftweb.rule.execute;

import com.example.ftweb.rule.function.NormalFunction;
import com.example.ftweb.rule.function.Vip1Function;
import com.example.ftweb.rule.function.Vip2Function;
import com.googlecode.aviator.AviatorEvaluator;

import java.math.BigDecimal;
import java.util.*;

/**
 * @author aaa
 * @date 2023-12-04 10:08
 * @description 积分计算转换
 */
public class ScoreParse {

    public static BigDecimal getScoreNumbers(String type, BigDecimal score, int year) {
        Map<String, Object> paramMap = new LinkedHashMap<>(8);
        paramMap.put("score", score);
        paramMap.put("year", year);
        paramMap.put("type", type);
        AviatorEvaluator.addFunction(new Vip1Function());
        AviatorEvaluator.addFunction(new Vip2Function());
        AviatorEvaluator.addFunction(new NormalFunction());
        // vip1为Vip1Function中的getName()方法返回的值
        Object vip1 = AviatorEvaluator.execute("vip1(score,year,type)", paramMap, true);
        if (Objects.nonNull(vip1)) {
            return (BigDecimal) vip1;
        }
        // vip2为Vip2Function中的getName()方法返回的值
        Object vip2 = AviatorEvaluator.execute("vip2(score,year,type)", paramMap, true);
        if (Objects.nonNull(vip2)) {
            return (BigDecimal) vip2;
        }
        // normal为NormalFunction中的getName()方法返回的值
        Object normal = AviatorEvaluator.execute("normal(score,year,type)", paramMap, true);
        if (Objects.nonNull(normal)) {
            return (BigDecimal) normal;
        }
        return  null;


    }

}

注意点：execute()方法的第一个参数，是字符串，getName()方法里面的返回值的内容， 里面的参数顺序需要与paramMap里面放的顺序一致，在xxFunction里面使用FunctionUtils取值，值转换也要使用对应的顺序

 测试结果：

可以看到根据不同的用户类型，生成了不同的积分值

以上就是Google Aviator的简单应用，更复杂的应用需要一起探讨，不足之处，敬请指出！