com.ql.util.express

Class ExpressRunner

java.lang.Object

com.ql.util.express.ExpressRunner

public class ExpressRunner
extends java.lang.Object

语法分析和计算的入口类

Author:

xuannan

Constructor Summary

Constructors

Constructor and Description
ExpressRunner()
ExpressRunner(boolean isPrecise, boolean isTrace)
ExpressRunner(boolean isPrecise, boolean isTrace, IExpressResourceLoader iExpressResourceLoader, NodeTypeManager nodeTypeManager)
ExpressRunner(boolean isPrecise, boolean isTrace, IExpressResourceLoader iExpressResourceLoader, NodeTypeManager nodeTypeManager, java.util.Map<java.lang.String,java.util.concurrent.Future<InstructionSet>> cacheMap)
ExpressRunner(boolean isPrecise, boolean isTrace, java.util.Map<java.lang.String,java.util.concurrent.Future<InstructionSet>> cacheMap)
ExpressRunner(boolean isPrecise, boolean isStrace, NodeTypeManager nodeTypeManager)

Method Summary

Modifier and Type	Method and Description
void	addClassField(java.lang.String field, java.lang.Class<?> bindingClass, java.lang.Class<?> returnType, Operator op) 添加类的方法
void	addClassField(java.lang.String field, java.lang.Class<?> bindingClass, Operator op) 添加类的方法
void	addClassMethod(java.lang.String name, java.lang.Class<?> bindingClass, OperatorBase op) 添加类的方法
void	addFunction(java.lang.String name, OperatorBase op) 添加函数定义
void	addFunctionAndClassMethod(java.lang.String name, java.lang.Class<?> bindingClass, OperatorBase op) 添加函数定义扩展类的方法
void	addFunctionOfClassMethod(java.lang.String name, java.lang.Class<?> clazz, java.lang.String functionName, java.lang.Class<?>[] parameterClassTypes, java.lang.String errorInfo) 添加一个类的函数定义，例如：Math.abs(double) 映射为表达式中的 "取绝对值(-5.0)"
void	addFunctionOfClassMethod(java.lang.String name, java.lang.String className, java.lang.String functionName, java.lang.Class<?>[] parameterClassTypes, java.lang.String errorInfo) 添加一个类的函数定义，例如：Math.abs(double) 映射为表达式中的 "取绝对值(-5.0)"
void	addFunctionOfClassMethod(java.lang.String name, java.lang.String className, java.lang.String functionName, java.lang.Class<?>[] parameterClassTypes, java.lang.String[] parameterDesc, java.lang.String[] parameterAnnotation, java.lang.String errorInfo) 添加一个类的函数定义，例如：Math.abs(double) 映射为表达式中的 "取绝对值(-5.0)"
void	addFunctionOfClassMethod(java.lang.String name, java.lang.String className, java.lang.String functionName, java.lang.String[] parameterTypes, java.lang.String errorInfo) 添加一个类的函数定义，例如：Math.abs(double) 映射为表达式中的 "取绝对值(-5.0)"
void	addFunctionOfClassMethod(java.lang.String name, java.lang.String className, java.lang.String functionName, java.lang.String[] parameterTypes, java.lang.String[] parameterDesc, java.lang.String[] parameterAnnotation, java.lang.String errorInfo) 添加一个类的函数定义，例如：Math.abs(double) 映射为表达式中的 "取绝对值(-5.0)"
void	addFunctionOfServiceMethod(java.lang.String name, java.lang.Object serviceObject, java.lang.String functionName, java.lang.Class<?>[] parameterClassTypes, java.lang.String errorInfo) 用于将一个用户自己定义的对象(例如Spring对象)方法转换为一个表达式计算的函数
void	addFunctionOfServiceMethod(java.lang.String name, java.lang.Object serviceObject, java.lang.String functionName, java.lang.Class<?>[] parameterClassTypes, java.lang.String[] parameterDesc, java.lang.String[] parameterAnnotation, java.lang.String errorInfo) 用于将一个用户自己定义的对象(例如Spring对象)方法转换为一个表达式计算的函数
void	addFunctionOfServiceMethod(java.lang.String name, java.lang.Object serviceObject, java.lang.String functionName, java.lang.String[] parameterTypes, java.lang.String errorInfo) 用于将一个用户自己定义的对象(例如Spring对象)方法转换为一个表达式计算的函数
void	addFunctionOfServiceMethod(java.lang.String name, java.lang.Object serviceObject, java.lang.String functionName, java.lang.String[] parameterTypes, java.lang.String[] parameterDesc, java.lang.String[] parameterAnnotation, java.lang.String errorInfo)
void	addMacro(java.lang.String macroName, java.lang.String express) 添加宏定义 例如： macro 宏名称 { abc(userInfo.userId);}
void	addOperator(java.lang.String name, Operator operator) 添加操作符号，此操作符号的优先级与 "*"相同，语法形式也是 data name data
void	addOperator(java.lang.String name, java.lang.String refOperatorName, Operator operator) 添加操作符号，此操作符号与给定的参照操作符号在优先级别和语法形式上一致
void	addOperatorWithAlias(java.lang.String keyWordName, java.lang.String realKeyWordName, java.lang.String errorInfo) 添加操作符和关键字的别名，同时对操作符可以指定错误信息。 例如：addOperatorWithAlias("加","+",null)
void	addSystemFunctions()
boolean	checkSyntax(java.lang.String text) 提供简答的语法检查，保证可以在运行期本地环境编译成指令
boolean	checkSyntax(java.lang.String text, boolean mockRemoteJavaClass, java.util.List<java.lang.String> remoteJavaClassNames) 提供复杂的语法检查，(比如检查自定义的java类)，不保证运行期在本地环境可以编译成指令
void	clearExpressCache() 清除缓存
void	createInstructionSet(ExpressNode root, InstructionSet result)
InstructionSet	createInstructionSet(ExpressNode root, java.lang.String type)
boolean	createInstructionSetPrivate(InstructionSet result, java.util.Stack<ForRelBreakContinue> forStack, ExpressNode node, boolean isRoot)
java.lang.Object	execute(InstructionSet instructionSet, IExpressContext<java.lang.String,java.lang.Object> context, java.util.List<java.lang.String> errorList, boolean isTrace, boolean isCatchException) 执行指令集
java.lang.Object	execute(java.lang.String expressString, IExpressContext<java.lang.String,java.lang.Object> context, java.util.List<java.lang.String> errorList, boolean isCache, boolean isTrace) 执行一段文本
java.lang.Object	execute(java.lang.String expressString, IExpressContext<java.lang.String,java.lang.Object> context, java.util.List<java.lang.String> errorList, boolean isCache, boolean isTrace, long timeoutMillis) 执行一段文本
java.lang.Object	executeByExpressName(java.lang.String name, IExpressContext<java.lang.String,java.lang.Object> context, java.util.List<java.lang.String> errorList, boolean isTrace, boolean isCatchException) 根据表达式的名称进行执行
AppendingClassFieldManager	getAppendingClassFieldManager()
AppendingClassMethodManager	getAppendingClassMethodManager()
ExportItem[]	getExportInfo() 输出全局定义信息
IExpressResourceLoader	getExpressResourceLoader()
OperatorBase	getFunction(java.lang.String name) 获取函数定义，通过函数定义可以拿到参数的说明信息
InstructionSet	getInstructionSetFromLocalCache(java.lang.String expressString) 优先从本地指令集缓存获取指令集，没有的话生成并且缓存在本地
NodeTypeManager	getNodeTypeManager() 获取语法定义的管理器
IOperateDataCache	getOperateDataCache()
OperatorFactory	getOperatorFactory() 获取操作符号管理器
java.lang.String[]	getOutFunctionNames(java.lang.String express)
java.lang.String[]	getOutVarNames(java.lang.String express) 获取一个表达式需要的外部变量名称列表
ExpressPackage	getRootExpressPackage()
boolean	isIgnoreConstChar() 是否忽略charset类型的数据，而识别为string，比如'a' -》 "a" 默认为不忽略，正常识别为String
boolean	isShortCircuit()
void	loadExpress(java.lang.String expressName) 装载文件中定义的Express
void	loadMultiExpress(java.lang.String expressName, java.lang.String express) 装载表达式，但不执行，例如一些宏定义，或者自定义函数
InstructionSet	parseInstructionSet(java.lang.String text) 解析一段文本，生成指令集合
OperatorBase	replaceOperator(java.lang.String name, OperatorBase op) 替换操作符处理
void	setIgnoreConstChar(boolean ignoreConstChar)
void	setShortCircuit(boolean isShortCircuit)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExpressRunner

public ExpressRunner()

ExpressRunner

public ExpressRunner(boolean isPrecise,
                     boolean isTrace)

Parameters:

isPrecise - 是否需要高精度计算支持

isTrace - 是否跟踪执行指令的过程

ExpressRunner

public ExpressRunner(boolean isPrecise,
                     boolean isTrace,
                     java.util.Map<java.lang.String,java.util.concurrent.Future<InstructionSet>> cacheMap)

Parameters:

isPrecise -

isTrace -

cacheMap - user can define safe and efficient cache or use default concurrentMap

ExpressRunner

public ExpressRunner(boolean isPrecise,
                     boolean isStrace,
                     NodeTypeManager nodeTypeManager)

ExpressRunner

public ExpressRunner(boolean isPrecise,
                     boolean isTrace,
                     IExpressResourceLoader iExpressResourceLoader,
                     NodeTypeManager nodeTypeManager)

Parameters:

isPrecise - 是否需要高精度计算支持

isTrace - 是否跟踪执行指令的过程

iExpressResourceLoader - 表达式的资源装载器

ExpressRunner

public ExpressRunner(boolean isPrecise,
                     boolean isTrace,
                     IExpressResourceLoader iExpressResourceLoader,
                     NodeTypeManager nodeTypeManager,
                     java.util.Map<java.lang.String,java.util.concurrent.Future<InstructionSet>> cacheMap)

Parameters:

isPrecise - 是否需要高精度计算支持

isTrace - 是否跟踪执行指令的过程

iExpressResourceLoader - 表达式的资源装载器

cacheMap - 指令集缓存, 必须是线程安全的集合

Method Detail

getAppendingClassMethodManager

public AppendingClassMethodManager getAppendingClassMethodManager()

getAppendingClassFieldManager

public AppendingClassFieldManager getAppendingClassFieldManager()

getOperateDataCache

public IOperateDataCache getOperateDataCache()

addSystemFunctions

public void addSystemFunctions()

getNodeTypeManager

public NodeTypeManager getNodeTypeManager()

获取语法定义的管理器

Returns:

getOperatorFactory

public OperatorFactory getOperatorFactory()

获取操作符号管理器

Returns:

getExpressResourceLoader

public IExpressResourceLoader getExpressResourceLoader()

addMacro

public void addMacro(java.lang.String macroName,
                     java.lang.String express)
              throws java.lang.Exception

添加宏定义 例如： macro 宏名称 { abc(userInfo.userId);}

Parameters:

macroName - 宏名称

express - 表达式，示例：abc(userInfo.userId);

Throws:

java.lang.Exception

loadMultiExpress

public void loadMultiExpress(java.lang.String expressName,
                             java.lang.String express)
                      throws java.lang.Exception

装载表达式，但不执行，例如一些宏定义，或者自定义函数

Parameters:

expressName -

express -

Throws:

java.lang.Exception

loadExpress

public void loadExpress(java.lang.String expressName)
                 throws java.lang.Exception

装载文件中定义的Express

Parameters:

expressName -

Throws:

java.lang.Exception

addFunction

public void addFunction(java.lang.String name,
                        OperatorBase op)

添加函数定义

Parameters:

name - 函数名称

op - 对应的操作实现类

addFunctionAndClassMethod

public void addFunctionAndClassMethod(java.lang.String name,
                                      java.lang.Class<?> bindingClass,
                                      OperatorBase op)

添加函数定义扩展类的方法

Parameters:

name -

bindingClass -

op -

addClassField

public void addClassField(java.lang.String field,
                          java.lang.Class<?> bindingClass,
                          Operator op)

添加类的方法

Parameters:

field -

bindingClass -

op -

addClassField

public void addClassField(java.lang.String field,
                          java.lang.Class<?> bindingClass,
                          java.lang.Class<?> returnType,
                          Operator op)

添加类的方法

Parameters:

field -

bindingClass -

returnType -

op -

addClassMethod

public void addClassMethod(java.lang.String name,
                           java.lang.Class<?> bindingClass,
                           OperatorBase op)

添加类的方法

Parameters:

name -

bindingClass -

op -

getFunction

public OperatorBase getFunction(java.lang.String name)

获取函数定义，通过函数定义可以拿到参数的说明信息

Parameters:

name - 函数名称

Returns:

addFunctionOfClassMethod

public void addFunctionOfClassMethod(java.lang.String name,
                                     java.lang.String className,
                                     java.lang.String functionName,
                                     java.lang.Class<?>[] parameterClassTypes,
                                     java.lang.String errorInfo)
                              throws java.lang.Exception

添加一个类的函数定义，例如：Math.abs(double) 映射为表达式中的 "取绝对值(-5.0)"

Parameters:

name - 函数名称

className - 类名称

functionName - 类中的方法名称

parameterClassTypes - 方法的参数类型名称

errorInfo - 如果函数执行的结果是false，需要输出的错误信息

Throws:

java.lang.Exception

addFunctionOfClassMethod

public void addFunctionOfClassMethod(java.lang.String name,
                                     java.lang.Class<?> clazz,
                                     java.lang.String functionName,
                                     java.lang.Class<?>[] parameterClassTypes,
                                     java.lang.String errorInfo)
                              throws java.lang.Exception

添加一个类的函数定义，例如：Math.abs(double) 映射为表达式中的 "取绝对值(-5.0)"

Parameters:

name - 函数名称

clazz - 类

functionName - 类中的方法名称

parameterClassTypes - 方法的参数类型名称

errorInfo - 如果函数执行的结果是false，需要输出的错误信息

Throws:

java.lang.Exception

addFunctionOfClassMethod

public void addFunctionOfClassMethod(java.lang.String name,
                                     java.lang.String className,
                                     java.lang.String functionName,
                                     java.lang.Class<?>[] parameterClassTypes,
                                     java.lang.String[] parameterDesc,
                                     java.lang.String[] parameterAnnotation,
                                     java.lang.String errorInfo)
                              throws java.lang.Exception

添加一个类的函数定义，例如：Math.abs(double) 映射为表达式中的 "取绝对值(-5.0)"

Parameters:

name - 函数名称

className - 类名称

functionName - 类中的方法名称

parameterClassTypes - 方法的参数类型名称

parameterDesc - 方法的参数说明

parameterAnnotation - 方法的参数注解

errorInfo - 如果函数执行的结果是false，需要输出的错误信息

Throws:

java.lang.Exception

addFunctionOfClassMethod

public void addFunctionOfClassMethod(java.lang.String name,
                                     java.lang.String className,
                                     java.lang.String functionName,
                                     java.lang.String[] parameterTypes,
                                     java.lang.String errorInfo)
                              throws java.lang.Exception

添加一个类的函数定义，例如：Math.abs(double) 映射为表达式中的 "取绝对值(-5.0)"

Parameters:

name - 函数名称

className - 类名称

functionName - 类中的方法名称

parameterTypes - 方法的参数类型名称

errorInfo - 如果函数执行的结果是false，需要输出的错误信息

Throws:

java.lang.Exception

addFunctionOfClassMethod

public void addFunctionOfClassMethod(java.lang.String name,
                                     java.lang.String className,
                                     java.lang.String functionName,
                                     java.lang.String[] parameterTypes,
                                     java.lang.String[] parameterDesc,
                                     java.lang.String[] parameterAnnotation,
                                     java.lang.String errorInfo)
                              throws java.lang.Exception

添加一个类的函数定义，例如：Math.abs(double) 映射为表达式中的 "取绝对值(-5.0)"

Parameters:

name - 函数名称

className - 类名称

functionName - 类中的方法名称

parameterTypes - 方法的参数类型名称

parameterDesc - 方法的参数说明

parameterAnnotation - 方法的参数注解

errorInfo - 如果函数执行的结果是false，需要输出的错误信息

Throws:

java.lang.Exception

addFunctionOfServiceMethod

public void addFunctionOfServiceMethod(java.lang.String name,
                                       java.lang.Object serviceObject,
                                       java.lang.String functionName,
                                       java.lang.Class<?>[] parameterClassTypes,
                                       java.lang.String errorInfo)
                                throws java.lang.Exception

用于将一个用户自己定义的对象(例如Spring对象)方法转换为一个表达式计算的函数

Parameters:

name -

serviceObject -

functionName -

parameterClassTypes -

errorInfo -

Throws:

java.lang.Exception

addFunctionOfServiceMethod

public void addFunctionOfServiceMethod(java.lang.String name,
                                       java.lang.Object serviceObject,
                                       java.lang.String functionName,
                                       java.lang.Class<?>[] parameterClassTypes,
                                       java.lang.String[] parameterDesc,
                                       java.lang.String[] parameterAnnotation,
                                       java.lang.String errorInfo)
                                throws java.lang.Exception

用于将一个用户自己定义的对象(例如Spring对象)方法转换为一个表达式计算的函数

Parameters:

name -

serviceObject -

functionName -

parameterClassTypes -

parameterDesc - 方法的参数说明

parameterAnnotation - 方法的参数注解

errorInfo -

Throws:

java.lang.Exception

addFunctionOfServiceMethod

public void addFunctionOfServiceMethod(java.lang.String name,
                                       java.lang.Object serviceObject,
                                       java.lang.String functionName,
                                       java.lang.String[] parameterTypes,
                                       java.lang.String errorInfo)
                                throws java.lang.Exception

用于将一个用户自己定义的对象(例如Spring对象)方法转换为一个表达式计算的函数

Parameters:

name -

serviceObject -

functionName -

parameterTypes -

errorInfo -

Throws:

java.lang.Exception

addFunctionOfServiceMethod

public void addFunctionOfServiceMethod(java.lang.String name,
                                       java.lang.Object serviceObject,
                                       java.lang.String functionName,
                                       java.lang.String[] parameterTypes,
                                       java.lang.String[] parameterDesc,
                                       java.lang.String[] parameterAnnotation,
                                       java.lang.String errorInfo)
                                throws java.lang.Exception

Throws:

java.lang.Exception

addOperator

public void addOperator(java.lang.String name,
                        Operator operator)
                 throws java.lang.Exception

添加操作符号，此操作符号的优先级与 "*"相同，语法形式也是 data name data

Parameters:

name -

operator -

Throws:

java.lang.Exception

addOperator

public void addOperator(java.lang.String name,
                        java.lang.String refOperatorName,
                        Operator operator)
                 throws java.lang.Exception

添加操作符号，此操作符号与给定的参照操作符号在优先级别和语法形式上一致

Parameters:

name - 操作符号名称

refOperatorName - 参照的操作符号，例如 "+","--"等

operator -

Throws:

java.lang.Exception

addOperatorWithAlias

public void addOperatorWithAlias(java.lang.String keyWordName,
                                 java.lang.String realKeyWordName,
                                 java.lang.String errorInfo)
                          throws java.lang.Exception

添加操作符和关键字的别名，同时对操作符可以指定错误信息。 例如：addOperatorWithAlias("加","+",null)

Parameters:

keyWordName -

realKeyWordName -

errorInfo -

Throws:

java.lang.Exception

replaceOperator

public OperatorBase replaceOperator(java.lang.String name,
                                    OperatorBase op)

替换操作符处理

Parameters:

name -

getRootExpressPackage

public ExpressPackage getRootExpressPackage()

clearExpressCache

public void clearExpressCache()

清除缓存

executeByExpressName

public java.lang.Object executeByExpressName(java.lang.String name,
                                             IExpressContext<java.lang.String,java.lang.Object> context,
                                             java.util.List<java.lang.String> errorList,
                                             boolean isTrace,
                                             boolean isCatchException)
                                      throws java.lang.Exception

根据表达式的名称进行执行

Parameters:

name -

context -

errorList -

isTrace -

isCatchException -

Returns:

Throws:

java.lang.Exception

execute

public java.lang.Object execute(InstructionSet instructionSet,
                                IExpressContext<java.lang.String,java.lang.Object> context,
                                java.util.List<java.lang.String> errorList,
                                boolean isTrace,
                                boolean isCatchException)
                         throws java.lang.Exception

执行指令集

Parameters:

instructionSet -

context -

errorList -

isTrace -

isCatchException -

Returns:

Throws:

java.lang.Exception

execute

public java.lang.Object execute(java.lang.String expressString,
                                IExpressContext<java.lang.String,java.lang.Object> context,
                                java.util.List<java.lang.String> errorList,
                                boolean isCache,
                                boolean isTrace,
                                long timeoutMillis)
                         throws java.lang.Exception

执行一段文本

Parameters:

expressString - 程序文本

context - 执行上下文

errorList - 输出的错误信息List

isCache - 是否使用Cache中的指令集

isTrace - 是否输出详细的执行指令信息

timeoutMillis - 超时毫秒时间, -1 表示不给本次执行单独设置超时时间, 但是可能会有全局超时时间, 参考 QLExpressTimer.setTimeout(long)

Returns:

Throws:

java.lang.Exception

execute

public java.lang.Object execute(java.lang.String expressString,
                                IExpressContext<java.lang.String,java.lang.Object> context,
                                java.util.List<java.lang.String> errorList,
                                boolean isCache,
                                boolean isTrace)
                         throws java.lang.Exception

执行一段文本

Parameters:

expressString - 程序文本

context - 执行上下文

errorList - 输出的错误信息List

isCache - 是否使用Cache中的指令集

isTrace - 是否输出详细的执行指令信息

Returns:

Throws:

java.lang.Exception

parseInstructionSet

public InstructionSet parseInstructionSet(java.lang.String text)
                                   throws java.lang.Exception

解析一段文本，生成指令集合

Parameters:

text -

Returns:

Throws:

java.lang.Exception

getExportInfo

public ExportItem[] getExportInfo()

输出全局定义信息

Returns:

getInstructionSetFromLocalCache

public InstructionSet getInstructionSetFromLocalCache(java.lang.String expressString)
                                               throws java.lang.Exception

优先从本地指令集缓存获取指令集，没有的话生成并且缓存在本地

Parameters:

expressString -

Returns:

Throws:

java.lang.Exception

createInstructionSet

public InstructionSet createInstructionSet(ExpressNode root,
                                           java.lang.String type)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

createInstructionSet

public void createInstructionSet(ExpressNode root,
                                 InstructionSet result)
                          throws java.lang.Exception

Throws:

java.lang.Exception

createInstructionSetPrivate

public boolean createInstructionSetPrivate(InstructionSet result,
                                           java.util.Stack<ForRelBreakContinue> forStack,
                                           ExpressNode node,
                                           boolean isRoot)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getOutVarNames

public java.lang.String[] getOutVarNames(java.lang.String express)
                                  throws java.lang.Exception

获取一个表达式需要的外部变量名称列表

Parameters:

express -

Returns:

Throws:

java.lang.Exception

getOutFunctionNames

public java.lang.String[] getOutFunctionNames(java.lang.String express)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

isShortCircuit

public boolean isShortCircuit()

setShortCircuit

public void setShortCircuit(boolean isShortCircuit)

isIgnoreConstChar

public boolean isIgnoreConstChar()

是否忽略charset类型的数据，而识别为string，比如'a' -》 "a" 默认为不忽略，正常识别为String

setIgnoreConstChar

public void setIgnoreConstChar(boolean ignoreConstChar)

checkSyntax

public boolean checkSyntax(java.lang.String text)

提供简答的语法检查，保证可以在运行期本地环境编译成指令

Parameters:

text -

Returns:

checkSyntax

public boolean checkSyntax(java.lang.String text,
                           boolean mockRemoteJavaClass,
                           java.util.List<java.lang.String> remoteJavaClassNames)

提供复杂的语法检查，(比如检查自定义的java类)，不保证运行期在本地环境可以编译成指令

Parameters:

text -

mockRemoteJavaClass -

remoteJavaClassNames -

Returns: