首页 > 脚本专栏 > Golang > Go读取配置文件

Go读取配置文件的方法总结

2023-10-30 10:32:54 作者：程序员技术成长之路

我们常见的配置文件的格式一般有：XML、JSON、INI、YAML、env和.properties,本文小编为大家整理了Go语言读取这些格式的配置文件的方法,希望对大家有所帮助

常见的配置文件的格式

1.XML文件（.xml）: 这是一种可扩展的标记语言，它允许用户定义自己的标记。XML文件是一种常见的配置文件，因为它们易于阅读和编写，同时支持嵌套，非常适合存储复杂数据。

2.JSON文件（.json）: JSON（JavaScript Object Notation）是一种轻量级的数据交换格式，易于人阅读和编写。它是 JavaScript 中创建对象的主要方式，因此在 web 应用程序中特别常见。

3.INI文件(.ini): INI 文件是一种配置文件格式，Windows 应用程序经常使用。INI 文件由节（sections）组成，每个节下是一组键-值（key-value）对。

4.YAML 文件（.yaml/.yml）: YAML 是 "YAML Ain't Markup Language" 的缩写（递归缩写），这是一种人类易读的数据序列化标准，用于所有编程语言中的数据交换。

5. .env 文件: 这是一种简单的键值对格式的文件，用于存储环境变量。这种格式的优点是它可以轻松地与环境变量集成，这在很多编程环境中是关键。

6. .properties 文件: 这是Java语言中用于存储配置信息的文件，采用键值对的方式存储数据。

下面我就来演示一下在代码中如何读取常见的格式

XML的格式

要在 Go 中读取 XML 文件，我们可以使用 Go 的 "encoding/xml" 包。

新建一个cd_catalog.xml文件

<?xml version="1.0" encoding="UTF-8"?>
<CATALOG>
    <CD>
        <TITLE>Empire Burlesque</TITLE>
        <ARTIST>Bob Dylan</ARTIST>
        <YEAR>1985</YEAR>
    </CD>
    <CD>
        <TITLE>Hide your heart</TITLE>
        <ARTIST>Bonnie Tyler</ARTIST>
        <YEAR>1988</YEAR>
    </CD>
    <CD>
        <TITLE>Greatest Hits</TITLE>
        <ARTIST>Dolly Parton</ARTIST>
        <YEAR>2000</YEAR>
    </CD>
</CATALOG>

Go的完整代码

package main

import (
    "encoding/xml"
    "os"
    "fmt"
    "log"
)

type CD struct {
    Title  string `xml:"TITLE"`
    Artist string `xml:"ARTIST"`
    Year   string `xml:"YEAR"`
}

type CDs struct {
    CD []CD `xml:"CD"`
}

func main() {
    file, err := os.Open("cd_catalog.xml") // Replace with your xml file
    if err != nil {
        log.Fatal(err)
    }

    decoder := xml.NewDecoder(file)

    var cds CDs
    err = decoder.Decode(&cds)
    if err != nil {
      log.Fatal(err)
    }

    for i := range cds.CD {
        fmt.Println(cds.CD[i].Title, cds.CD[i].Artist, cds.CD[i].Year)
    }
}

JSON格式

json格式同xml内容差不多，只是引用的encoding/json

type Config struct {
    Server string `json:"server"`
    Port   int    `json:"port"`
}

func main() {
    file, err := os.Open("config.json")
    if err != nil {
        log.Fatalf("Failed to open file: %s", err)
    }

    config := Config{}
    decoder := json.NewDecoder(file)
    if err := decoder.Decode(&config); err != nil {
        log.Fatalf("Failed to decode JSON: %s", err)
    }

    // 使用配置信息
    log.Println(config.Server)
    log.Println(config.Port)
}

INI格式

1、下载指定扩展包

go get github.com/go-ini/ini

2、创建config.ini文件

[server]
host = localhost
port = 8080

3、go代码

package main

import (
  "log"

  ini "github.com/go-ini/ini"
)

type Config struct {
  Server struct {
    Host string
    Port int
  } `ini:"server"`
}

func main() {
  cfg := new(Config)
  err := ini.MapTo(cfg, "path/to/config.ini")
  if err != nil {
    log.Fatalln(err)
  }

  log.Println("Server Host:", cfg.Server.Host)
  log.Println("Server Port:", cfg.Server.Port)
}

YAML格式

yaml文件

server: localhost
port: 8080

通过运行 go get gopkg.in/yaml.v2 安装 yaml.v2 库

package main

import (
    "gopkg.in/yaml.v2"
    "io/ioutil"
    "log"
)

type Config struct {
    Server string `yaml:"server"`
    Port   int    `yaml:"port"`
}

func main() {
    data, err := ioutil.ReadFile("/path/to/your/yaml/file.yaml")
    if err != nil {
        log.Fatalf("error: %v", err)
    }

    config := Config{}
    err = yaml.Unmarshal(data, &config)
    if err != nil {
        log.Fatalf("error: %v", err)
    }

    // 使用配置信息
    log.Println(config.Server)
    log.Println(config.Port)
}

注意：请将代码中的 /path/to/your/yaml/file.yaml 替换为你的 YAML 文件的实际路径。

总结

XML文件（.xml）：

优点：格式统一，适用于复杂的层级关系数据，支持验证语法。
缺点：阅读和编写相对繁琐，文件稍大时性能较差。

JSON文件（.json）：

优点：轻量级，格式灵活，读写方便，性能较好。
缺点：不适合超大型和复杂的层级关系数据。

INI文件（.ini）：

优点：简单、易于阅读和编写，适用于存储简单的配置数据。
缺点：无法有效处理复杂的数据结构。

YAML文件（.yaml/.yml）：

优点：人类可读性强，能表示复杂的数据结构，适合用于配置文件。
缺点：语法严谨，缩进敏感，易误操作。

.env文件：

优点：轻量级，简单，主要用于存储环境变量。
缺点：格式简练，用途单一，不能表示复杂的数据类型。

.properties文件：

优点：常用于Java环境下的配置，格式简单。
缺点：功能较为简单，不能处理复杂的数据结构。

以上就是Go读取配置文件的方法总结的详细内容，更多关于Go读取配置文件的资料请关注脚本之家其它相关文章！