Go 环境变量日志打印输出

怼烎@ 2023-10-10 21:14 12阅读 0赞

#### 阅读目录 ####

*  使用 With 方法添加了两个额外字段

package main
    
    import (
    	"fmt"
    	"log"
    	"os"
    	"strconv"
    	"sync"
    
    	"github.com/rs/zerolog"
    )
    
    /*
    Logger is the global logger.
    创建了一个具有预定义配置的 zerolog.Logger 实例。
    
    1 zerolog.New(os.Stderr) 创建了一个新的 zerolog.Logger 实例，
    并指定了日志消息的输出目标。
    在这里，使用的是 os.Stderr，表示标准错误输出。
    
    2 .With() 创建一个新的带有额外上下文的日志记录器。
    这允许您为每个日志条目添加字段或上下文信息。
    然而，在提供的代码片段中，并没有添加额外的字段或上下文。
    
    3 .Timestamp() 在每个日志条目中添加一个时间戳字段。
    该字段包含生成日志消息时的当前时间戳。
    
    4 .Logger() 返回配置好的 zerolog.Logger 实例。
    */
    var Logger = zerolog.New(os.Stderr).With().Timestamp().Logger()
    
    func Info() *zerolog.Event {
        
    	return Logger.Info()
    }
    func Debug() *zerolog.Event {
        
    	return Logger.Debug()
    }
    
    // 使用了一个互斥锁 mu 来保证在并发访问时的安全性。
    var (
    	/*
    		互斥锁类型，用于在多个 goroutine 之间提供互斥访问。
    		mu 用作互斥锁的实例。
    	*/
    	mu  sync.Mutex
    	set = map[string]string{
        } // 存储设置的环境变量键值对
    	// 创建一个空的 map，其中键是字符串类型，值是布尔指针类型 *bool。
    	regBool = map[string]*bool{
        } // 存储注册的布尔值变量指针
    )
    
    func main() {
        
    	err := os.Setenv("MY_ENV_VAR", "false")
    	if err != nil {
        
    		fmt.Println("Failed to set environment variable:", err)
    		return
    	}
    
    	// 通过调用返回的函数获取该变量的值，并打印结果。
    	var featureEnableSSH = RegisterBool("MY_ENV_VAR")
    	// 调用注册的布尔值变量函数并打印结果
    	// fmt.Println(featureEnableSSH())
    
    	zerolog.TimeFieldFormat = "2006-01-02 3:04:05"
    	if featureEnableSSH() {
        
    		Logger.Info().Msg("SSH ACLs")
    	} else if regBool["MY_ENV_VAR"] != nil && len(os.Getenv("MY_ENV_VAR")) > 0 {
        
    		Logger.Debug().Msg("SSH ACLs debug")
    	}
    
    }
    
    // 用于注册布尔值变量，并返回一个函数用于获取该变量的值。
    func RegisterBool(envVar string) func() bool {
        
    	mu.Lock()         // 锁定互斥锁
    	defer mu.Unlock() // 解锁互斥锁
    	// mu 用作互斥锁的实例。通过在需要保护临界区的代码块中使用
    
    	p, ok := regBool[envVar]
    	// fmt.Println(p, ok)<nil> false
    	if !ok {
        
    		var b bool
    		p = &b
    		/*
    		   设置布尔值变量的初始值 ,os.Getenv 获取环境变量
    		   // fmt.Println(os.Getenv("GOPATH"))C:\Users\ASUS\go
    		*/
    		setBoolLocked(p, envVar, os.Getenv(envVar))
    		regBool[envVar] = p
    	}
    	return func() bool {
        
    		// 返回布尔值变量的值
    		return *p
    	}
    }
    
    /*
    用于设置布尔值变量的值，
    并在解析失败时终止程序并打印错误信息。
    */
    func setBoolLocked(p *bool, envVar, val string) {
        
    	// 记录环境变量的键值对
    	noteEnvLocked(envVar, val)
    	if val == "" {
        
    		*p = false
    		return
    	}
    	var err error
    	/*
    	   解析环境变量的值为布尔值
    	   将字符串表示的布尔值转换为对应的布尔类型。
    	   它接受一个字符串参数，表示要解析的布尔值字符串，
    	   并返回解析结果和可能的错误。
    	   b1, err := strconv.ParseBool("true")
    	*/
    	*p, err = strconv.ParseBool(val)
    	if err != nil {
        
    		// 解析失败时打印错误信息并终止程序
    		log.Fatalf("invalid boolean environment variable %s value %q", envVar, val)
    	}
    }
    
    // 用于记录设置的环境变量键值对
    func noteEnvLocked(k, v string) {
        
    	if v != "" {
        
    		set[k] = v
    	} else {
        
    		delete(set, k)
    	}
    }

PS D:\TEXT\go_test> go run .\main.go
    {"level":"debug","time":"2023-05-24 12:26:07","message":"SSH ACLs debug"}
    PS D:\TEXT\go_test>

## 使用 With 方法添加了两个额外字段 ##

使用 With 方法添加了两个额外字段：  
一个字符串类型的字段 “user”，值为 “John”，  
以及一个整数类型的字段 “age”，值为 30。

在调用 Info 方法时，这些额外字段将包含在日志条目中，并与日志消息一起输出。  
在上述示例中，日志消息为 “This is an info log message with additional fields”。  
通过添加适当的字段和值，您可以根据需要定制日志条目的上下文信息。

package main
    
    import (
    	"os"
    
    	"github.com/rs/zerolog"
    )
    
    func main() {
        
    	logger := zerolog.New(os.Stderr).With().
    		Timestamp().
    		Str("user", "John").
    		Int("age", 30).
    		Logger()
    
    	logger.Info().Msg("This is an info log message with additional fields")
    }

PS D:\TEXT\go_test> go run .\main.go
    {
      "level": "info",
      "user": "John",
      "age": 30,
      "time": "2023-05-24T00:28:03+08:00",
      "message": "This is an info log message with additional fields"
    }
    PS D:\TEXT\go_test>