【表达式引擎】简单高效的轻量级Java表达式引擎：Aviator

桃扇骨 2024-03-17 23:51 48阅读 0赞

## 简单高效的轻量级表达式引擎：Aviator ##

## 前言 ##

> **Aviator** 是一个高性能、、轻量级的表达式引擎，支持表达式动态求值。其设计目标为轻量级和高性能，相比于 **Groovy** 和 **JRuby** 的笨重，**Aviator** 就显得更加的小巧。与其他的轻量级表达式引擎不同，其他的轻量级表达式引擎基本都是通过解释代码的方式来运行，而 **Aviator** 则是直接将表达式编译成Java字节码，交给JVM来运行。

## 使用方式 ##

### 引入依赖 ###

<dependency>
        <groupId>com.googlecode.aviator</groupId>
        <artifactId>aviator</artifactId>
        <version>${version}</version>
    </dependency>

### 简单使用 ###

在 **Aviator** 中，我们可以直接定义一个常量表达式来让 **Aviator** 执行，下面我们通过一个简单的小案例来熟悉一下 **Aviator**

import com.googlecode.aviator.AviatorEvaluator;
    import org.junit.jupiter.api.Test;
    
    @Test
    void simpleTest(){
        
      String expression = "3 + 2 * 6";
      Object result = AviatorEvaluator.execute(expression);
      System.out.println(result);
    }

![image.png][]

可以看到我们成功运行，且结果就是我们预期的15。

### 变量表达式 ###

在用过了常量表达式后，我们还可以通过声明变量的形式来实现表达式的运行。

import com.googlecode.aviator.AviatorEvaluator;
    import org.junit.jupiter.api.Test;
    
    import java.util.HashMap;
    import java.util.Map;
    
    @Test
    void variableTest(){
        
      // 1.定义变量
      Map<String, Object> map = new HashMap<>();
      map.put("name", "张三");
      map.put("job", "程序员");
    
      // 2.定义表达式
      String exp = "'你好，我是'+ name + '，我的职业是' + job + '，很高兴认识你'";
      
      // 3.使用Aviator执行表达式
      Object result = AviatorEvaluator.execute(exp, map);
    
      // 4.输出结果
      System.out.println(result);
      
    }

![image.png][image.png 1]

需要注意的是：在书写表达式的时候，格式跟在Java中书写相差不大。由于我们是在字符串中书写的表达式，需要注意 **表达式中的字符串也要用单引号包裹起来**，否则 **Aviator** 会将你的字符串判定为一个变量，然后去变量map中去寻找，当找不到的时候就会报错。

### 自定义函数 ###

在见识过以上两种使用方式后，**Aviator** 还支持以自定义函数的形式来执行表达式

import com.googlecode.aviator.runtime.function.AbstractFunction;
    import com.googlecode.aviator.runtime.type.AviatorLong;
    import com.googlecode.aviator.AviatorEvaluator;
    import com.googlecode.aviator.runtime.function.AbstractFunction;
    import com.googlecode.aviator.runtime.type.AviatorObject;
    
    import org.junit.jupiter.api.Test;
    
    class CustomFunction extends AbstractFunction{
        
      @Override
        public String getName() {
        
          return "customFunc";
        }
    
      @Override
      public AviatorObject call(Map<String, Object> env, AviatorObject arg1, AviatorObject arg2) {
        
        Number num1 = arg1.numberValue(env);
        Number num2 = arg2.numberValue(env);
        Long sum = num1.longValue() + num2.longValue();
        return AviatorLong.valueOf(sum);
      }
    
      @Test
      void customFuncTest(){
        
        // 将自定义函数注册到Aviator中
        AviatorEvaluator.addFunction(new CustomFunction());
    
        // 执行
        Long result = (Long) AviatorEvaluator.execute("customFunc(50,20)");
    
        // 输出结果
        System.out.println(result);
      }
    }

![image.png][image.png 2]

我们声明完自定义函数后，需要先注册到 **Aviator** 中之后才能使用，同时我们也可以发现，自定义函数中也是调用的 `AviatorEvaluator.execute()` 方法，那么就说明调用自定义函数时也是可以做动态变量传值的，如下：

import com.googlecode.aviator.runtime.function.AbstractFunction;
    import com.googlecode.aviator.runtime.type.AviatorLong;
    import com.googlecode.aviator.AviatorEvaluator;
    import com.googlecode.aviator.runtime.function.AbstractFunction;
    import com.googlecode.aviator.runtime.type.AviatorObject;
    
    import org.junit.jupiter.api.Test;
    
    class CustomFunction extends AbstractFunction{
        
      @Override
        public String getName() {
        
          return "customFunc";
        }
    
      @Override
      public AviatorObject call(Map<String, Object> env, AviatorObject arg1, AviatorObject arg2) {
        
        Number num1 = arg1.numberValue(env);
        Number num2 = arg2.numberValue(env);
        Long sum = num1.longValue() + num2.longValue();
        return AviatorLong.valueOf(sum);
      }
    
      @Test
      void customFuncTest(){
        
        // 声明变量
        Map<String, Object> map = new HashMap<>();
        map.put("a", 50);
        map.put("b", 20);
        // 将自定义函数注册到Aviator中
        AviatorEvaluator.addFunction(new CustomFunction());
    
        // 执行
        Long result = (Long) AviatorEvaluator.execute("customFunc(a,b)", map);
    
        // 输出结果
        System.out.println(result);
      }
    }

## 应用案例 ##

既然学习完了上面三种使用方式，那我们就可以来找个简单的应用案例实操一下了。

假如我们做了一个OA系统，员工每完成一个项目会积累一定的积分，积分可以用来兑换一些公司内自定的奖品，公式我们暂定为：`[(总数 * num + 已完成项目数量 * 0.5 -未完成项目数量 * 0.5)/总数] * 10` ，其中 `num` 的值是根据项目总数变化的，具体公式为`(总数去除个位数) / 1000 + 0.9`，并且这个公式可能在之后的场景里会改变，有了场景我们就来具体实现一下。

### 建表 ###

首先我们要先建个表来存放我们的公式。

/*
     Navicat Premium Data Transfer
    
     Source Server         : localhost
     Source Server Type    : MySQL
     Source Server Version : 80032 (8.0.32)
     Source Host           : localhost:3306
     Source Schema         : study
    
     Target Server Type    : MySQL
     Target Server Version : 80032 (8.0.32)
     File Encoding         : 65001
    
     Date: 22/07/2023 14:31:01
    */
    
    SET NAMES utf8mb4;
    SET FOREIGN_KEY_CHECKS = 0;
    
    -- ----------------------------
    -- Table structure for aviator_expression
    -- ----------------------------
    DROP TABLE IF EXISTS `aviator_expression`;
    CREATE TABLE `aviator_expression`  (
      `var_id` int NOT NULL AUTO_INCREMENT COMMENT '表达式id',
      `var_name` varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '表达式名称',
      `expression` text CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL COMMENT '表达式',
      `create_user_id` int NULL DEFAULT NULL COMMENT '创建用户id',
      `create_user_name` varchar(30) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '创建用户名称',
      `create_time` datetime NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
      `update_user_id` int NULL DEFAULT NULL COMMENT '最后修改用户id',
      `update_user_name` varchar(30) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '最后修改用户名称',
      `update_time` datetime NULL DEFAULT NULL COMMENT '最后修改时间',
      PRIMARY KEY (`var_id`) USING BTREE
    ) ENGINE = InnoDB AUTO_INCREMENT = 3 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_0900_ai_ci ROW_FORMAT = Dynamic;
    
    -- ----------------------------
    -- Records of aviator_expression
    -- ----------------------------
    INSERT INTO `aviator_expression` VALUES (1, '计算个人积分', '(total * double(num) + completedNum * 0.5 - unFinishedNum * 0.5) * 10', 0, '超级管理员', '2023-07-22 11:00:48', NULL, NULL, NULL);
    INSERT INTO `aviator_expression` VALUES (2, '计算个人积分子项', 'totalInt / 1000 + 0.9', 0, '超级管理员', '2023-07-22 14:30:48', NULL, NULL, NULL);
    
    -- ----------------------------
    -- Table structure for employee_project
    -- ----------------------------
    DROP TABLE IF EXISTS `employee_project`;
    CREATE TABLE `employee_project`  (
      `emp_id` int NOT NULL AUTO_INCREMENT COMMENT '员工id',
      `name` varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '员工名称',
      `total` int NULL DEFAULT NULL COMMENT '项目总数',
      `completed_num` int NULL DEFAULT NULL COMMENT '已完成项目数量',
      `unFinished_num` int NULL DEFAULT NULL COMMENT '未完成项目数量',
      PRIMARY KEY (`emp_id`) USING BTREE
    ) ENGINE = InnoDB AUTO_INCREMENT = 4 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_0900_ai_ci ROW_FORMAT = Dynamic;
    
    -- ----------------------------
    -- Records of employee_project
    -- ----------------------------
    INSERT INTO `employee_project` VALUES (1, '张三', 9, 7, 2);
    INSERT INTO `employee_project` VALUES (2, '李四', 10, 9, 1);
    INSERT INTO `employee_project` VALUES (3, '王五', 23, 20, 3);
    
    SET FOREIGN_KEY_CHECKS = 1;

### 实现 ###

#### Controller ####

import com.aviator.service.AviatorExpressionService;
    import com.aviator.vo.PerformanceVo;
    import lombok.RequiredArgsConstructor;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import java.util.List;
    
    /**
     * @author Bummon
     * @description
     * @date 2023-07-22 14:32
     */
    @RestController
    @RequiredArgsConstructor
    @RequestMapping("/performance")
    public class PerformanceController {
        
    
        private final AviatorExpressionService expressionService;
    
        @GetMapping("/calculate")
        public List<PerformanceVo> calculatePerformance() {
        
            return expressionService.calculatePerformance();
        }
    
    }

#### Service ####

import com.aviator.entity.AviatorExpression;
    import com.aviator.vo.PerformanceVo;
    import com.baomidou.mybatisplus.extension.service.IService;
    
    import java.util.List;
    
    /**
     * @author Bummon
     * @description 针对表【aviator_expression】的数据库操作Service
     * @createDate 2023-07-22 14:32:24
     */
    public interface AviatorExpressionService extends IService<AviatorExpression> {
        
    
        /**
         * @return {@link List< PerformanceVo>}
         * @date 2023-07-22 14:36
         * @author Bummon
         * @description 计算绩效
         */
        List<PerformanceVo> calculatePerformance();
    
    }

#### ServiceImpl ####

import cn.hutool.core.bean.BeanUtil;
    import com.aviator.entity.EmployeeProject;
    import com.aviator.service.EmployeeProjectService;
    import com.aviator.vo.PerformanceVo;
    import com.baomidou.mybatisplus.core.toolkit.Wrappers;
    import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
    import com.googlecode.aviator.AviatorEvaluator;
    import lombok.RequiredArgsConstructor;
    import com.aviator.entity.AviatorExpression;
    import com.aviator.service.AviatorExpressionService;
    import com.aviator.mapper.AviatorExpressionMapper;
    import org.springframework.stereotype.Service;
    
    import java.text.DecimalFormat;
    import java.util.HashMap;
    import java.util.List;
    import java.util.Map;
    
    /**
     * @author Bummon
     * @description 针对表【aviator_expression】的数据库操作Service实现
     * @createDate 2023-07-22 14:32:24
     */
    @Service
    @RequiredArgsConstructor
    public class AviatorExpressionServiceImpl extends ServiceImpl<AviatorExpressionMapper, AviatorExpression>
            implements AviatorExpressionService {
        
    
        private final EmployeeProjectService employeeProjectService;
    
        @Override
        public List<PerformanceVo> calculatePerformance() {
        
            //员工项目完成项目情况列表
            List<EmployeeProject> employeeProjectList = employeeProjectService.list();
            List<PerformanceVo> performanceList = BeanUtil.copyToList(employeeProjectList, PerformanceVo.class);
            //计算绩效公式
            AviatorExpression performanceExp = this.getOne(Wrappers.lambdaQuery(AviatorExpression.class)
                    .eq(AviatorExpression::getVarName, "团队积分计算"));
            //绩效子项计算
            AviatorExpression performanceChildExp = this.getOne(Wrappers.lambdaQuery(AviatorExpression.class)
                    .eq(AviatorExpression::getVarName, "计算团队积分子项"));
            performanceList.forEach(any -> {
        
                //利用int向下取整的特性去除整数最后一位
                int totalInt = any.getTotal() / 10;
                Map<String, Object> map = new HashMap<>();
                map.put("totalInt", totalInt);
                //计算绩效子项
                Double num = (Double) AviatorEvaluator.execute(performanceChildExp.getExpression(), map);
                //计算绩效，并保留一位小数
                Map<String, Object> paramMap = BeanUtil.beanToMap(any);
                paramMap.put("num", num);
                Double doublePerformance = (Double) AviatorEvaluator.execute(performanceExp.getExpression(), paramMap);
                DecimalFormat df = new DecimalFormat("#.#");
                String performance = df.format(doublePerformance);
                any.setPerformance(performance);
            });
            return performanceList;
        }
    }

![image.png][image.png 3]

由于num在传入的时候数据类型为`String` 类型，但是 **Aviator** 对数据类型要求比较严格，所以我们要在表达式里面将`num` 转为 `double` 类型。

## 总结 ##

我们一共学习了 **Aviator** 的三种用法：**简单表达式**、**变量表达式** 和 **自定义函数**。  
同时也通过一个简单的小案例供大家学习参考，大家也可以根据实际应用场景的不同来自行更改实现方式。

至此教程就结束啦，感谢大家的关注。

--------------------

## 推荐 ##

关注博客和公众号获取最新文章

[Bummon’s Blog][Bummon_s Blog] ｜ [Bummon’s Home][Bummon_s Home] ｜ [公众号][Link 1]

[image.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/36542345479345f89f9b99415af8093a.png
[image.png 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/da5357b2655f42e3b470ccf46b8cc743.png
[image.png 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/9ee0b76bba704989baa81aae6ab43757.png
[image.png 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/34d50e5fe05642d6989547cdba887342.png
[Bummon_s Blog]: https://blog.bummon.com/
[Bummon_s Home]: https://www.bummon.com/
[Link 1]: https://www.bummon.com/wechat/