摘要：所以這個文章系列叫作剝開比原看代碼。所以我的問題是比原初始化時，產生了什么樣的配置文件，放在了哪個目錄下下面我將結合源代碼，來回答這個問題。將用來確認數據目錄是有效的，并且將根據傳入的不同，來生成不同的內容寫入到配置文件中。

作者：freewind

比原項目倉庫：

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

Gitee地址：https://gitee.com/BytomBlockc...

人們常說，“閱讀源代碼”是學習編程的一種重要方法。作為程序員，我們在平時的學習工作中，都應該閱讀過不少源代碼。但是對于大多數人來說，閱讀的可能更多是一些代碼片斷、示例，或者在老師、同事的指導下，先對要閱讀的項目代碼有了整體的了解之后，再進行針對性的閱讀。

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

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

所以這個文章系列叫作“剝開比原看代碼”。

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

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

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

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

git fetch
git checkout -b v1.0.1

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

對于如何下載、配置和安裝的問題，請直接參看官方文檔https://github.com/Bytom/byto...（注意我這里給出的是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
}

可以看到，在不同的操作系統上，數據目錄的位置也不同：

蘋果系統(darwin)：~/Library/Bytom

Windows(windows): ~/AppData/Roaming/Bytom

其它（如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不同，則監聽的端口和連接的種子都不同：

mainnet（連接到主網）: 46657，會主動連接6個種子

testnet（連接到測試網）: 46656，會主動連接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寫入到指定的文件地址。

到這里，我們這個問題就算回答完畢了。