MVEL2.0快速上手
一、学习背景
在目前的工作中,我们组内部分业务需要通过mvel2.0脚本来实现部分流程引擎服务节点的逻辑动态化,比如加工字段、转换字段、添加额外字段等基本操作,从而可以实现业务改动的快速支持,避免了频繁上线的困扰!
二、MVEL2.0是什么?作用是啥?
MVEL 是一种基于 Java 语法的表达式语言,相比最初的OGNL、JEXL和JUEL等项目,而它具有远超它们的性能、功能和易用性,特别是集成方面。
简单说是一种简单表达式解析器。我们可以自己写一些表达式,交给MVEL进行解析计算,得到这个表达式计算的值。(注意重点:简单!!只能支持简单运算逻辑,如果特别复杂的逻辑则不建议使用了)
常见的表达式引擎还有:Drools、Aviator
三、如何集成到Java项目中?
1、引入依赖
<dependency>
<groupId>org.mvel</groupId>
<artifactId>mvel2</artifactId>
<version>2.4.14.Final</version>
</dependency>
2、了解基础语法
本文主要用于实践,所以基础语法不过多篇幅!
MVEL2.0脚本语言学习手册【官网】 http://mvel.documentnode.com/
MVEL的Github地址 https://github.com/mvel/mvel
或者谷歌其他博主的MVEL2.0基础语法总结
3、上手验证
3.1验证所需依赖
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.mvel</groupId>
<artifactId>mvel2</artifactId>
<version>2.4.4.Final</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>2.0.31</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-collections4</artifactId>
<version>4.4</version>
</dependency>
3.2验证代码
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import org.junit.Test;
import org.mvel2.MVEL;
import com.alibaba.fastjson.JSONObject;
import lombok.Builder;
import lombok.Data;
public class MvelTest {
@Test
public void mvelScriptTest() {
//数据准备
HashMap<String, Object> tabParamMap = getTabParamMap();
User user = User.builder().userId(4).codeId(5).codeName("6").build();
//创建一个上下文,用于存放变量
HashMap<String, Object> mvelParam = new HashMap<>();
mvelParam.put("tabParamMap", JSONObject.parseObject(JSONObject.toJSONString(tabParamMap), HashMap.class));
mvelParam.put("user", JSONObject.parseObject(JSONObject.toJSONString(user), HashMap.class));
mvelParam.put("codeNum", "code200");
//预编译
Serializable compliedScript = MVEL.compileExpression(getCompiledScript());
//执行
HashMap retMap = (HashMap) MVEL.executeExpression(compliedScript, mvelParam);
//输出
System.out.println(JSONObject.toJSONString(retMap));
}
private static String getCompiledScript(){return"import java.lang.*;import java.util.*;import org.apache.commons.collections4.CollectionUtils;def filterSomeCondition(user,conditionList){boolean allConditionsMet=true;('userId='+user.userId);System.out.println('codeId='+user.codeId);System.out.println('codeName='+user.codeName);for(condition:conditionList){if(condition.userIdList!=null&&!condition.userIdList.isEmpty()&&!condition.userIdList.contains(user.userId)){allConditionsMet=false;}if(condition.codeIdList!=null&&!condition.codeIdList.isEmpty()&&!condition.codeIdList.contains(user.codeId)){allConditionsMet=false;}if(condition.codeNameList!=null&&!condition.codeNameList.isEmpty()&&!condition.codeNameList.contains(user.codeName)){allConditionsMet=false;}System.out.println('每轮最后allConditionsMet='+allConditionsMet);if(allConditionsMet)return true;allConditionsMet=true;}return false;}def getCodeName(codeNodeList){if(CollectionUtils.isEmpty(codeNodeList)){System.out.println('getCodeName=>0%'System.out.println);return'0%';}for(codeNode:codeNodeList){if(codeNode['conditions']!=null&&filterSomeCondition(user,codeNode['conditions'])){return codeNode['codeName'];}}return'0%';}HashMap codeNumMap=['code100':'100','code200':'200'];HashMap resultMap=new HashMap();String demoVar=tabParamMap.getOrDefault('demoVar','');resultMap.put('demoVar',demoVar);String demoVarUnknown=tabParamMap.getOrDefault('demoVarUnknown','测试未知');resultMap.put('demoVarUnknown',demoVarUnknown);String codeNumValue=codeNumMap[codeNum];ArrayList codeNodeList=tabParamMap[codeNumValue];ArrayList codeNodeValidList=new ArrayList();for(codeNode:codeNodeList){if(codeNode['valid']!=null&&codeNode['valid']==true)codeNodeValidList.add(codeNode);}String codeName=getCodeName(codeNodeValidList);resultMap.put('codeName',codeName);['resultMap':resultMap];";}
private HashMap<String, Object> getTabParamMap() {
HashMap<String, Object> tabParamMap = new HashMap<>();
List<CodeNode> code100 = new ArrayList<>();
code100.add(CodeNode.builder()
.code(100)
.codeName("100%")
.valid(true)
.conditions(Arrays.asList(SomeCondition
.builder()
.userIdList(Arrays.asList(1, 2, 3))
.codeIdList(Arrays.asList(1, 2, 3))
.codeNameList(Arrays.asList("1", "2", "3"))
.build()))
.build());
tabParamMap.put("100", code100);
List<CodeNode> code200 = new ArrayList<>();
code200.add(CodeNode.builder()
.code(200)
.codeName("200%")
.valid(true)
.conditions(Arrays.asList(
SomeCondition
.builder()
.userIdList(Arrays.asList(4, 5, 6))
.codeIdList(Arrays.asList(4, 5, 6))
.codeNameList(Arrays.asList("4", "5", "6"))
.build(),
SomeCondition
.builder()
.userIdList(Arrays.asList(7, 8, 9))
.codeIdList(Arrays.asList(7, 8, 9))
.codeNameList(Arrays.asList("7", "8", "9"))
.build()))
.build());
tabParamMap.put("200", code200);
tabParamMap.put("demoVar", "测试demoVar");
return tabParamMap;
}
}
@Data
@Builder
class User {
private int userId;
private int codeId;
private String codeName;
}
@Data
@Builder
class CodeNode {
//code码
private int code;
//codeName
private String codeName;
//是否有效
private boolean valid;
//生效条件
private List<SomeCondition> conditions;
}
@Data
@Builder
class SomeCondition {
//用户ID
private List<Integer> userIdList = Collections.emptyList();
//codeID
private List<Integer> codeIdList = Collections.emptyList();
//Code名称
private List<String> codeNameList = Collections.emptyList();
}
3.3 MVEL表达式片段
import java.lang.*;
import java.util.*;
import org.apache.commons.collections4.CollectionUtils;
//全局变量为传入的tabParamMap、user、codeNum
//函数1 过滤 conditionList中任意某个condition全部条件都满足则返回true
//注意:mvel不支持break和continue
def filterSomeCondition(user, conditionList) {
boolean allConditionsMet = true;
System.out.println("userId="+user.?userId);
System.out.println("codeId="+user.?codeId);
System.out.println("codeName="+user.?codeName);
for (condition : conditionList) {
if (condition.?userIdList != null && !condition.userIdList.isEmpty() && !condition.userIdList.contains(user.userId)) {
allConditionsMet = false;
}
if (condition.?codeIdList != null && !condition.codeIdList.isEmpty() && !condition.codeIdList.contains(user.codeId)) {
allConditionsMet = false;
}
if (condition.?codeNameList != null && !condition.codeNameList.isEmpty() && !condition.codeNameList.contains(user.codeName)) {
allConditionsMet = false;
}
System.out.println("每轮最后allConditionsMet="+allConditionsMet);
if(allConditionsMet){
return true;
}
allConditionsMet = true;
}
return false;
}
//函数:通过codeNodeList逐个条件判断
def getCodeName(codeNodeList){
if(CollectionUtils.isEmpty(codeNodeList)){
System.out.println("getCodeName=>0%");
return "0%";
}
for(codeNode : codeNodeList){
if(codeNode["conditions"] != null && filterSomeCondition(user, codeNode["conditions"])){
return codeNode["codeName"];
}
}
return "0%";
}
//定义局部变量 根据传入的codeNum获取具体的code值
HashMap codeNumMap = [
"code100" : "100",
"code200" : "200"
];
//定义返回变量
HashMap resultMap = new HashMap();
String demoVar = tabParamMap.getOrDefault("demoVar", "");
resultMap.put("demoVar", demoVar);
String demoVarUnknown = tabParamMap.getOrDefault("demoVarUnknown", "测试未知");
resultMap.put("demoVarUnknown",demoVarUnknown);
//codeNumMap[codeNum] 得到 "100"
//tabParamMap[codeNumMap[codeNum]] 得到对应的List<CodeNode> (最好分开写)
String codeNumValue = codeNumMap[codeNum];
ArrayList codeNodeList = tabParamMap[codeNumValue];
//定义有效的List
ArrayList codeNodeValidList = new ArrayList();
//codeNode属于对象 不能使用codeNode["isValid"]形式调用
for (codeNode : codeNodeList) {
if(codeNode["valid"] != null && codeNode["valid"] == true){
codeNodeValidList.add(codeNode);
}
}
//获取对应的codeName
String codeName = getCodeName(codeNodeValidList);
resultMap.put("codeName",codeName);
return ["resultMap": resultMap];
3.4 验证结果输出
代码的主要目的是为了匹配输出相应的codeName,“100%” or “200%” or “0%”
codeId=5
codeName=6
每轮最后allConditionsMet=true
{"resultMap":{"demoVar":"测试demoVar","codeName":"200%","demoVarUnknown":"测试未知"}}
4、踩坑记录🛑
-
特别的不好调试,一般只能打印输出调试。✅
-
MVEL语法中for循环里面不支持break、continue。✅
-
在MVEL(Model-Velocity Expression Language)中,虽然语法和结构可能看起来与Java等编程语言相似,但实际上MVEL有其自身的规则和限制。在MVEL中,你确实不能像在Java中那样直接在循环体内声明变量,尤其是局部变量。在MVEL中,你可以在循环之外定义变量,然后在循环内部更新这些变量的值。✅例如:
boolean allConditionsMet = true; for (condition : conditions) { //boolean allConditionsMet = true; //[这里会报错] if (!(condition.met)) { allConditionsMet = false; } }
-
MVEL主要设计用于表达式求值和简单的条件判断,而不是完整的程序控制流。
-
传进来的parameters最好都是HashMap对象,省事儿。✅
传入对象,总是报错!!!建议传入对象的话都深拷贝转化成HashMap![Error: could not access field: com.*.*.*.runner.CodeNode.valid] [Near : {... if(codeNode.?valid != null && cod ....}]
-
有些简单的工具类可以直接import进来,然后使用。✅
-
Mvel语法每行以 ; 结尾,有时候莫名的报错的话 看看是否少 ; 。✅