语法

gengine语法

gengine DSL语法

const rule = `
rule "rulename" "rule-describtion" salience  10
begin

//规则体

end`

如上,gengine DSL完整的语法块由如下几个组件构成:

• 关键字rule,之后紧跟"规则名称"和"规则描述",规则名称是必须的,但规则描述不是必须的. 当一个gengine实例中有多个规则时,"规则名"必须唯一,否则当有多个相同规则名的规则时,编译好之后只会存在一个
• 关键字salience,之后紧跟一个整数,表示的规则优先级,它们为非必须.数字越大,规则优先级越高;当用户没有显式的指明优先级时,规则的优先级未知, 如果多个规则的优先级相同，那么在执行的时候，相同优先级的规则执行顺序未知
• 关键字begin和end包裹的是规则体,也就是规则的具体逻辑

规则体语法

• 规则体的语法支持或执行顺序,与主流的计算计语言(如golang、java、C/C++等)一致

规则体支持的运算:

• 支持完整数值之间的加(+)、减(-)、乘(*)、除(/)四则运算,以及字符串之间的加法
• 完整的逻辑运算(&&、 ||、 !)
• 支持比较运算符: 等于(==)、不等于(!=)、大于(>)、小于(<)、大于等于(>=)、小于等于(<=)
• 支持+=, -=, *=, /=
• 支持小括号
• 优先级:括号, 非, 乘除, 加减, 逻辑运算(&&,||) 依次降低

规则体支持的基础数据类型

• string
• bool
• int, int8, int16, int32, int64
• uint, uint8, uint16,uint32, uint64
• float32, float64

不支持的特例

• 不支持直接处理nil,但用户可以在rule中定义一个变量去接受nil,然后再定义一个函数去处理nil
• 为了用户使用方便,最新版gengine已经内置了isNil()函数,用户可以直接使用,用于判断数据是否为nil

规则体支持的语法

• 完整的if .. else if .. else 语法结构,及其嵌套结构

const rule_else_if_test =`
rule "elseif_test" "test"
begin

a = 8
if a < 1 {
	println("a < 1")
} else          if a >= 1 && a <6 {
	println("a >= 1 && a <6")
} else if a >= 6 && a < 7 {
	println("a >= 6 && a < 7")
} else if a >= 7 && a < 10 {
	println("a >=7 && a < 10")
} else        {
	println("a > 10")
}
end`

• conc{} 并发语句块

const rule_conc_statement  = `
rule "conc_test" "test" 
begin
	conc  { 
		a = 3.0
		b = 4
		c = 6.8
		d = "hello world"
        e = "you will be happy here!"
	}
	println(a, b, c, d, e)
end`

@name语法

• 在规则体中使用@name,指代的是当前规则名,@name在规则执行时,会被解析为规则名字符串(规则内的名字感知)
• 测试:https://github.com/bilibili/gengine/blob/main/test/at_name_test.go

@id语法

• 在规则体中使用@id含义是,如果当前的规则名是可以转化为整数的字符串,则@id就是规则名的整数值,如果规则名字符串不可转化为整数，则@id的值为0.这个是为了方便用户以规则名作为整型参数
• 测试: https://github.com/bilibili/gengine/blob/main/test/at_id_test.go

@desc语法

• 在规则体内获知当前规则的描述信息,类型为字符串
• 测试:https://github.com/bilibili/gengine/blob/main/test/at_desc_test.go

@sal

• 在规则体内获知当前规则的优先级信息，类型为int64
• 测试：https://github.com/bilibili/gengine/blob/main/test/at_salience_test.go

注释

• 支持规则内的单行注释,注释以双斜杠(//)开头

自定义变量

• 用户自定义变量无需申明类型
• 规则内定义的变量,只对当前规则可见,对其他规则不可见(局部变量)
• 使用dataContext注入的(变量)数据,对加载到gengine中的所有规则均可见(全局变量)

报错时行号提示

• gengine支持的语法,是完整的DSL语法(也可以当作是一门完整的语言),gengine规则执行出错时,gengine会指出具体的出错在哪一行.尽量帮助用户在使用gengine的每一个流程细节上,都有丝滑体验
• 测试可见这里:https://github.com/bilibili/gengine/blob/main/test/line_number/line_number_test.go

多级调用支持

• 现在已经支持了A.B.C形式的三级调用,但三级以上的调用则不支持
• 其他细节说明:

1.当语法是C,或者a=C, 则C可以为具体值、变量、函数或方法、结构体(指针)、map、slice、array等, 具体的如 a=100, a = Mp["hello"], a = x, a = getMessage(p1,p2..)等  
2.当语法是A.C,或者a=A.C, 则A必须为结构体(指针), C同上, 具体如a = A.Mp["hello"], a = A.Field1, a = A.GetMessage(p1,p2..)等
3.当语法是A.B.C,或者a=A.B.C, 则A和B必须为结构体(指针),C同上, 具体如 a = A.B.Mp["hello"], a =A.B.Field1, a= A.B.GetMessage(p1, p2..)等

那么,如果语法为A.B.C时, A.Mp["hello"].C 这种语法是不合法的 

测试:https://github.com/bilibili/gengine/blob/main/test/three_level_call_test.go

其他语法

• 为了尽量保证规则的书写和golang语法的无关性,规则体内可以调用具有多返回的函数或方法,但当使用自定义变量接受函数、方法返回值时,只支持但返回一个返回数据的函数和方法调用(也是间接建议用户为自己的业务实现设置适当的默认值,而不是直接报错)