13.4 日志和配置设计

    配置模块对于应用部署牵涉到服务器不同的一些配置信息非常有用,例如一些数据库配置信息、监听端口、监听地址等都是可以通过配置文件来配置,这样我们的应用程序就具有很强的灵活性,可以通过配置文件的配置部署在不同的机器上,可以连接不同的数据库之类的。

    beego的日志设计部署思路来自于seelog,根据不同的level来记录日志,但是beego设计的日志系统比较轻量级,采用了系统的log.Logger接口,默认输出到os.Stdout,用户可以实现这个接口然后通过beego.SetLogger设置自定义的输出,详细的实现如下所示:

    上面这一段实现了日志系统的日志分级,默认的级别是Trace,用户通过SetLevel可以设置不同的分级。

    1. // logger references the used application logger.
    2. var BeeLogger = log.New(os.Stdout, "", log.Ldate|log.Ltime)
    3. // SetLogger sets a new logger.
    4. func SetLogger(l *log.Logger) {
    5. BeeLogger = l
    6. }
    7. // Trace logs a message at trace level.
    8. func Trace(v ...interface{}) {
    9. if level <= LevelTrace {
    10. BeeLogger.Printf("[T] %v\n", v)
    11. }
    12. }
    13. // Debug logs a message at debug level.
    14. func Debug(v ...interface{}) {
    15. if level <= LevelDebug {
    16. BeeLogger.Printf("[D] %v\n", v)
    17. }
    18. }
    19. // Info logs a message at info level.
    20. func Info(v ...interface{}) {
    21. if level <= LevelInfo {
    22. BeeLogger.Printf("[I] %v\n", v)
    23. }
    24. // Warning logs a message at warning level.
    25. if level <= LevelWarning {
    26. BeeLogger.Printf("[W] %v\n", v)
    27. }
    28. }
    29. // Error logs a message at error level.
    30. func Error(v ...interface{}) {
    31. if level <= LevelError {
    32. BeeLogger.Printf("[E] %v\n", v)
    33. }
    34. }
    35. // Critical logs a message at critical level.
    36. func Critical(v ...interface{}) {
    37. if level <= LevelCritical {
    38. BeeLogger.Printf("[C] %v\n", v)
    39. }
    40. }
    • Trace(一般的记录信息,举例如下:)
      • “Entered parse function validation block”
      • “Validation: entered second ‘if’”
      • “Dictionary ‘Dict’ is empty. Using default value”
    • Debug(调试信息,举例如下:)
      • “Web page requested: http://somesite.com Params=’…’”
      • “Response generated. Response size: 10000. Sending.”
      • “New file received. Type:PNG Size:20000”
    • Info(打印信息,举例如下:)
      • “Web server restarted”
      • “Hourly statistics: Requested pages: 12345 Errors: 123 …”
      • “Service paused. Waiting for ‘resume’ call”
    • Warn(警告信息,举例如下:)
      • “Cache corrupted for file=’test.file’. Reading from back-end”
      • “Database 192.168.0.7/DB not responding. Using backup 192.168.0.8/DB”
      • “No response from statistics server. Statistics not sent”
    • Error(错误信息,举例如下:)
      • “Internal error. Cannot process request #12345 Error:….”
    • Critical(致命错误,举例如下:)
      • “Critical panic received: …. Shutting down”
      • “Fatal error: … App is shutting down to prevent data corruption or loss”

    可以看到每个函数里面都有对level的判断,所以如果我们在部署的时候设置了level=LevelWarning,那么Trace、Debug、Info这三个函数都不会有任何的输出,以此类推。

    配置信息的解析,beego实现了一个key=value的配置文件读取,类似ini配置文件的格式,就是一个文件解析的过程,然后把解析的数据保存到map中,最后在调用的时候通过几个string、int之类的函数调用返回相应的值,具体的实现请看下面:

    首先定义了一些ini配置文件的一些全局性常量 :

    1. // A Config represents the configuration.
    2. type Config struct {
    3. filename string
    4. comment map[int][]string // id: []{comment, key...}; id 1 is for main comment.
    5. data map[string]string // key: value
    6. sync.RWMutex
    7. }

    定义了解析文件的函数,解析文件的过程是打开文件,然后一行一行的读取,解析注释、空行和key=value数据:

    下面实现了一些读取配置文件的函数,返回的值确定为bool、int、float64或string:

    1. // Bool returns the boolean value for a given key.
    2. func (c *Config) Bool(key string) (bool, error) {
    3. return strconv.ParseBool(c.data[key])
    4. }
    5. // Int returns the integer value for a given key.
    6. func (c *Config) Int(key string) (int, error) {
    7. return strconv.Atoi(c.data[key])
    8. }
    9. // Float returns the float value for a given key.
    10. func (c *Config) Float(key string) (float64, error) {
    11. return strconv.ParseFloat(c.data[key], 64)
    12. }
    13. // String returns the string value for a given key.
    14. func (c *Config) String(key string) string {
    15. return c.data[key]
    16. }

    下面这个函数是我一个应用中的例子,用来获取远程url地址的json数据,实现如下:

    1. appname = hs
    2. url ="http://www.api.com/api.html"
    • 上一章: