Java 中如何运行字符串表达式？！

背景和简介

在日常的开发中，偶尔会遇到运行字符串表达式的情况，通常这样的需求会对需求进行进一步分析，然后进行进一步 “特殊化”，最后直接写到硬代码中，这样做的话，就不太好扩展了；也有另外的处理方式是采用 Java 内置的 JavaScript 引擎等运行字符串表达式，但是内置引擎也有弊端，比如频繁运行片段式的字符串的效率非常低，并且与 Java 之间的数据交互比较麻烦，于是，便产生了写一个“字符串表达式计算引擎”的想法...

写的过程其实没想象中那么麻烦，最初版大概在今年 5 月底写好，但是结构比较混乱，写的时候基本上是一边写一边修，最后 if...else...这样的条件以及嵌套太多，以至于自己也无法完全理解，好在逻辑基本完善，运行也没出现意料之外的情况（也许出现了，只是没发现），并且是自己用，所以就没太在意。

前两个星期，又抽空重新整理了一遍，重新梳理了一下结构，扩展了一些功能，重新定义了一下各种符号的 “语义边界”，尽可能保证运算符与 Java 本身运算符一致，逻辑结构也更清晰，不会产生意外情况等。

RunnerUtil 在语法上很大程度参考了 JavaScript 的语法，比如用花括号表示一个键值对“对象”（实际上会被解析成 HashMap），键名不必用单引号或双引号包裹，单引号双引号均表示普通字符串，通过点号（.）和方括号链式取值等。这对于从事 JavaWeb 开发的同学来说，书写起来也比较方便。现在已经实现了绝大部分功能，已实现的功能也经过一定测试，确保能“符合期望”的运行，如果有想法和建议也希望多多的提一下哈。

项目地址：https://github.com/xua744531854/moon-util

基本用法介绍

字符串表达式通过一个叫 RunnerUtil 的静态类运行，可以直接运行得到表达式结果，也可以解析一个表达式后在需要的时候运行，RunnerUtil 主要有以下几个方法：

RunnerUtil.run(/* expression */); 直接运行表达式并得到结果；

RunnerUtil.run("1 + 1"); // 2
RunnerUtil.run(" 'Hello' + ' ' + 'World!' "); // "Hello World!"

RunnerUtil.run(/* expression */, / * data */); 运行含有变量的表达式，后面的 data 是变量将要指向的“值”；
RunnerUtil.parseRun(/* expression */); 直接运行“另一种”表达式，并得到结果，如：

RunnerUtil.parseRun("Hello {{   'World!'   }}"); // "Hello World!"

可见 #parseRun 是运行包含“插值语法”的表达式，被包裹的内容被作为一个表达式单独运行；

字符串中可以包含多个插值语法表达式，但不能嵌套和交叉，也可以运行含有变量的表达式。

Runner runner = RunnerUtil.parse(/* expression */);

解析一个字符串表达式，得到一个“字符串表达式运行器” —— Runner，然后调用其 run(/ * data */) 方法运行并得到结果。

语法及运算详细介绍

作为一个具有一定“语言特点”的东西，它定义了一些自己的语法、数据类型、运算类型等，但大部分都与 Java 和 JavaScript 兼容，相同符号具有相同或相似的语言意义。

数据类型：

null：这是一个关键字，但因为它符合和变量的定义规则，所以需要注意一下，同样被定义为关键字的还有 true 和 false。
boolean：true 和 false

RunnerUtil.run(" null   "); // null
RunnerUtil.run("   true "); // true
RunnerUtil.run("false"); // false
// 表达式中多余的空格自动忽略

数字：这里面的数字统一采用 Java 里的 int 和 double 型数据，直接参与运算的也只有是这两种类型，区别就是有没有小数点。

RunnerUtil.run(" 12  "); // 12
RunnerUtil.run(" 12.5 "); // 12.5
// 表示数字必须是连续，中间不能有空格的
// 否则将抛出异常，如
RunnerUtil.run(" 12. 5"); // 异常
RunnerUtil.run(" 1 2 "); // 异常

表示数字的字符之间应该是连续的，如：25、36.9 等；如果是不连续的会抛出异常，如：2 5、36 .9 等；

字符串：Java 里的字符串用双引号包裹，在这里还将表示字符的单引号“征用”，双引号单引号包裹的都表示普通字符串的直接值，这样做也是为了书写方便（与 JavaScript 相似），同时也就没有了 char 类型数据啦啦啦……

RunnerUtil.run(" 'abcdef'  "); // "abcdef"
RunnerUtil.run(" \"abcdef\"  "); // "abcdef"
RunnerUtil.run(" 'abc   def'  "); // "abc   def"

List：实际上是 ArrayList，对应 JavaScript 里面的数组。Java 的数组也对应 JavaScript 数组。

RunnerUtil.run(" { } "); 
// 总是返回一个空ArrayList

RunnerUtil.run(" {1,2,,4, } "); 
// 总是返回一个包含：1、2、null、4 这几项的 ArrayList

// 可以看出最后一个逗号之后如果是结束符号会自动忽略
// 中间的逗号与逗号之间若没有其他非空白符号会插入一个 null 值

Map：实际上是 HashMap，对应 JavaScript 里的对象。同样对应 JavaScript 对象的还有普通 POJO。

Map 对应的是 JavaScript 里的对象，但是在这里 Map 的键可以是这些数据类型：

null、true / false、数字（int / double）、字符串，不能再是其他 Java 对象了

RunnerUtil.run(" {:} "); // 总是返回一个空 HashMap，
// 注意与空 List 的异同，都是用花括号表示
// 但空 Map 里面需要有一个冒号，否则就是 List

RunnerUtil.run(" {key: 'value'}");
// 总是返回包含一个键值对的 HashMap
// 可以看出，对象的键名是字符串的话可以不用引号包裹
// 但是值必须被包裹
RunnerUtil.run(" {true: 'value'}"); // 键是 true
/*
 * 这里的 true 不是字符串，而是 boolean。
 * 同样，未被引号包裹的 null、false、数字都是对应类型的数据，而不是字符串
 * 其他符合变量命名规则的键都是普通字符串，被单引号或双引号包裹的也是
 */
RunnerUtil.run(" {'true': 'value', 25: false, 'name': \"张三\"}");

运算支持的类型：

普通四则混合运算：+、-、*、/、%、()

RunnerUtil.run(" 1 + 1 "); // 2
RunnerUtil.run(" 1 + (3 * 4)) "); // 13
RunnerUtil.run(" 'Hello ' + \"World!\" ");  // "Hello World!"
RunnerUtil.run(" true + false "); // "truefalse"
/*
 * true+false 在 Java 中是不允许的
 * 但如果是“+”运算的话，这里均作为普通字符串；
 * 相当于调用了 toString 方法
 */

位运算：&、|、^、<<、>>

RunnerUtil.run(" 1 ^ 1 "); 
RunnerUtil.run(" 1 & 1 "); 
RunnerUtil.run(" 1 | 1 "); 
RunnerUtil.run(" 1 << 1 "); 
RunnerUtil.run(" 1 >> 1 ");

比较运算：>、>=、==、<=、<

RunnerUtil.run(" 1 + 1 == 2 "); // true
RunnerUtil.run(" 1 + 1 < 2 "); // false

逻辑运算：&&、||、!

RunnerUtil.run("1+1==2 && 5 > 4"); // true

三元运算：assertExpression ? trueExpression : falseExpression

RunnerUtil.run("true ? 'name' : 'age'"); // name
RunnerUtil.run("false ? 'name' : 'age'"); // age
RunnerUtil.run("1 > 2 ? 'name' : 'age'"); // age
RunnerUtil.run("1 < 2 ? 'name' : 'age'"); // name

变量：命名规则与 Java 变量命名规则相同，同时 null、true、false 不能作为变量

表达式中包含变量就代表这个表达式在运行得到结果时需要从外部获取数据，如果不能正确的从数据源读取到数据，运行就会抛出异常；

RunnerUtil.run(" 'Hello, ' + name "); // 抛出异常

Map data = new HashMap();
data.put("name", "Li Lei!");

RunnerUtil.run(" 'Hello, ' + name ", data); // "Hello, Li Lei!"

链式取值：链式语法与 JavaScript 很相似

HashMap data = new HashMap(); 

ArrayList list = new ArrayList(); 
list.add(true); 
list.add(false); 
list.add(25); 
list.add('隔壁老王'); 

HashMap map = new HashMap(); 
map.put("name", "小四"); 
map.put("index", 2); 
map.put(true, "true 是 Boolean 类型作为键"); 

data.put("list", list); 
data.put("map", map); 

RunnerUtil.run("map.name", data); // "小四"

RunnerUtil.run("map['name']", data); 
// "小四" （也可以这样取值）

RunnerUtil.run("list[ 2 ]", data);
// 25 （索引取值需要用方括号包裹） 

RunnerUtil.run("list[3]", data);
// "隔壁老王" （索引取值需要用方括号包裹） 

RunnerUtil.run("list[map.index]", data); // 25
// （这是高级点的用法，方括号包含另一个表达式
// 返回值是一个索引，然后返回索引指向的值）

RunnerUtil.run("[true]", data); // "true 是 Boolean 类型作为键"
// 如果不用方括号包括，true 就是一个直接值，返回 true
// 那么问题来了：
// 如果传入的数据不是 Map 或 POJO，而是 List 或数组怎么办呢？
RunnerUtil.run(" [1] ", list); // false
// 啊……唐宗宋祖，略显风骚！

// 这种链式语法与 JavaScript 很相似

运行方法：目前只能运行无参和一个参数的方法，变长参数的方法支持不完善，慎用。

// 这里的数据 data 继续用上一条的 data，具体数据不写了

RunnerUtil.run("map.size()", data); // 3
RunnerUtil.run("map.get('name')", data); // "小四" 
RunnerUtil.run("map.get('name').length()", data); // 2
RunnerUtil.run("map.name.length()", data); // 2
RunnerUtil.run(" [3].length() ", list); // 4
// 唐宗宋祖，又显风骚！

运行静态方法： @ ；运行静态方法需要用到“@”符号作为标记。目前也不支持多参数方法调用。

当你打开源码会发现这是一整个独立的工具库，很多方法和 commons-lang 包内容相似（个人认为不是重复造轮子，也有很多不同的和不如的）...，运行静态方法也可以运行这个工具库内的所有工具方法，暂时未将 RunnerUtil 剥离出来，也还不支持自定义的静态方法调用，不过这个工具库所提供的功能

RunnerUtil.run("@System.currentTimeMillis() ");
// 15.....（一个毫秒数）
RunnerUtil.run("@Objects.toString(25) "); // "25"

自定义 List 类型、Map 类型、静态方法调用类。


public static class InnerObjects {
    public static String toString(Object o){
        return "123";
    }
}

RunnerSettings settings = RunnerSettings.builder()
    // 自定义生成的数组是 LinkedList，默认 ArrayList
    .setArrCreator(LinkedList::new)
    // 自定义生成的数组是 TreeMap，默认是 HashMap
    .setArrCreator(TreeMap::new)
    // 自定义静态方法类 Objects，将覆盖 java.util.Objects
    .addCaller("Objects", InnerObjects.class)
    .build();

Runner runner0 = RunnerUtil.parse("@Objects.toString('juejin shequ')");
Runner runner1 = RunnerUtil.parse("@Objects.toString('juejin shequ')", settings);

Object result0 = runner0.run(); // "juejin shequ"
Object result1 = runner1.run(); // "123"

综上，就是这个工具库所支持的字符串表达式运算了，以上所列举的运算可以嵌套、连接、但是不能交叉的进行运算。

RunnerUtil 原本是为了一个通用 Excel 导出工具而写的，现在导出功能已经实现，导入功能还在实现中，工具在也在同一个 Github 中，里面包含一个实用例子，和一个导出数据测试表。

接下来要做的是加入的功能是多参数方法调用，顺便问一下需要将 RunnerUtil 剥离出来的吗？如果有，请留言一下，会尽快抽时间剥离，否则得过一段时间了。

希望对大家的日常开发有所帮助，也希望大家给点意见，如出现 BUG 一定在最快的时间内修改，谢谢大家啦啦啦！！