天天看點

Go 處理yaml類型的配置檔案

先說一下,這裡用到了很多關于反射類型的功能,可能剛開始看代碼,如果對反射不熟悉的可能會不是非常清晰,但是同時也是為了更好的了解golang中的反射,同時如果後面想在代碼中可以直接從我的git位址get:

go get github.com/pythonsite/config_yaml

直接上代碼:

// 可以用于處理讀yaml格式的配置檔案,同時也可以用于了解golang中的反射
package config_yaml

import (
    "strings"
    "errors"
    "io/ioutil"
    "gopkg.in/yaml.v2"
    "reflect"
    "fmt"
    "strconv"
)

type ConfigEngine struct {
    data map[interface{}]interface{}
}


// 将ymal檔案中的内容進行加載
func (c *ConfigEngine) Load (path string) error {
    ext := c.guessFileType(path)
    if ext == "" {
        return errors.New("cant not load" + path + " config")
    }
    return c.loadFromYaml(path)
}

//判斷配置檔案名是否為yaml格式
func (c *ConfigEngine) guessFileType(path string) string {
    s := strings.Split(path,".")
    ext := s[len(s) - 1]
    switch ext {
    case "yaml","yml":
        return "yaml"
    }
    return ""
}

// 将配置yaml檔案中的進行加載
func (c *ConfigEngine) loadFromYaml(path string) error {
    yamlS,readErr := ioutil.ReadFile(path)
    if readErr != nil {
        return readErr
    }
    // yaml解析的時候c.data如果沒有被初始化,會自動為你做初始化
    err := yaml.Unmarshal(yamlS, &c.data)
    if err != nil {
        return errors.New("can not parse "+ path + " config" )
    }
    return nil
}

// 從配置檔案中擷取值
func (c *ConfigEngine) Get(name string) interface{}{
    path := strings.Split(name,".")
    data := c.data
    for key, value := range path {
        v, ok := data[value]
        if !ok {
            break
        }
        if (key + 1) == len(path) {
            return v
        }
        if reflect.TypeOf(v).String() == "map[interface {}]interface {}"{
            data = v.(map[interface {}]interface {})
        }
    }
    return nil
}

// 從配置檔案中擷取string類型的值
func (c *ConfigEngine) GetString(name string) string {
    value := c.Get(name)
    switch value:=value.(type){
    case string:
        return value
    case bool,float64,int:
        return fmt.Sprint(value)
    default:
        return ""
    }
}

// 從配置檔案中擷取int類型的值
func (c *ConfigEngine) GetInt(name string) int {
    value := c.Get(name)
    switch value := value.(type){
    case string:
        i,_:= strconv.Atoi(value)
        return i
    case int:
        return value
    case bool:
        if value{
            return 1
        }
        return 0
    case float64:
        return int(value)
    default:
        return 0
    }
}

// 從配置檔案中擷取bool類型的值
func (c *ConfigEngine) GetBool(name string) bool {
    value := c.Get(name)
    switch value := value.(type){
    case string:
        str,_:= strconv.ParseBool(value)
        return str
    case int:
        if value != 0 {
            return true
        }
        return false
    case bool:
        return value
    case float64:
        if value != 0.0 {
            return true
        }
        return false
    default:
        return false
    }
}

// 從配置檔案中擷取Float64類型的值
func (c *ConfigEngine) GetFloat64(name string) float64 {
    value := c.Get(name)
    switch value := value.(type){
    case string:
        str,_ := strconv.ParseFloat(value,64)
        return str
    case int:
        return float64(value)
    case bool:
        if value {
            return float64(1)
        }
        return float64(0)
    case float64:
        return value
    default:
        return float64(0)
    }
}

// 從配置檔案中擷取Struct類型的值,這裡的struct是你自己定義的根據配置檔案
func (c *ConfigEngine) GetStruct(name string,s interface{}) interface{}{
    d := c.Get(name)
    switch d.(type){
    case string:
        c.setField(s,name,d)
    case map[interface{}]interface{}:
        c.mapToStruct(d.(map[interface{}]interface{}), s)
    }
    return s
}

func (c *ConfigEngine) mapToStruct(m map[interface{}]interface{},s interface{}) interface{}{
    for key, value := range m {
        switch key.(type) {
        case string:
            c.setField(s,key.(string),value)
        }
    }
    return s
}

// 這部分代碼是重點,需要多看看
func (c *ConfigEngine) setField(obj interface{},name string,value interface{}) error {
    // reflect.Indirect 傳回value對應的值
    structValue := reflect.Indirect(reflect.ValueOf(obj))
    structFieldValue := structValue.FieldByName(name)

    // isValid 顯示的測試一個空指針
    if !structFieldValue.IsValid() {
        return fmt.Errorf("No such field: %s in obj",name)
    }

    // CanSet判斷值是否可以被更改
    if !structFieldValue.CanSet() {
        return fmt.Errorf("Cannot set %s field value", name)
    }

    // 擷取要更改值的類型
    structFieldType := structFieldValue.Type()
    val := reflect.ValueOf(value)

    if structFieldType.Kind() == reflect.Struct && val.Kind() == reflect.Map {
        vint := val.Interface()

        switch vint.(type) {
        case map[interface{}]interface{}:
            for key, value := range vint.(map[interface{}]interface{}) {
                c.setField(structFieldValue.Addr().Interface(), key.(string), value)
            }
        case map[string]interface{}:
            for key, value := range vint.(map[string]interface{}) {
                c.setField(structFieldValue.Addr().Interface(), key, value)
            }
        }

    } else {
        if structFieldType != val.Type() {
            return errors.New("Provided value type didn't match obj field type")
        }

        structFieldValue.Set(val)
    }

    return nil
}      

先寫一個對上面這個包的使用例子:

首先是yaml配置檔案的内容,這裡簡單寫了一些内容:

Site:
    HttpPort: 8080
    HttpsOn: false
    Domain: "pythonsite.com"
    HttpsPort: 443
Nginx:
    Port: 80
    LogPath:  "/opt/log/nginx.log"
    Path: "/opt/nginx/"
SiteName: "this is my web site"
SiteAddr: "BeiJing"      

測試程式的代碼為:

package main

import (
    "github.com/pythonsite/config_yaml"
    "fmt"

)

type SiteConfig struct {
    HttpPort    int
    HttpsOn     bool
    Domain      string
    HttpsPort   int
}

type NginxConfig struct {
    Port int
    LogPath string
    Path    string
}


func main() {
    c2 := config_yaml.ConfigEngine{}
    c2.Load("test.yaml")

    siteConf := SiteConfig{}
    res := c2.GetStruct("Site",&siteConf)
    fmt.Println(res)

    nginxConfig := NginxConfig{}
    res2 := c2.GetStruct("Nginx",&nginxConfig)
    fmt.Println(res2)

    siteName := c2.GetString("SiteName")
    siteAddr := c2.GetString("SiteAddr")
    fmt.Println(siteName,siteAddr)

}      

效果如下:

Go 處理yaml類型的配置檔案

感覺挺好用哈

補充一些知識點(參考go聖經)

接口值

接口值有兩個部分組成:具體的類型和該類型的值,而這兩個概念被稱為接口的動态類型和動态值

Go語言中,變量總是被初始化之後我們才能使用,即使接口類型也不例外

對于接口值的零值就是類型的值和值的内容都是nil

對于接口值我們是可以通過==nil 或者!=nil 的方法來判斷接口值是否為空

var w io.Writer

w = os.Stdout

當通過w = os.Stdout 進行指派的時候調用了一個具體類型到接口類型的隐式轉換,這和顯式的使用io.Writer(os.Stdout)是等價的。

當指派之後w 這個接口值的動态類型被設定為*os.Stdout指針的類型描述符,它的動态值是os.Stdout的拷貝

通常在編譯期,我們不知道接口值的動态類型是什麼,是以一個接口上的調用必須使用動态配置設定。因為

不是直接進行調用,是以編譯器必須把代碼生成在類型描述符的方法Write上,然後間接調用那個位址。

這個調用的接收者是一個接口動态值的拷貝,os.Stdout。效果和下面這個直接調用一樣:

os.Stdout.Write([]byte("hello")) 等價于 w.Write([]byte("hello"))

反射

函數 reflect.TypeOf 接受任意的 interface{} 類型, 并傳回對應動态類型的reflect.Type:

t := reflect.TypeOf(3)
fmt.Println(t.String())
fmt.Println(t)      

我們可以檢視一下reflect.TypeOf的詳細方法:

// TypeOf returns the reflection Type that represents the dynamic type of i.
// If i is a nil interface value, TypeOf returns nil.
func TypeOf(i interface{}) Type {
    eface := *(*emptyInterface)(unsafe.Pointer(&i))
    return toType(eface.typ)
}      

可以看到參數類型是一個interface{},就像上面在接口值中說的這裡會将這個具體的值即我們傳入的3進行一個隐式的轉換

會建立一個包含兩個資訊的接口值:3這個變量的動态類型,這裡是int; 3這個變量的動态值,這裡是3

reflect.ValueOf 接受任意的 interface{} 類型, 并傳回對應動态類型的reflect.Value. 和

reflect.TypeOf 類似, reflect.ValueOf 傳回的結果也是對于具體的類型, 但是 reflect.Value 也可

以持有一個接口值

v := reflect.ValueOf(3)
fmt.Println(v)
fmt.Println(v.String())

v2 := reflect.ValueOf("abc")
fmt.Println(v2)
fmt.Println(v2.String())      

這裡需要注意除非 Value 持有的是字元串, 否則 String 隻是傳回具體的類型.

Value 的 Type 方法将傳回具體類型所對應的 reflect.Type:

t = v.Type()
fmt.Println(t)
fmt.Println(t.String())      

當然我們也可以逆操作回去reflect.Value.Interface,然後通過斷言的方式實作

一個 reflect.Value 和 interface{} 都能儲存任意的值. 所不同的是, 一個空的接口隐藏了值對應的 表示方式和所有的公開的方法, 是以隻有我們知道具體的動态類型才能使用類型斷言來通路内部的值, 對于内部值并沒有特别可做的事情. 相比之下, 一個 Value 則有很多方法來檢查其内容, 無論它的具體類型是什麼

使用 reflect.Value 的 Kind

kinds類型卻是有限的: Bool, String 和 所有數字類型的基礎類型; Array 和 Struct 對應的聚合 類型; Chan, Func, Ptr, Slice, 和 Map 對應的引用類似; 接口類型; 還有表示空值的無效類型. (空 的 reflect.Value 對應 Invalid 無效類型.)

通過reflect.Value修改值

有一些reflect.Values是可取位址的;其它一些則不可以,例子如下:

package main

import (
    "reflect"
    "fmt"
)

func main() {
    x := 2
    a := reflect.ValueOf(2)
    b := reflect.ValueOf(x)
    c := reflect.ValueOf(&x)
    d := c.Elem()
    fmt.Println(a.CanAddr()) // false
    fmt.Println(b.CanAddr()) // false
    fmt.Println(c.CanAddr()) // false
    fmt.Println(d.CanAddr()) // true

}      

所有通過reflect.ValueOf(x)傳回的 reflect.Value都是不可取位址的。但是對于d,它是c的解引用方式生成的,指向另一個變量,是以是可 取位址的。我們可以通過調用reflect.ValueOf(&x).Elem(),來擷取任意變量x對應的可取位址的 Value。

要從變量對應的可取位址的reflect.Value來通路變量需要三個步驟。第一步是調用Addr()方法,它傳回 一個Value,裡面儲存了指向變量的指針。然後是在Value上調用Interface()方法,也就是傳回一個 interface{},裡面通用包含指向變量的指針。最後,如果我們知道變量的類型,我們可以使用類型的斷 言機制将得到的interface{}類型的接口強制環為普通的類型指針。這樣我們就可以通過這個普通指針來 更新變量了:

package main

import (
    "reflect"
    "fmt"
)

func main() {
    x := 2
    d := reflect.ValueOf(&x).Elem()
    px := d.Addr().Interface().(*int)
    *px = 3
    fmt.Print(x)
}      

當然這裡也可以通過另外一種方法更改:

package main

import (
    "reflect"
    "fmt"
)

func main() {
    x := 2
    d := reflect.ValueOf(&x).Elem()
    //px := d.Addr().Interface().(*int)
    //*px = 3
    d.Set(reflect.ValueOf(4))
    fmt.Print(x)
}      

但是直接Set是會報錯的,因為這裡我們正好用的指派也是int類型,如果我們用字元串的肯定就panic了

所有的努力都值得期許,每一份夢想都應該灌溉!