Functions

匹配器中的函数

你甚至可以在匹配器中指定函数，使其更强大。 你可以使用内置函数或指定你自己的函数。 内置的键匹配函数采用以下格式：

bool function_name(string url, string pattern)

它们返回一个布尔值，表示url是否匹配pattern。

支持的内置函数有：

函数	url	模式	例子
keyMatch	像/alice_data/resource1这样的URL路径	像/alice_data/*这样的URL路径或*模式	keymatch_model.conf/keymatch_policy.csv
keyMatch2	像/alice_data/resource1这样的URL路径	像/alice_data/:resource这样的URL路径或:模式	keymatch2_model.conf/keymatch2_policy.csv
keyMatch3	像/alice_data/resource1这样的URL路径	像/alice_data/{resource}这样的URL路径或{}模式	https://github.com/casbin/casbin/blob/277c1a2b85698272f764d71a94d2595a8d425915/util/builtin_operators_test.go#L171-L196
keyMatch4	像/alice_data/123/book/123这样的URL路径	像/alice_data/{id}/book/{id}这样的URL路径或{}模式	https://github.com/casbin/casbin/blob/277c1a2b85698272f764d71a94d2595a8d425915/util/builtin_operators_test.go#L208-L222
keyMatch5	像/alice_data/123/?status=1这样的URL路径	像/alice_data/{id}/*这样的URL路径，{}或*模式	https://github.com/casbin/casbin/blob/1cde2646d10ad1190c0d784c3a1c0e1ace1b5bc9/util/builtin_operators_test.go#L485-L526
regexMatch	任何字符串	一个正则表达式模式	keymatch_model.conf/keymatch_policy.csv
ipMatch	像192.168.2.123这样的IP地址	像192.168.2.0/24这样的IP地址或CIDR	ipmatch_model.conf/ipmatch_policy.csv
globMatch	像/alice_data/resource1这样的路径样式路径	像/alice_data/*这样的glob模式	https://github.com/casbin/casbin/blob/277c1a2b85698272f764d71a94d2595a8d425915/util/builtin_operators_test.go#L426-L466

对于获取键的函数，它们通常接受三个参数（除了keyGet）：

bool function_name(string url, string pattern, string key_name)

如果键key_name匹配模式，它们将返回键的值，如果没有匹配项，将返回""。

例如，KeyGet2("/resource1/action", "/:res/action", "res")将返回"resource1"，KeyGet3("/resource1_admin/action", "/{res}_admin/*", "res")将返回"resource1"。 至于KeyGet，它接受两个参数，KeyGet("/resource1/action", "/*)将返回"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

查看上述函数的详细信息：https://github.com/casbin/casbin/blob/master/util/builtin_operators_test.go

如何添加自定义函数

首先，准备你的函数。 它接受几个参数并返回一个布尔值：

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]
}

然后，用interface{}类型包装它：

func KeyMatchFunc(args ...interface{}) (interface{}, error) {
    name1 := args[0].(string)
    name2 := args[1].(string)

    return (bool)(KeyMatch(name1, name2)), nil
}

最后，将函数注册到Casbin执行器：

e.AddFunction("my_func", KeyMatchFunc)

现在，你可以在你的模型CONF中像这样使用函数：

[matchers]
m = r.sub == p.sub && my_func(r.obj, p.obj) && r.act == p.act