剝開比原看代碼01：初始化時生成的配置文件在哪兒

做者：freewind

比原項目倉庫：

Github地址：https://github.com/Bytom/bytom

Gitee地址：https://gitee.com/BytomBlockchain/bytom

人們常說，「閱讀源代碼」是學習編程的一種重要方法。做爲程序員，咱們在平時的學習工做中，都應該閱讀過很多源代碼。可是對於大多數人來講，閱讀的可能更可能是一些代碼片段、示例，或者在老師、同事的指導下，先對要閱讀的項目代碼有了總體的瞭解以後，再進行鍼對性的閱讀。

可是若是咱們面對的是一個像比原這樣比較龐大的項目，身邊又沒有人指導，只能靠本身去看，這時應該怎麼來閱讀呢？也許每一個人也都能找到本身的辦法，或高效，或低效，或放棄。

我在此次閱讀比原源代碼的過程當中，嘗試的是這樣一種方法：從外部入手，經過與比原節點進行數據交互，來一步步瞭解比原的內部原理。就像剝石榴同樣，一點點當心翼翼的下手，最後才能吃到鮮美的果肉。

因此這個文章系列叫做「剝開比原看代碼」。

說明

在系列中的每一章，我一般都會由一個或者幾個相關的問題入手，而後經過對源代碼進行分析，來講明比原的代碼是如何實現的。對於與當前問題關係不大的代碼，則會簡單帶過，等真正須要它們出場的時候再詳細解說。

爲了保證文章中引用代碼的穩定性，我將基於比原的v1.0.1代碼進行分析。隨着時間推移，比原的代碼也將快速更新，可是我以爲，只要把這個版本的代碼理解了，再去看新的代碼，應該是一件很容易的事情。

在文章中，將會有一些直接指向github上bytom源代碼的連接。爲了方便，我專門將bytom v1.0.1的代碼放到了一個新的倉庫中，這樣就不容易與比原官方的最新代碼混淆。該倉庫地址爲：https://github.com/freewind/bytom-v1.0.1

固然，你沒必要clone這個倉庫（clone官方倉庫http://github.com/Bytom/bytom就夠了），而後在必要的時候，使用如下命令將代碼切換到v1.0.1的tag，以便與本系列引用的代碼一致：

git fetch
git checkout -b v1.0.1

不論採用哪一種閱讀方法，我想第一步都應該先在本地把比原節點跑起來，試試各類功能。

對於如何下載、配置和安裝的問題，請直接參看官方文檔https://github.com/Bytom/bytom/tree/v1.0.1（注意我這裏給出的是v1.0.1的文檔），這裏很少說。

本篇問題

當咱們本地使用make bytomd編譯完比原後，咱們可使用下面的命令來進行初始化：

./bytomd init --chain_id testnet

這裏指定了使用的chain是testnet（還有別的選項，如mainnet等等）。運行成功後，它將會在本地文件系統生成一些配置文件，供比原啓動時使用。

因此個人問題是：

比原初始化時，產生了什麼樣的配置文件，放在了哪一個目錄下？

下面我將結合源代碼，來回答這個問題。

目錄位置

首先比原在本地會有一個目錄專門用於放置各類數據，好比密鑰、配置文件、數據庫文件等。這個目錄對應的代碼位於config/config.go#L190-L205：

func DefaultDataDir() string {
    // Try to place the data folder in the user's home dir
    home := homeDir()
    dataDir := "./.bytom"
    if home != "" {
        switch runtime.GOOS {
        case "darwin":
            dataDir = filepath.Join(home, "Library", "Bytom")
        case "windows":
            dataDir = filepath.Join(home, "AppData", "Roaming", "Bytom")
        default:
            dataDir = filepath.Join(home, ".bytom")
        }
    }
    return dataDir
}

能夠看到，在不一樣的操做系統上，數據目錄的位置也不一樣：

1. 蘋果系統(darwin)：~/Library/Bytom
2. Windows(windows): ~/AppData/Roaming/Bytom
3. 其它（如Linux）：~/.bytom

配置文件內容

咱們根據本身的操做系統打開相應的目錄（個人是~/Library/Bytom），能夠看到有一個config.toml，內容大約以下：

$ cat config.toml
# This is a TOML config file.
# For more information, see https://github.com/toml-lang/toml
fast_sync = true
db_backend = "leveldb"
api_addr = "0.0.0.0:9888"
chain_id = "testnet"
[p2p]
laddr = "tcp://0.0.0.0:46656"
seeds = "47.96.42.1:46656,172.104.224.219:46656,45.118.132.164:46656"

它已經把一些基本信息告訴咱們了，好比：

• db_backend = "leveldb"：說明比原內部使用了leveldb做爲數據庫（用來保存塊數據、賬號、交易信息等）
• api_addr = "0.0.0.0:9888"：咱們能夠在瀏覽器中打開http://localhost:9888來訪問dashboard頁面，進行查看與管理
• chain_id = "testnet"：當前鏈接的是testnet，即測試網，裏面挖出來的比原幣是不值錢的
• laddr = "tcp://0.0.0.0:46656"：本地監聽46656端口，別的節點若是想連我，就須要訪問個人46656端口
• seeds = "47.96.42.1:46656,172.104.224.219:46656,45.118.132.164:46656"：比原啓動後，會主動鏈接這幾個地址獲取數據

內容模板

使用不一樣的chain_id去初始化時，會生成不一樣內容的配置文件，那麼這些內容來自於哪裏呢？

原來在config/toml.go#L22-L45，預約義了不一樣的模板內容：

var defaultConfigTmpl = `# This is a TOML config file.
# For more information, see https://github.com/toml-lang/toml
fast_sync = true
db_backend = "leveldb"
api_addr = "0.0.0.0:9888"
`

var mainNetConfigTmpl = `chain_id = "mainnet"
[p2p]
laddr = "tcp://0.0.0.0:46657"
seeds = "45.79.213.28:46657,198.74.61.131:46657,212.111.41.245:46657,47.100.214.154:46657,47.100.109.199:46657,47.100.105.165:46657"
`

var testNetConfigTmpl = `chain_id = "testnet"
[p2p]
laddr = "tcp://0.0.0.0:46656"
seeds = "47.96.42.1:46656,172.104.224.219:46656,45.118.132.164:46656"
`

var soloNetConfigTmpl = `chain_id = "solonet"
[p2p]
laddr = "tcp://0.0.0.0:46658"
seeds = ""
`

能夠看到，原來這些端口號和seed的地址，都是事先寫好在模板裏的。

並且，經過觀察這些配置，咱們能夠發現，若是chain_id不一樣，則監聽的端口和鏈接的種子都不一樣：

1. mainnet（鏈接到主網）: 46657，會主動鏈接6個種子
2. testnet（鏈接到測試網）: 46656，會主動鏈接3個種子
3. solonet（本地單獨節點）: 46658，不會主動鏈接別人（也所以不會被別人鏈接上），適合單機研究

寫入文件

這裏咱們須要快速的把bytomd init的執行流程過一遍，才能清楚配置文件的寫入時機，也同時把前面的內容串在了一塊兒。

首先，當咱們運行bytomd init時，它對應的代碼入口爲cmd/bytomd/main.go#L54:

func main() {
    cmd := cli.PrepareBaseCmd(commands.RootCmd, "TM", os.ExpandEnv(config.DefaultDataDir()))
    cmd.Execute()
}

其中的config.DefaultDataDir()就對應於前面提到數據目錄位置。

而後執行cmd.Execute()，將根據傳入的參數init，選擇下面的函數來執行：cmd/bytomd/commands/init.go#L25-L24

func initFiles(cmd *cobra.Command, args []string) {
    configFilePath := path.Join(config.RootDir, "config.toml")
    if _, err := os.Stat(configFilePath); !os.IsNotExist(err) {
        log.WithField("config", configFilePath).Info("Already exists config file.")
        return
    }

    if config.ChainID == "mainnet" {
        cfg.EnsureRoot(config.RootDir, "mainnet")
    } else if config.ChainID == "testnet" {
        cfg.EnsureRoot(config.RootDir, "testnet")
    } else {
        cfg.EnsureRoot(config.RootDir, "solonet")
    }

    log.WithField("config", configFilePath).Info("Initialized bytom")
}

其中的configFilePath，就是config.toml的寫入地址，即咱們前面所說的數據目錄下的config.toml文件。

cfg.EnsureRoot將用來確認數據目錄是有效的，而且將根據傳入的chain_id不一樣，來生成不一樣的內容寫入到配置文件中。

它對應的代碼是config/toml.go#L10

func EnsureRoot(rootDir string, network string) {
    cmn.EnsureDir(rootDir, 0700)
    cmn.EnsureDir(rootDir+"/data", 0700)

    configFilePath := path.Join(rootDir, "config.toml")

    // Write default config file if missing.
    if !cmn.FileExists(configFilePath) {
        cmn.MustWriteFile(configFilePath, []byte(selectNetwork(network)), 0644)
    }
}

能夠看到，它對數據目錄進行了權限上的確認，而且發現當配置文件存在的時候，不會作任何更改。因此若是咱們須要生成新的配置文件，就須要把舊的刪除（或更名）。

其中的selectNetwork(network)函數，實現了根據chain_id的不一樣來組裝不一樣的配置文件內容，它對應於master/config/toml.go#L48:

func selectNetwork(network string) string {
    if network == "testnet" {
        return defaultConfigTmpl + testNetConfigTmpl
    } else if network == "mainnet" {
        return defaultConfigTmpl + mainNetConfigTmpl
    } else {
        return defaultConfigTmpl + soloNetConfigTmpl
    }
}

果真就是一個簡單的字符串拼接，其中的defaultConfigTmpl和*NetConfgTmpl在前面已經出現，這裏不重複。

最後調用第三方函數cmn.MustWriteFile(configFilePath, []byte(selectNetwork(network)), 0644)，把拼接出來的配置文件內容以權限0644寫入到指定的文件地址。

到這裏，咱們這個問題就算回答完畢了。