2. 程式人生 > 其它 >Git 專案推薦 | Go 語言讀寫 INI 檔案工具包

Git 專案推薦 | Go 語言讀寫 INI 檔案工具包

阿新 • • 發佈：2022-05-04

原文 http://git.oschina.net/Unknown/ini

主題 Git Go語言

本包提供了 Go 語言中讀寫 INI 檔案的功能。

功能特性

  • 支援覆蓋載入多個數據源（ []byte 或檔案）
  • 支援遞迴讀取鍵值
  • 支援讀取父子分割槽
  • 支援讀取自增鍵名
  • 支援讀取多行的鍵值
  • 支援大量輔助方法
  • 支援在讀取時直接轉換為 Go 語言型別
  • 支援讀取和 寫入 分割槽和鍵的註釋
  • 輕鬆操作分割槽、鍵值和註釋
  • 在儲存檔案時分割槽和鍵值會保持原有的順序

下載安裝

使用一個特定版本：

go get gopkg.in/ini.v1

使用最新版：

go get github.com/go-ini/ini

如需更新請新增 -u

選項。

測試安裝

如果您想要在自己的機器上執行測試，請使用 -t 標記：

go get -t gopkg.in/ini.v1

如需更新請新增 -u 選項。

開始使用

從資料來源載入

一個 資料來源 可以是 []byte 型別的原始資料，或 string 型別的檔案路徑。您可以載入 任意多個 資料來源。如果您傳遞其它型別的資料來源，則會直接返回錯誤。

cfg, err := ini.Load([]byte("raw data"), "filename")

或者從一個空白的檔案開始：

cfg := ini.Empty()

當您在一開始無法決定需要載入哪些資料來源時，仍可以使用 Append()

在需要的時候載入它們。

err := cfg.Append("other file", []byte("other raw data"))

操作分割槽（Section）

獲取指定分割槽：

section, err := cfg.GetSection("section name")

如果您想要獲取預設分割槽，則可以用空字串代替分割槽名：

section, err := cfg.GetSection("")

當您非常確定某個分割槽是存在的，可以使用以下簡便方法：

section := cfg.Section("")

如果不小心判斷錯了，要獲取的分割槽其實是不存在的，那會發生什麼呢？沒事的，它會自動建立並返回一個對應的分割槽物件給您。

建立一個分割槽：

err := cfg.NewSection("new section")

獲取所有分割槽物件或名稱：

sections := cfg.Sections()
names := cfg.SectionStrings()

操作鍵（Key）

獲取某個分割槽下的鍵：

key, err := cfg.Section("").GetKey("key name")

和分割槽一樣，您也可以直接獲取鍵而忽略錯誤處理：

key := cfg.Section("").Key("key name")

判斷某個鍵是否存在：

yes := cfg.Section("").HasKey("key name")

建立一個新的鍵：

err := cfg.Section("").NewKey("name", "value")

獲取分割槽下的所有鍵或鍵名：

keys := cfg.Section("").Keys()
names := cfg.Section("").KeyStrings()

獲取分割槽下的所有鍵值對的克隆：

hash := cfg.GetSection("").KeysHash()

操作鍵值（Value）

獲取一個型別為字串（string）的值：

val := cfg.Section("").Key("key name").String()

獲取值的同時通過自定義函式進行處理驗證：

val := cfg.Section("").Key("key name").Validate(func(in string) string {    if len(in) == 0 {        return "default"
    }    return in})

如果您不需要任何對值的自動轉變功能（例如遞迴讀取），可以直接獲取原值（這種方式效能最佳）：

val := cfg.Section("").Key("key name").Value()

判斷某個原值是否存在：

yes := cfg.Section("").HasValue("test value")

獲取其它型別的值：

// 布林值的規則：// true 當值為：1, t, T, TRUE, true, True, YES, yes, Yes, y, ON, on, On// false 當值為：0, f, F, FALSE, false, False, NO, no, No, n, OFF, off, Offv, err = cfg.Section("").Key("BOOL").Bool()
v, err = cfg.Section("").Key("FLOAT64").Float64()
v, err = cfg.Section("").Key("INT").Int()
v, err = cfg.Section("").Key("INT64").Int64()
v, err = cfg.Section("").Key("UINT").Uint()
v, err = cfg.Section("").Key("UINT64").Uint64()
v, err = cfg.Section("").Key("TIME").TimeFormat(time.RFC3339)
v, err = cfg.Section("").Key("TIME").Time() // RFC3339v = cfg.Section("").Key("BOOL").MustBool()
v = cfg.Section("").Key("FLOAT64").MustFloat64()
v = cfg.Section("").Key("INT").MustInt()
v = cfg.Section("").Key("INT64").MustInt64()
v = cfg.Section("").Key("UINT").MustUint()
v = cfg.Section("").Key("UINT64").MustUint64()
v = cfg.Section("").Key("TIME").MustTimeFormat(time.RFC3339)
v = cfg.Section("").Key("TIME").MustTime() // RFC3339// 由 Must 開頭的方法名允許接收一個相同型別的引數來作為預設值，// 當鍵不存在或者轉換失敗時，則會直接返回該預設值。// 但是，MustString 方法必須傳遞一個預設值。v = cfg.Seciont("").Key("String").MustString("default")
v = cfg.Section("").Key("BOOL").MustBool(true)
v = cfg.Section("").Key("FLOAT64").MustFloat64(1.25)
v = cfg.Section("").Key("INT").MustInt(10)
v = cfg.Section("").Key("INT64").MustInt64(99)
v = cfg.Section("").Key("UINT").MustUint(3)
v = cfg.Section("").Key("UINT64").MustUint64(6)
v = cfg.Section("").Key("TIME").MustTimeFormat(time.RFC3339, time.Now())
v = cfg.Section("").Key("TIME").MustTime(time.Now()) // RFC3339

如果我的值有好多行怎麼辦？

[advance]
ADDRESS = """404 road,
NotFound, State, 5000
Earth"""

嗯哼？小 case！

cfg.Section("advance").Key("ADDRESS").String()/* --- start ---
404 road,
NotFound, State, 5000
Earth
------  end  --- */

贊爆了！那要是我屬於一行的內容寫不下想要寫到第二行怎麼辦？

[advance]
two_lines = how about 
    continuation lines?
lots_of_lines = 1 
    2 
    3 
    4

簡直是小菜一碟！

cfg.Section("advance").Key("two_lines").String() // how about continuation lines?cfg.Section("advance").Key("lots_of_lines").String() // 1 2 3 4

需要注意的是，值兩側的單引號會被自動剔除：

foo = "some value" // foo: some valuebar = 'some value' // bar: some value

這就是全部了？哈哈，當然不是。

操作鍵值的輔助方法

獲取鍵值時設定候選值：

v = cfg.Section("").Key("STRING").In("default", []string{"str", "arr", "types"})v = cfg.Section("").Key("FLOAT64").InFloat64(1.1, []float64{1.25, 2.5, 3.75})v = cfg.Section("").Key("INT").InInt(5, []int{10, 20, 30})v = cfg.Section("").Key("INT64").InInt64(10, []int64{10, 20, 30})v = cfg.Section("").Key("UINT").InUint(4, []int{3, 6, 9})v = cfg.Section("").Key("UINT64").InUint64(8, []int64{3, 6, 9})v = cfg.Section("").Key("TIME").InTimeFormat(time.RFC3339, time.Now(), []time.Time{time1, time2, time3})v = cfg.Section("").Key("TIME").InTime(time.Now(), []time.Time{time1, time2, time3}) // RFC3339

如果獲取到的值不是候選值的任意一個，則會返回預設值，而預設值不需要是候選值中的一員。

驗證獲取的值是否在指定範圍內：

vals = cfg.Section("").Key("FLOAT64").RangeFloat64(0.0, 1.1, 2.2)vals = cfg.Section("").Key("INT").RangeInt(0, 10, 20)vals = cfg.Section("").Key("INT64").RangeInt64(0, 10, 20)vals = cfg.Section("").Key("UINT").RangeUint(0, 3, 9)vals = cfg.Section("").Key("UINT64").RangeUint64(0, 3, 9)vals = cfg.Section("").Key("TIME").RangeTimeFormat(time.RFC3339, time.Now(), minTime, maxTime)vals = cfg.Section("").Key("TIME").RangeTime(time.Now(), minTime, maxTime) // RFC3339

自動分割鍵值到切片（slice）

當存在無效輸入時，使用零值代替：

// Input: 1.1, 2.2, 3.3, 4.4 -> [1.1 2.2 3.3 4.4]// Input: how, 2.2, are, you -> [0.0 2.2 0.0 0.0]vals = cfg.Section("").Key("STRINGS").Strings(",")
vals = cfg.Section("").Key("FLOAT64S").Float64s(",")
vals = cfg.Section("").Key("INTS").Ints(",")
vals = cfg.Section("").Key("INT64S").Int64s(",")
vals = cfg.Section("").Key("UINTS").Uints(",")
vals = cfg.Section("").Key("UINT64S").Uint64s(",")
vals = cfg.Section("").Key("TIMES").Times(",")

從結果切片中剔除無效輸入：

// Input: 1.1, 2.2, 3.3, 4.4 -> [1.1 2.2 3.3 4.4]// Input: how, 2.2, are, you -> [2.2]vals = cfg.Section("").Key("FLOAT64S").ValidFloat64s(",")
vals = cfg.Section("").Key("INTS").ValidInts(",")
vals = cfg.Section("").Key("INT64S").ValidInt64s(",")
vals = cfg.Section("").Key("UINTS").ValidUints(",")
vals = cfg.Section("").Key("UINT64S").ValidUint64s(",")
vals = cfg.Section("").Key("TIMES").ValidTimes(",")

當存在無效輸入時，直接返回錯誤：

// Input: 1.1, 2.2, 3.3, 4.4 -> [1.1 2.2 3.3 4.4]// Input: how, 2.2, are, you -> errorvals = cfg.Section("").Key("FLOAT64S").StrictFloat64s(",")
vals = cfg.Section("").Key("INTS").StrictInts(",")
vals = cfg.Section("").Key("INT64S").StrictInt64s(",")
vals = cfg.Section("").Key("UINTS").StrictUints(",")
vals = cfg.Section("").Key("UINT64S").StrictUint64s(",")
vals = cfg.Section("").Key("TIMES").StrictTimes(",")

儲存配置

終於到了這個時刻，是時候儲存一下配置了。

比較原始的做法是輸出配置到某個檔案：

// ...err = cfg.SaveTo("my.ini")
err = cfg.SaveToIndent("my.ini", "t")

另一個比較高階的做法是寫入到任何實現 io.Writer 介面的物件中：

// ...cfg.WriteTo(writer)
cfg.WriteToIndent(writer, "t")

高階用法

遞迴讀取鍵值

在獲取所有鍵值的過程中，特殊語法 %(<name>)s 會被應用，其中 <name> 可以是相同分割槽或者預設分割槽下的鍵名。字串 %(<name>)s 會被相應的鍵值所替代，如果指定的鍵不存在，則會用空字串替代。您可以最多使用 99 層的遞迴巢狀。

NAME = ini[author]NAME = UnknwonGITHUB = https://github.com/%(NAME)s[package]FULL_NAME = github.com/go-ini/%(NAME)s
cfg.Section("author").Key("GITHUB").String()        // https://github.com/Unknwoncfg.Section("package").Key("FULL_NAME").String()    // github.com/go-ini/ini

讀取父子分割槽

您可以在分割槽名稱中使用 . 來表示兩個或多個分割槽之間的父子關係。如果某個鍵在子分割槽中不存在，則會去它的父分割槽中再次尋找，直到沒有父分割槽為止。

NAME = iniVERSION = v1IMPORT_PATH = gopkg.in/%(NAME)s.%(VERSION)s[package]CLONE_URL = https://%(IMPORT_PATH)s[package.sub]
cfg.Section("package.sub").Key("CLONE_URL").String()    // https://gopkg.in/ini.v1

讀取自增鍵名

如果資料來源中的鍵名為 - ，則認為該鍵使用了自增鍵名的特殊語法。計數器從 1 開始，並且分割槽之間是相互獨立的。

[features]
-: Support read/write comments of keys and sections
-: Support auto-increment of key names
-: Support load multiple files to overwrite key values
cfg.Section("features").KeyStrings()    // []{"#1", "#2", "#3"}

對映到結構

想要使用更加面向物件的方式玩轉 INI 嗎？好主意。

Name = Unknwonage = 21Male = trueBorn = 1993-01-01T20:17:05Z[Note]Content = Hi is a good man!Cities = HangZhou, Boston
type Note struct {
    Content string
    Cities  []string}

type Person struct {
    Name string
    Age  int `ini:"age"`
    Male bool
    Born time.Time
    Note
    Created time.Time `ini:"-"`
}

func main() {
    cfg, err := ini.Load("path/to/ini")    // ...
    p := new(Person)
    err = cfg.MapTo(p)    // ...

    // 一切竟可以如此的簡單。
    err = ini.MapTo(p, "path/to/ini")    // ...

    // 嗯哼？只需要對映一個分割槽嗎？
    n := new(Note)
    err = cfg.Section("Note").MapTo(n)    // ...}

結構的欄位怎麼設定預設值呢？很簡單，只要在對映之前對指定欄位進行賦值就可以了。如果鍵未找到或者型別錯誤，該值不會發生改變。

// ...p := &Person{
    Name: "Joe",
}// ...

這樣玩 INI 真的好酷啊！然而，如果不能還給我原來的配置檔案，有什麼卵用？

從結構反射

可是，我有說不能嗎？

type Embeded struct {
    Dates  []time.Time `delim:"|"`
    Places []string
    None   []int}

type Author struct {
    Name      string `ini:"NAME"`
    Male      bool
    Age       int
    GPA       float64
    NeverMind string `ini:"-"`
    *Embeded
}

func main() {
    a := &Author{"Unknwon", true, 21, 2.8, "",
        &Embeded{
            []time.Time{time.Now(), time.Now()},
            []string{"HangZhou", "Boston"},
            []int{},
        }}
    cfg := ini.Empty()
    err = ini.ReflectFrom(cfg, a)    // ...}

瞧瞧，奇蹟發生了。

NAME = UnknwonMale = trueAge = 21GPA = 2.8[Embeded]Dates = 2015-08-07T22:14:22+08:00|2015-08-07T22:14:22+08:00Places = HangZhou,BostonNone =

名稱對映器（Name Mapper）

為了節省您的時間並簡化程式碼，本庫支援型別為 NameMapper 的名稱對映器，該對映器負責結構欄位名與分割槽名和鍵名之間的對映。

目前有 2 款內建的對映器：

  • AllCapsUnderscore ：該對映器將欄位名轉換至格式 ALL_CAPS_UNDERSCORE後再去匹配分割槽名和鍵名。
  • TitleUnderscore ：該對映器將欄位名轉換至格式 title_underscore 後再去匹配分割槽名和鍵名。

使用方法：

type Info struct{
    PackageName string}

func main() {
    err = ini.MapToWithMapper(&Info{}, ini.TitleUnderscore, []byte("package_name=ini"))    // ...

    cfg, err := ini.Load([]byte("PACKAGE_NAME=ini"))    // ...
    info := new(Info)
    cfg.NameMapper = ini.AllCapsUnderscore
    err = cfg.MapTo(info)    // ...}

使用函式 ini.ReflectFromWithMapper 時也可應用相同的規則。

對映/反射的其它說明

任何嵌入的結構都會被預設認作一個不同的分割槽，並且不會自動產生所謂的父子分割槽關聯：

type Child struct {
    Age string}

type Parent struct {
    Name string
    Child
}

type Config struct {
    City string
    Parent
}

示例配置檔案：

City = Boston[Parent]Name = Unknwon[Child]Age = 21

很好，但是，我就是要嵌入結構也在同一個分割槽。好吧，你爹是李剛！

type Child struct {
    Age string}

type Parent struct {
    Name string
    Child `ini:"Parent"`
}

type Config struct {
    City string
    Parent
}

示例配置檔案：

City = Boston[Parent]Name = UnknwonAge = 21

獲取幫助

  • API 文件
  • 建立工單

常見問題

欄位 BlockMode 是什麼？

預設情況下，本庫會在您進行讀寫操作時採用鎖機制來確保資料時間。但在某些情況下，您非常確定只進行讀操作。此時，您可以通過設定 cfg.BlockMode = false來將讀操作提升大約 50-70% 的效能。

為什麼要寫另一個 INI 解析庫？

許多人都在使用我的 goconfig 來完成對 INI 檔案的操作，但我希望使用更加 Go 風格的程式碼。並且當您設定 cfg.BlockMode = false 時，會有大約 10-30% 的效能提升。

為了做出這些改變，我必須對 API 進行破壞，所以新開一個倉庫是最安全的做法。除此之外，本庫直接使用 gopkg.in 來進行版本化釋出。（其實真相是匯入路徑更短了）

相關推薦

Git 專案推薦 | Go 語言讀寫 INI 檔案工具包

原文http://git.oschina.net/Unknown/ini 主題 Git Go語言 本包提供了 Go 語言中讀寫 INI 檔案的功能。

Go 語言讀寫 Excel 文件

Excelize 是 Go 語言編寫的一個用來操作 Office Excel 文件類庫，基於 ECMA-376 Office OpenXML 標準。可以使用它來讀取、寫入 XLSX 檔案。相比較其他的開源類庫，Excelize 支援寫入原本帶有圖片(表)的文件，還支援向

Python3中configparser模組讀寫ini檔案並解析配置的用法詳解

Python3中configparser模組簡介 configparser 是 Pyhton 標準庫中用來解析配置檔案的模組，並且內建方法和字典非常接近。Python2.x 中名為 ConfigParser，3.x 已更名小寫，並加入了一些新功能。

Delphi讀寫ini檔案(C++Builder類似)

一、定義 -- 1 、在 Interface 的 Uses 節增加 IniFiles; -- 2 、在 Var 變數定義部分增加一行 :

C# 利用動態庫DllImport("kernel32")讀寫ini檔案

1 ini檔案讀寫 kernel32.dll是Windows中非常重要的32位動態連結庫檔案，屬於核心級檔案。它控制著系統的記憶體管理、資料的輸入輸出操作和中斷處理，當Windows啟動時，kernel32.dll就駐留在記憶體中特定的防寫區域，

C++ API讀寫ini檔案

技術標籤：C++ void CINIOperateDlg::OnBnClickedBtnWriteini() { // TODO: 在此新增控制元件通知處理程式程式碼

python簡單讀寫ini檔案

1、建立ini檔案 2、認識configparse類中基礎方法cfg_obj = configparser.ConfigParser()#建立物件cfg_obj.read(conf_file_path) #讀取配置檔案sections = cfg_obj.sections()#獲取配置檔案中所有的section節點opti

C++讀寫.ini 檔案

// RWIniTest.cpp : 此檔案包含 \"main\" 函式。程式執行將在此處開始並結束。 // #include <iostream>

Python3操作讀寫CSV檔案使用包過程解析

CSV(Comma-Separated Values)即逗號分隔值，一種以逗號分隔按行儲存的文字檔案，所有的值都表現為字串型別（注意：數字為字串型別）。

Java利用POI讀寫Excel檔案工具類

本文例項為大家分享了Java讀寫Excel檔案工具類的具體程式碼，供大家參考，具體內容如下

如何使用Python3讀寫INI配置檔案

https://blog.csdn.net/willhuo/article/details/49512557 ini檔案簡介 ini是我們常見到的配置檔案格式之一。

基於Python3讀寫INI配置檔案過程解析

ini檔案簡介 ini是我們常見到的配置檔案格式之一。 ini是微軟Windows作業系統中的副檔名（也常用在其他系統）。

C++讀寫ini配置檔案實現過程詳解

在Windows的VC下 讀ini檔案 例如：在D:\\test.ini檔案中 [Font] name=宋體 size= 12pt color = RGB(255,0)

WritePrivateProfileString等讀寫.ini配置檔案

轉載：https://blog.csdn.net/wuguai4/article/details/7287346 配置檔案中經常用到ini檔案，在VC中其函式分別為：寫入.ini檔案：

Python3讀寫ini配置檔案的示例

ini檔案即Initialization File初始化檔案，在應用程式及框架中常作為配置檔案使用，是一種靜態純文字檔案，使用記事本即可編輯。

winform讀寫ini

public class IniInfo { //呼叫API函式 [DllImport(\"kernel32\")] private static extern bool WritePrivateProfileString(string section, string key, string val, string filePath);

揭祕！用標準Go語言能寫指令碼嗎？

揭祕！用標準Go語言能寫指令碼嗎？ https://mp.weixin.qq.com/s/NTA-Mf14gj-6nDTDekGNVA 揭祕！用標準Go語言能寫指令碼嗎？

三個小專案入門Go語言｜位元組青訓營筆記

前言 這是青訓營的第一課，今天的課程比較快速的講解了go語言的入門，並配合三個小的專案實踐梳理所學知識點，這裡詳細回顧一下這三個專案，結合課後作業要求做一些程式碼補充，並附上自己的分析，青訓期間的所有課程

Python3讀寫Excel檔案(使用xlrd,xlsxwriter,openpyxl3種方式讀寫例項與優劣)

Python中幾種常用包比較 2、用xlrd包讀取Excel檔案 引用包 import xlrd 開啟檔案 xlrd.open_workbook(r\'/root/excel/chat.xls\')

python使用docx模組讀寫docx檔案的方法與docx模組常用方法詳解

一，docx模組 Python可以利用python-docx模組處理word文件，處理方式是面向物件的。也就是說python-docx模組會把word文件，文件中的段落、文字、字型等都看做物件，對物件進行處理就是對word文件的內容處理。