MVEL2.0表达式使用指南

思维导图

MVEL2.0表达式使用指南

简介

MVEL为 MVFLEX Expression Language（MVFLEX表达式语言）的缩写，是一种基于Java语法，但又有着显著不同的表达式语言。与Java不同的是，MVEL是一种动态/静态可嵌入的表达式语言，意味着源代码中不需要类型限定。
简单来说是一种强大的表达式解析器。我们可以自己写一些表达式，交给mvel进行解析计算，得到这个表达式计算的值。

太抽象？先来个demo吧。。。。

package com.learn.mvel;

import org.mvel2.MVEL;

/**
 * @Auther: fc.w
 * @Date: 2021/1/16 23:29
 * @Description:
 */
public class MvelDemo {

    public static void main(String[] args) {
        // java 语法
        int result = 1 + 2;
        System.out.println(result); // 结果：3

        // mvel 语法
        Object res = MVEL.eval("1 + 2");
        System.out.println(res); // 结果：3

    }

}

是不是很吃鲸。“1 + 2” 就是一个表达式，第一种是Java硬编码实现的计算结果，但第二种直接给evel函数传递一个表达式字符串，直接能计算出结果。

哈哈哈，接下来一起了解一下语法吧，至于使用场景，下篇文章介绍MVEL在我们公司的个性化推荐平台中做了什么。

1. 基本语法

1.1 简单属性表达式

user.name

在这个表达式中，我们只是有一个标识符（user.name），这就是我们所说的MVEL的AA级属性表达式，该表达式的唯一目的是获取一个变量或上下文对象的属性。属性表达式是MVEL的最常见的用途之一，通过它，MVEL可以用来作为一个高性能，易使用的反射优化器。

1.2 布尔表达式

MVEL甚至可以用于执行布尔表达式：

user.name == 'John Doe'

像java一样，MVEL支持所有优先级规则，包括通过括号来控制执行顺序，如：

(user.name == 'John Doe') && ((x * 2) - 1) > 20

1.3 复合语句表达式

可以编写具有任意数量语句的脚本，使用分号来表示一个语句的终止。只有一个语句或在脚本中的最后一个语句的情况下，可以不用使用分号：statement1; statement2; statement3
最后的语句可以不使用分号，因为是脚本中的最后一个语句。注意，换行不能替代分号来作为一个语句的结束标识。

1.4 返回值

MVEL表达式使用最后值输出原则(a last value out principle)。这意味着虽然MVEL支持return关键字，但可以不使用它。例如：

a = 10;
b = (a = a * 2) + 10;
a;

在上面的例子中，表达式返回了a的值，因为其是表达式的最后一个值。它在功能上与以下相同：

a = 10;
b = (a = a * 2) + 10;
return a;

2. 操作符

2.1 一元操作符

new：用来实例化对象，例：new String("foo")
with：对单个对象执行多个操作，例：with (value) { name = 'Foo', age = 18, sex = Sex.FEMALE }
assert：用一个AssertionError 断言一个值的对错，例：assert foo != null
isdef：用来判断一个变量在某个范围内是否定义，例：isdef variableName
！：布尔取反操作符，例： ！true == false

2.2 比较运算符

常见的比较运算符==，！= ，>,<,>=,<=等不再赘述
contains：判断左边的值是否包含右边的值，如： var contains "Foo"
is/instance of ：判断左边的值是否是右边的类的实例，如：var instanceof Integer
strsim：比较两个字符串的相似度，返回一个百分数，如："foobie" strsim "foobar"
soundslike：比较两个字符串的发音，如："foobar" soundslike "fubar"

2.3 逻辑运算符

&&、||：略
or：用于多个值间进行逻辑或运算，如：foo or bar or barfoo or 'N/A'
~=：正则表达式匹配符，如：foo ~= '[a-z].+'

2.4 按位运算符

&，|,^等

2.5 数学运算符

+，-，*，/等

2.6 其它运算符：

+，字符串连接运算，如："foo" + "bar"
#，字符连接运算，如：1 # 2 返回 "12"
in，投影整个项目集合，如：(foo in list)
=，赋值运算符，如：var = "foobar"

3. Value 校验

在 MVEL 中所有的等式判断都是基于值，并非是对象的引用，因此表达式 foo == 'bar' 等价于java中的 foo.equals("bar")。

3.1 Empty

MVEL 提供了一个特殊的字面值，用于校验一个值是否为""或者null，命名为empty。
例如：a == empty
如果 a 的值满足 empty 的要求，则示例表达式将为 true。

package com.learn.mvel;

import org.mvel2.MVEL;

import java.util.HashMap;
import java.util.Map;

/**
 * @Auther: fc.w
 * @Date: 2021/1/17 00:17
 * @Description:
 */
public class MvelEmpty {

    public static void main(String[] args) {
        String expression = "a == empty && b == empty";

        Map paramMap = new HashMap<>();
        paramMap.put("a", "");
        paramMap.put("b", null);

        Object object = MVEL.eval(expression, paramMap);
        System.out.println(object); // true
    }

}

3.2 Null

MVEL允许使用关键字 null 或 nil 表示一个空值。

package com.learn.mvel;

import org.mvel2.MVEL;

import java.util.HashMap;
import java.util.Map;

/**
 * @Auther: fc.w
 * @Date: 2021/1/17 00:22
 * @Description:
 */
public class MvelNull {

    public static void main(String[] args) {
        String expression = "a == null && b == nil";

        Map map = new HashMap<>();
        map.put("a", null);
        map.put("b", null);

        Object obj = MVEL.eval(expression, map);
        System.out.println(obj); // true
    }

}

3.3 强制类型转换

MVEL的强制类型转换系统适用于如下场景：通过试图将右边的值强制转换为左边值的类型来比较两个无法比较的类型，反之亦然。

"123" == 123;

上述表达式在MVEL中返回 true，因为强制类型转换系统将强制将无类型数字123转换为字符串来执行比较。

    public static void main(String[] args) {
        String expression = "a == b";

        Map map = new HashMap<>();
        map.put("a", "12");
        map.put("b", "12");

        Object obj = MVEL.eval(expression, map);
        System.out.println(obj); // true
    }

4. 集合List, Maps, 数组

在MVEL中可以使用非常简单的语法来描述List、map、数组。
示例：

["Bob" : new Person("Bob"), "Michael" : new Person("Michael")]

功能上等同于以下代码：

Map map = new HashMap();
map.put("Bob", new Person("Bob"));
map.put("Michael", new Person("Michael"));

这是在MVEL中表达数据结构的非常强大的方法。可以在任何地方使用这些结构，甚至作为方法的参数：

something.someMethod(["foo" : "bar"]);

4.1 Lists

可以使用下列格式表示

[item1，item2，...]

Example:

["Jim", "Bob", "Smith"]

4.2 Maps

Maps可以使用下列格式表示：

[key1 : value1, key2: value2, ...]

Example:

["Foo" : "Bar", "Bar" : "Foo"]

4.3 数组

Arrays可以使用下列格式表示：

{item1, item2, ...}

Example:

{"Jim", "Bob", "Smith"}

4.4 Array 强制类型转换

关于数组，需要知道的一个非常重要的方面是，它可以被强制转换成其它类型的数组，当你声明一个数组时，是不直接指定其类型的，但你可以通过将其传递给一个接收int[]类型参数的方法来指定。如：foo.someMethod({1,2,3,4})
在这种情况下，MVEL会看到目标方法接受一个int[]参数并自动转换数组类型。

5. 属性

MVEL属性遵循在其他语言（如Groovy，OGNL，EL等）中的bean属性表达中的完整约定。与需要限定的其他语言不同，MVEL提供了访问属性，静态字段，Map等的单一统一语法。

5.1 Bean Properties

大多数Java开发人员熟悉并使用其Java对象中的getter/setter方法，以便封装属性访问。例如，你可以从对象访问属性：

user.getManager().getName();

为了简化此操作，你可以使用以下表达式访问相同的属性：

user.manager.name

Example:

package com.learn.mvel;

import org.mvel2.MVEL;

import java.util.HashMap;
import java.util.Map;

/**
 * @Auther: fc.w
 * @Date: 2021/1/17 00:48
 * @Description:
 */
public class MvelParam {

    public static void main(String[] args) {
        Fruit fruit = new Fruit();
        fruit.setName("Apple");

        // String expression = "fruit.getName()";
        String expression = "fruit.name";

        Map paramMap = new HashMap<>();
        paramMap.put("fruit", fruit);
        
        Object object = MVEL.eval(expression, paramMap);
        System.out.println(object); // Apple
    }

}

注意：当一个对象中的字段的作用域是public时，MVEL仍然希望于通过get方法来访问其属性。

5.2 Null-Safe Bean Navigation

当表达式中会含有null元素时，这时就需要进行一个为空判断，否则就会发生错误。当使用null-safe操作符时，可以简化这个操作：

user.?manager.name

功能上等同于：

if (user.manager != null) { return user.manager.name; } else { return null; }

5.3 Collections

集合的遍历也可以使用缩写语法实现。

5.3.1 List

List的访问与数组相同。例如：

user[5]

相当于Java代码：

user.get(5);

5.3.2 Map

Map以数组相同的方式访问，除非任意对象可以作为索引值传递。例如：

user["foobar"]

相当于Java代码：

user.get("foobar");

对于使用字符串作为key的Map，你可以使用另一种特殊语法：

user.foobar

...允许你将Map本身视为虚拟对象。

5.4 Strings as Arrays

为了使用属性索引（以及迭代），所有字符串都被视为数组。在MVEL中，你可以访问String变量中的第一个字符：

foo = "My String";
foo[0]; // returns 'M';

6. 常量

常量用于表示特定脚本源中的固定值

6.1 字符串常量

字符串常量可以用单引号或双引号表示。
"This is a string literal"
'This is also string literal'

6.2 字符串转义序列

\\ 双重转义允许在字符串中出现单个反斜杠。
\n 新行
\r 回车
\u#### Unicode字符（示例：\ uAE00）
\### 八进制字符（示例：\ 73）

6.3 数值型字面值

整数可以十进制（10位），八进制（8位）或十六进制（16位）表示。

十进制整数可以表示为不以零开始的任何数字。
125 // 十进制
八进制表示为带有0前缀的数字，后跟数字范围从0到7。
0353 // 八进制
十六进制表示为带有0x前缀的数字，后跟数字范围为0-9..A-F。
0xAFF0 // 十六进制

6.4 浮点型字面值

浮点数由整数部分和由点/周期字符表示的小数部分组成，并具有可选的类型后缀。

10.503 // a double
94.92d // a double
14.5f // a float

6.5 BigInteger和BigDecimal字面值

你可以使用后缀B和I来表示BigInteger和BigDecimal字面值（大写字母是必填字段）。

104.39484B // BigDecimal
8.4I // BigInteger

6.6 Boolean 字面值

布尔字面值由保留关键字true 和 false 表示。

6.7 Null 字面值

Null字面值由保留的关键字 null 或 nil 表示。

7. 类型常量

类型文字与Java中的类似，具有以下格式：

．

所以一个类可能是被限定为如下：

java.util.HashMap

或者如果类是通过内联或外部配置引入的，那么可以使用其非限定名称引用它：HashMap

7.1 嵌套类

MVEL 2.0中的标准点符号.（如Java中）无法访问嵌套类。相反，你必须使用符号限定这些类。

org.proctor.Person$BodyPart

8. 程序判断/遍历

8.1 If-Then-Else

MVEL提供了完整的C/Java式的if-then-else块，如：

if (var > 0) {
   System.out.println("Greater than zero!");
}
else if (var == -1) { 
   System.out.println("Minus one!");
}
else { 
   System.out.println("Something else!");
}

Example:

    public static void main(String[] args) {
        String expression = "if (param > 0) {return \"Greater than zero!\"; } " +
                "else if (param == -1) { return \"Minus one!\"; } " +
                "else { return \"Something else!\"; }";

        Map paramMap = new HashMap<>();
        paramMap.put("param", 2);

        Object object = MVEL.eval(expression, paramMap);
        System.out.println(object); // Greater than zero!
    }

8.2 三元声明

就像Java一样,支持三元声明语句

num > 0 ? "Yes" : "No";

可嵌套三元语句：

num > 0 ? "Yes" : (num == -1 ? "Minus One!" : "No")

Example:

    public static void main(String[] args) {
        String expression = "num > 0  ? \"Yes\" : \"No\";";

        Map paramMap = new HashMap();
        paramMap.put("num", new Integer(1));

        Object object = MVEL.eval(expression, paramMap);
        System.out.println(object); // Yes
    }

8.3 Foreach

MVEL中最强大的功能之一就是foreach操作。它与Java 1.5中的foreach运算符的语法和功能类似。它接受由冒号分隔的两个参数，第一个是当前元素的局部变量，第二个是要迭代的集合或数组。

count = 0;
foreach (name : people) {
   count++;
   System.out.println("Person #" + count + ":" + name);
}
     
System.out.println("Total people: " + count);

由于MVEL将字符串视为可迭代对象，你可以使用foreach块来迭代字符串（逐字符）：

str = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
 
foreach (el : str) {
   System.out.print("["+ el + "]");
}

上面输出为:

[A][B][C][D][E][F][G][H][I][J][K][L][M][N][O][P][Q][R][S][T][U][V][W][X][Y][Z]

你还可以使用MVEL计数到一个整数值（从1）：

foreach (x : 9) {
   System.out.print(x);
}

上面输出为:

123456789

语法注意
从MVEL 2.0开始，可以通过使用for关键字简单地简化foreach，就像在Java 5.0中一样。例如：

for (item : collection) { ... }

8.4 For 循环

MVEL 2.0实现标准C for循环：

for (int i =0; i < 100; i++) {
   System.out.println(i);
}

8.5 Do While, Do Until

在MVEL中实现了do while和do until，遵循与Java相同的约定，带有until的与while相反。

do {
   x = something();
} while (x != null);

...在语义上相当于...

do {
  x = something();
} until (x == null);

8.6 While, Until

MVEL 2.0实现标准的while，以及相反的until。

while (isTrue()) {
   doSomething();
}

或者

until (isFalse()) {
  doSomething();
}

9. 投影与折叠

简单地说，投影是表示集合的一种方式。可以使用非常简单的语法，检查集合中非常复杂的对象模型。

想像你有一个User对象的集合。这些对象中的每一个都有一个Parent。现在，你想要在用户层次结构中获取父目录的所有名称（假设Parent类有一个name字段），你将会写下如下内容：
parentNames = (parent.name in users);
甚至可以执行嵌套操作。想象一下，User对象有一个名为familyMembers的成员集合，我们想要一个所有家庭成员名称的列表：
familyMembers = (name in (familyMembers in users));

10. 变量赋值

MVEL允许你可以在表达式中赋值变量，运行时可以提取使用，或在表达式中直接使用。
由于MVEL是一种动态类型的语言，你不需要指定一个类型来声明一个新的变量。但是，你可以选择这样做。

str = "My String"; // valid
String str = "My String"; // valid
然而，与Java不同，MVEL在为类型变量赋值时提供了自动类型转换（如果可能的话）。例如：
String num = 1;
assert num instanceof String && num == "1";

对于动态类型变量，如果你只想执行类型转换，你可以简单地将该值转换为所需的类型：
num = (String) 1;
assert num instanceof String && num == "1";

11. 方法定义

MVEL允许使用def或function关键字定义native函数。
函数按声明的顺序定义，不能前言引用。唯一的例外是在函数本身中，可以直接引用另一个函数。

11.1 简单示例

定义一个简单的函数:

def hello() { System.out.println("Hello!"); }

这定义了一个名为“hello”的简单函数，它不接受任何参数。调用该函数时打印Hello！到控制台。 MVEL定义的函数像任何常规方法调用一样工作。

    public static void main(String[] args) {
        String expression = "def hello() { return \"Hello!\"; } hello();";

        Map paramMap = new HashMap();

        Object object = MVEL.eval(expression, paramMap);
        System.out.println(object); // Hello!
    }

11.2 接受参数并返回值

函数可以被声明为接受参数，并且可以返回单个值。如下示例：

def addTwo(a, b) {
   a + b;
}

该函数将接受两个参数（a和b），然后将两个变量相加。由于MVEL使用最终值退出原则，所以返回最终结果值。因此，你可以使用以下功能：
val = addTwo(5, 2);
assert val == 10;
return 关键字也可用于强制从函数的内部程序流程中返回值。

Example:

    public static void main(String[] args) {
        String expression = "def addTwo(num1, num2) { num1 + num2; } val = addTwo(a, b);";

        Map paramMap = new HashMap();
        paramMap.put("a", 2);
        paramMap.put("b", 4);

        Object object = MVEL.eval(expression, paramMap);
        System.out.println(object); // 6
    }

11.3 Closures

MVEL允许Closures。但是，该功能不能与本地Java方法互操作。

// define a function that accepts a parameter   
def someFunction(f_ptr) { f_ptr(); }
 
// define a var
var a = 10;
 
// pass the function a closure
someFunction(def { a * 10 });

参考资料：
https://www.itdaan.com/blog/2011/06/14/15c2d18f615914b8cc3dd66374e8f5b1.html

MVEL2.0表达式使用指南

思维导图

简介

1. 基本语法

1.1 简单属性表达式

1.2 布尔表达式

1.3 复合语句表达式

1.4 返回值

2. 操作符

2.1 一元操作符

2.2 比较运算符

2.3 逻辑运算符

2.4 按位运算符

2.5 数学运算符

2.6 其它运算符：

3. Value 校验

3.1 Empty

3.2 Null

3.3 强制类型转换

4. 集合List, Maps, 数组

4.1 Lists

4.2 Maps

4.3 数组

4.4 Array 强制类型转换

5. 属性

5.1 Bean Properties

5.2 Null-Safe Bean Navigation

5.3 Collections

5.3.1 List

5.3.2 Map

5.4 Strings as Arrays

6. 常量

6.1 字符串常量

6.2 字符串转义序列

6.3 数值型字面值

6.4 浮点型字面值

6.5 BigInteger和BigDecimal字面值

6.6 Boolean 字面值

6.7 Null 字面值

7. 类型常量

7.1 嵌套类

8. 程序判断/遍历

8.1 If-Then-Else

8.2 三元声明

8.3 Foreach

8.4 For 循环

8.5 Do While, Do Until

8.6 While, Until

9. 投影与折叠

10. 变量赋值

11. 方法定义

11.1 简单示例

11.2 接受参数并返回值

11.3 Closures

你可能感兴趣的:(MVEL2.0表达式使用指南)