Functions
匹配器中的函数
Enhance matcher capabilities by incorporating functions. Use built-in functions or define custom ones. Built-in key-matching functions follow this signature:
bool function_name(string url, string pattern)
These functions return booleans indicating whether url matches pattern.
Available built-in functions:
Key-getting functions generally accept three parameters (except keyGet):
bool function_name(string url, string pattern, string key_name)
These return the key_name value when matching the pattern, otherwise returning "".
Examples: KeyGet2("/resource1/action", "/:res/action", "res") returns "resource1", while KeyGet3("/resource1_admin/action", "/{res}_admin/*", "res") returns "resource1".
For KeyGet with two parameters: KeyGet("/resource1/action", "/*") returns "resource1/action".
| 函数 | url | 模式 | key_name | 例子 |
|---|---|---|---|---|
| keyGet | 像/proj/resource1这样的URL路径 | 像/proj/*这样的URL路径或*模式 | \ | keyget_model.conf/keymatch_policy.csv |
| keyGet2 | 像/proj/resource1这样的URL路径 | 像/prooj/:resource这样的URL路径或:模式 | 在模式中指定的键名 | keyget2_model.conf/keymatch2_policy.csv |
| keyGet3 | 像/proj/res3_admin/这样的URL路径 | 像/proj/{resource}_admin/*这样的URL路径或{}模式 | 在模式中指定的键名 | https://github.com/casbin/casbin/blob/7bd496f94f5a2739a392d333a9aaaa10ae397673/util/builtin_operators_test.go#L209-L247 |
Complete function details: https://github.com/casbin/casbin/blob/master/util/builtin_operators_test.go
如何添加自定义函数
Start by creating your function, accepting multiple parameters and returning a bool:
func KeyMatch(key1 string, key2 string) bool {
i := strings.Index(key2, "*")
if i == -1 {
return key1 == key2
}
if len(key1) > i {
return key1[:i] == key2[:i]
}
return key1 == key2[:i]
}
Next, create an interface{} wrapper:
func KeyMatchFunc(args ...interface{}) (interface{}, error) {
name1 := args[0].(string)
name2 := args[1].(string)
return (bool)(KeyMatch(name1, name2)), nil
}
Register the function with the Casbin enforcer:
e.AddFunction("my_func", KeyMatchFunc)
Use the function in your model CONF:
[matchers]
m = r.sub == p.sub && my_func(r.obj, p.obj) && r.act == p.act