剥开比原看代码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写入到指定的文件地址。

到这里，咱们这个问题就算回答完毕了。