【golang程序包推荐&分享】go-ini、viper、godoc

雨点打透心脏的1/2处 2022-12-16 11:58 163阅读 0赞

### 【golang程序包推荐&分享】go-ini、viper、godoc ###

*  一、go-ini
 *   *  1.程序包简介
     *  2.下载安装
     *  3.简单使用【截取自官网】
 *  二、viper
 *   *  1.程序包简介
     *  2.下载安装
     *  3.简单使用
 *  三、godoc
 *   *  1.程序包简介
     *  2.下载安装
     *  3.简单使用

# 一、go-ini #

## 1.程序包简介 ##

ini 是常用的配置文件格式，而go-ini是 Go 语言中用于操作 ini 文件的第三方库。

## 2.下载安装 ##

最低要求安装 Go 语言版本为 1.6。

$ go get gopkg.in/ini.v1

## 3.简单使用【截取自官网】 ##

首先，我们需要在任意目录创建两个文件（my.ini 和 main.go），在这里我们选择 /tmp/ini 目录。

$ mkdir -p /tmp/ini
    $ cd /tmp/ini
    $ touch my.ini main.go
    $ tree .
    .
    ├── main.go
    └── my.ini
    
    0 directories, 2 files

现在，我们编辑 my.ini 文件并输入以下内容

# possible values : production, development
    app_mode = development
    
    [paths]
    # Path to where grafana can store temp files, sessions, and the sqlite3 db (if that is used)
    data = /home/git/grafana
    
    [server]
    # Protocol (http or https)
    protocol = http
    
    # The http port  to use
    http_port = 9999
    
    # Redirect to correct domain if host header does not match domain
    # Prevents DNS rebinding attacks
    enforce_domain = true

很好，接下来我们需要编写 main.go 文件来操作刚才创建的配置文件。

package main
    
    import (
        "fmt"
        "os"
    
        "gopkg.in/ini.v1"
    )
    
    func main() {
        cfg, err := ini.Load("my.ini")
        if err != nil {
            fmt.Printf("Fail to read file: %v", err)
            os.Exit(1)
        }
    
        // 典型读取操作，默认分区可以使用空字符串表示
        fmt.Println("App Mode:", cfg.Section("").Key("app_mode").String())
        fmt.Println("Data Path:", cfg.Section("paths").Key("data").String())
    
        // 我们可以做一些候选值限制的操作
        fmt.Println("Server Protocol:",
            cfg.Section("server").Key("protocol").In("http", []string{"http", "https"}))
        // 如果读取的值不在候选列表内，则会回退使用提供的默认值
        fmt.Println("Email Protocol:",
            cfg.Section("server").Key("protocol").In("smtp", []string{"imap", "smtp"}))
    
        // 试一试自动类型转换
        fmt.Printf("Port Number: (%[1]T) %[1]d\n", cfg.Section("server").Key("http_port").MustInt(9999))
        fmt.Printf("Enforce Domain: (%[1]T) %[1]v\n", cfg.Section("server").Key("enforce_domain").MustBool(false))
        
        // 差不多了，修改某个值然后进行保存
        cfg.Section("").Key("app_mode").SetValue("production")
        cfg.SaveTo("my.ini.local")
    }

运行程序，我们可以看下以下输出：

$ go run main.go
    App Mode: development
    Data Path: /home/git/grafana
    Server Protocol: http
    Email Protocol: smtp
    Port Number: (int) 9999
    Enforce Domain: (bool) true
    
    $ cat my.ini.local
    # possible values : production, development
    app_mode = production
    
    [paths]
    # Path to where grafana can store temp files, sessions, and the sqlite3 db (if that is used)
    data = /home/git/grafana
    ...

# 二、viper #

## 1.程序包简介 ##

viper 是一个配置解决方案，拥有丰富的特性：

> 支持 JSON/TOML/YAML/HCL/envfile/Java properties 等多种格式的配置文件；  
> 可以设置监听配置文件的修改，修改时自动加载新的配置；  
> 从环境变量、命令行选项和io.Reader中读取配置；  
> 从远程配置系统中读取和监听修改，如 etcd/Consul；  
> 代码逻辑中显示设置键值。  
>   
>   
>

## 2.下载安装 ##

$ go get github.com/spf13/viper

## 3.简单使用 ##

package main
    
    import (
        "fmt"
        "log"
    
        "github.com/spf13/viper"
    )
    
    func init() { 
        // viper.SetConfigName("config1") // 读取yaml配置文件
        viper.SetConfigName("config") // 读取json配置文件
        //viper.AddConfigPath("/etc/appname/") //设置配置文件的搜索目录
        //viper.AddConfigPath("$HOME/.appname") // 设置配置文件的搜索目录
        viper.AddConfigPath(".")      // 设置配置文件和可执行二进制文件在用一个目录
        if err := viper.ReadInConfig(); err != nil { 
            if _, ok := err.(viper.ConfigFileNotFoundError); ok { 
                // Config file not found; ignore error if desired
                log.Println("no such config file")
            } else { 
                // Config file was found but another error was produced
                log.Println("read config error")
            }
            log.Fatal(err) // 读取配置文件失败致命错误
        }
    }
    
    func main() { 
        fmt.Println("获取配置文件的port", viper.GetInt("port"))
        fmt.Println("获取配置文件的mysql.url", viper.GetString(`mysql.url`))
        fmt.Println("获取配置文件的mysql.username", viper.GetString(`mysql.username`))
        fmt.Println("获取配置文件的mysql.password", viper.GetString(`mysql.password`))
        fmt.Println("获取配置文件的redis", viper.GetStringSlice("redis"))
        fmt.Println("获取配置文件的smtp", viper.GetStringMap("smtp"))
    }

# 三、godoc #

## 1.程序包简介 ##

godoc是Go语言中一个可以自动生成 API 文档的第三方库。

## 2.下载安装 ##

$ git clone https://github.com/golang/tools $GOPATH/src/golang.org/x/tools
    $ go build golang.org/x/tools

## 3.简单使用 ##

以笔者开发的[simpleConfig\_v1程序包][simpleConfig_v1]为例，生成API文档如下。

将项目simpleConfig\_v1的simpleConfig\_v1.go文件的main函数注释掉，package改为package simpleConfig\_v1，然后执行如下指令:

go install
    go doc
    godoc -url="pkg/github.com/user/simpleConfig_v1" > API.html

便会在当前目录下生成API.html文件:  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjQ3OTA5Mg_size_16_color_FFFFFF_t_70_pic_center]

[simpleConfig_v1]: https://blog.csdn.net/weixin_42479092/article/details/109171361
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjQ3OTA5Mg_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/4a547da714d5405fa5b2a6bc30dbd8d1.png