日志与错误处理

日志

Casbin 可以记录请求、model 加载和 policy 变更。日志默认关闭。 可以通过 Enforcer.EnableLog() 或 NewEnforcer() 的 logger 参数开启。示例输出：

2017/07/15 19:43:56 [Request: alice, data1, read ---> true]

备注

Go： 你可以接入自定义的 logger；Casbin 通过它记录 model、请求、角色和 policy。

备注

Python： PyCasbin 使用标准的 logging 模块。按常规方式配置你应用的日志即可；PyCasbin 使用 logging.getLogger()。可选的 logging_config 在 pycasbin/util/log.py 中有文档说明。配置方法参见 Python logging 和 Django logging。

为不同的 Enforcer 配置独立的 Logger

每个 enforcer 可以有自己的 logger，并且可以在运行时更换。

你可以在 NewEnforcer() 的最后一个参数中指定 logger。使用这种方式时，logger 的 enabled 字段优先于 enforcer 的 enabled 参数。

// Set a default logger as enforcer e1's logger.
// This operation can also be seen as changing the logger of e1 at runtime.
e1.SetLogger(&Log.DefaultLogger{})

// Set another logger as enforcer e2's logger.
e2.SetLogger(&YouOwnLogger)

// Set your logger when initializing enforcer e3.
e3, _ := casbin.NewEnforcer("examples/rbac_model.conf", a, logger)

支持的 Logger

Casbin 提供了多种 logger 实现：

Logger	Author	Description
Default logger (built-in)	Casbin	使用 Go 标准 log 包的默认 logger。
Zap logger	Casbin	使用 zap 输出 JSON 编码的日志，并可通过 zap-logger 提供更多自定义选项。

Logger	Author	Description
psr3-bridge logger	Casbin	提供符合 PSR-3 的桥接器。

实现自定义 Logger

自定义 logger 必须实现 Logger 接口。

Method	Type	Description
EnableLog()	mandatory	控制是否打印消息。
IsEnabled()	mandatory	返回当前 logger 的启用状态。
LogModel()	mandatory	记录 model 相关信息。
LogEnforce()	mandatory	记录授权执行相关信息。
LogRole()	mandatory	记录角色相关信息。
LogPolicy()	mandatory	记录 policy 相关信息。

把你的自定义 logger 传给 Enforcer.SetLogger()。

下面是一个 Go 的自定义 logger 实现示例：

import (
    "fmt"
    "log"
    "strings"
)

// DefaultLogger is the implementation for a Logger using golang log.
type DefaultLogger struct {
    enabled bool
}

func (l *DefaultLogger) EnableLog(enable bool) {
    l.enabled = enable
}

func (l *DefaultLogger) IsEnabled() bool {
    return l.enabled
}

func (l *DefaultLogger) LogModel(model [][]string) {
    if !l.enabled {
        return
    }
    var str strings.Builder
    str.WriteString("Model: ")
    for _, v := range model {
        str.WriteString(fmt.Sprintf("%v\n", v))
    }

    log.Println(str.String())
}

func (l *DefaultLogger) LogEnforce(matcher string, request []interface{}, result bool, explains [][]string) {
    if !l.enabled {
        return
    }

    var reqStr strings.Builder
    reqStr.WriteString("Request: ")
    for i, rval := range request {
        if i != len(request)-1 {
            reqStr.WriteString(fmt.Sprintf("%v, ", rval))
        } else {
            reqStr.WriteString(fmt.Sprintf("%v", rval))
        }
    }
    reqStr.WriteString(fmt.Sprintf(" ---> %t\n", result))

    reqStr.WriteString("Hit Policy: ")
    for i, pval := range explains {
        if i != len(explains)-1 {
            reqStr.WriteString(fmt.Sprintf("%v, ", pval))
        } else {
            reqStr.WriteString(fmt.Sprintf("%v \n", pval))
        }
    }

    log.Println(reqStr.String())
}

func (l *DefaultLogger) LogPolicy(policy map[string][][]string) {
    if !l.enabled {
        return
    }

    var str strings.Builder
    str.WriteString("Policy: ")
    for k, v := range policy {
        str.WriteString(fmt.Sprintf("%s : %v\n", k, v))
    }

    log.Println(str.String())
}

func (l *DefaultLogger) LogRole(roles []string) {
    if !l.enabled {
        return
    }

    log.Println("Roles: ", roles)
}

错误处理

Casbin 中可能因为以下若干原因产生错误或 panic：

1. model 文件（.conf）中存在非法语法
2. policy 文件（.csv）中存在非法语法
3. 存储 adapter 抛出的自定义错误（例如 MySQL 连接失败）
4. Casbin 自身的 bug

以下五个主要函数可能产生错误或 panic：

Function	Behavior on Error
NewEnforcer()	返回错误
LoadModel()	返回错误
LoadPolicy()	返回错误
SavePolicy()	返回错误
Enforce()	返回错误

备注

NewEnforcer() 内部会同时调用 LoadModel() 和 LoadPolicy()，所以使用 NewEnforcer() 时无需再单独调用它们。

启用与禁用授权执行

你可以使用 Enforcer.EnableEnforce() 禁用 enforcer。禁用后，Enforcer.Enforce() 总是返回 true。其他操作（例如 policy 管理）不受影响。示例：

e := casbin.NewEnforcer("examples/basic_model.conf", "examples/basic_policy.csv")

// Will return false.
// By default, the enforcer is enabled.
e.Enforce("non-authorized-user", "data1", "read")

// Disable the enforcer at runtime.
e.EnableEnforce(false)

// Will return true for any request.
e.Enforce("non-authorized-user", "data1", "read")

// Enable the enforcer again.
e.EnableEnforce(true)

// Will return false.
e.Enforce("non-authorized-user", "data1", "read")