人們常說(shuō)，“閱讀源代碼”是學(xué)習(xí)編程的一種重要方法。作為程序員最蕾，我們?cè)谄綍r(shí)的學(xué)習(xí)工作中翩伪，都應(yīng)該閱讀過(guò)不少源代碼。但是對(duì)于大多數(shù)人來(lái)說(shuō)住册，閱讀的可能更多是一些代碼片斷、示例，或者在老師慷暂、同事的指導(dǎo)下，先對(duì)要閱讀的項(xiàng)目代碼有了整體的了解之后晨雳，再進(jìn)行針對(duì)性的閱讀行瑞。
但是如果我們面對(duì)的是一個(gè)像比原這樣比較龐大的項(xiàng)目，身邊又沒有人指導(dǎo)餐禁，只能靠自己去看血久，這時(shí)應(yīng)該怎么來(lái)閱讀呢？也許每個(gè)人也都能找到自己的辦法帮非，或高效氧吐，或低效讹蘑，或放棄。
我在這次閱讀比原源代碼的過(guò)程中筑舅，嘗試的是這樣一種方法：從外部入手座慰，通過(guò)與比原節(jié)點(diǎn)進(jìn)行數(shù)據(jù)交互，來(lái)一步步了解比原的內(nèi)部原理翠拣。就像剝石榴一樣版仔，一點(diǎn)點(diǎn)小心翼翼的下手，最后才能吃到鮮美的果肉误墓。
所以這個(gè)文章系列叫作“剝開比原看代碼”蛮粮。
在系列中的每一章，我通常都會(huì)由一個(gè)或者幾個(gè)相關(guān)的問題入手谜慌，然后通過(guò)對(duì)源代碼進(jìn)行分析然想，來(lái)說(shuō)明比原的代碼是如何實(shí)現(xiàn)的。對(duì)于與當(dāng)前問題關(guān)系不大的代碼欣范，則會(huì)簡(jiǎn)單帶過(guò)又沾，等真正需要它們出場(chǎng)的時(shí)候再詳細(xì)解說(shuō)。
為了保證文章中引用代碼的穩(wěn)定性熙卡，我將基于比原的v1.0.1代碼進(jìn)行分析杖刷。隨著時(shí)間推移，比原的代碼也將快速更新驳癌，但是我覺得滑燃，只要把這個(gè)版本的代碼理解了，再去看新的代碼颓鲜，應(yīng)該是一件很容易的事情表窘。
在文章中，將會(huì)有一些直接指向github上bytom源代碼的鏈接甜滨。為了方便乐严，我專門將bytom v1.0.1的代碼放到了一個(gè)新的倉(cāng)庫(kù)中，這樣就不容易與比原官方的最新代碼混淆衣摩。該倉(cāng)庫(kù)地址為：https://github.com/freewind/bytom-v1.0.1
當(dāng)然昂验，你不必clone這個(gè)倉(cāng)庫(kù)（clone官方倉(cāng)庫(kù)http://github.com/Bytom/bytom就夠了），然后在必要的時(shí)候艾扮，使用以下命令將代碼切換到v1.0.1的tag既琴，以便與本系列引用的代碼一致：
git fetch
git checkout -b v1.0.1
不論采用哪種閱讀方法，我想第一步都應(yīng)該先在本地把比原節(jié)點(diǎn)跑起來(lái)泡嘴，試試各種功能甫恩。
對(duì)于如何下載、配置和安裝的問題酌予，請(qǐng)直接參看官方文檔https://github.com/Bytom/bytom/tree/v1.0.1（注意我這里給出的是v1.0.1的文檔）磺箕，這里不多說(shuō)奖慌。
當(dāng)我們本地使用make bytomd編譯完比原后，我們可以使用下面的命令來(lái)進(jìn)行初始化：
./bytomd init --chain_id testnet
這里指定了使用的chain是testnet（還有別的選項(xiàng)松靡，如mainnet等等）简僧。運(yùn)行成功后，它將會(huì)在本地文件系統(tǒng)生成一些配置文件击困，供比原啟動(dòng)時(shí)使用涎劈。
所以我的問題是：
比原初始化時(shí)广凸，產(chǎn)生了什么樣的配置文件阅茶，放在了哪個(gè)目錄下？
下面我將結(jié)合源代碼谅海，來(lái)回答這個(gè)問題脸哀。
首先比原在本地會(huì)有一個(gè)目錄專門用于放置各種數(shù)據(jù)，比如密鑰扭吁、配置文件撞蜂、數(shù)據(jù)庫(kù)文件等。這個(gè)目錄對(duì)應(yīng)的代碼位于config/config.go#L190-L205：
funcDefaultDataDir()string{// Try to place the data folder in the user's home dirhome:=homeDir()dataDir:="./.bytom"ifhome!=""{switchruntime.GOOS{case"darwin":dataDir=filepath.Join(home,"Library","Bytom")case"windows":dataDir=filepath.Join(home,"AppData","Roaming","Bytom")default:dataDir=filepath.Join(home,".bytom")}}returndataDir}
可以看到侥袜，在不同的操作系統(tǒng)上蝌诡，數(shù)據(jù)目錄的位置也不同：
蘋果系統(tǒng)(darwin)：~/Library/Bytom
Windows(windows):?~/AppData/Roaming/Bytom
其它（如Linux）：~/.bytom
我們根據(jù)自己的操作系統(tǒng)打開相應(yīng)的目錄（我的是~/Library/Bytom），可以看到有一個(gè)config.toml枫吧，內(nèi)容大約如下：
$ cat config.toml# This is a TOML config file.# For more information, see https://github.com/toml-lang/tomlfast_sync=truedb_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"
它已經(jīng)把一些基本信息告訴我們了浦旱，比如：
db_backend = "leveldb"：說(shuō)明比原內(nèi)部使用了leveldb作為數(shù)據(jù)庫(kù)（用來(lái)保存塊數(shù)據(jù)、帳號(hào)九杂、交易信息等）
api_addr = "0.0.0.0:9888"：我們可以在瀏覽器中打開http://localhost:9888來(lái)訪問dashboard頁(yè)面颁湖，進(jìn)行查看與管理
chain_id = "testnet"：當(dāng)前連接的是testnet，即測(cè)試網(wǎng)例隆，里面挖出來(lái)的比原幣是不值錢的
laddr = "tcp://0.0.0.0:46656"：本地監(jiān)聽46656端口甥捺，別的節(jié)點(diǎn)如果想連我，就需要訪問我的46656端口
seeds = "47.96.42.1:46656,172.104.224.219:46656,45.118.132.164:46656"：比原啟動(dòng)后镀层，會(huì)主動(dòng)連接這幾個(gè)地址獲取數(shù)據(jù)
使用不同的chain_id去初始化時(shí)镰禾，會(huì)生成不同內(nèi)容的配置文件，那么這些內(nèi)容來(lái)自于哪里呢唱逢？
原來(lái)在config/toml.go#L22-L45羡微，預(yù)定義了不同的模板內(nèi)容：
vardefaultConfigTmpl=`# 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"
`varmainNetConfigTmpl=`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"
`vartestNetConfigTmpl=`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"
`varsoloNetConfigTmpl=`chain_id = "solonet"
[p2p]
laddr = "tcp://0.0.0.0:46658"
seeds = ""
`
可以看到，原來(lái)這些端口號(hào)和seed的地址惶我，都是事先寫好在模板里的妈倔。
而且，通過(guò)觀察這些配置绸贡，我們可以發(fā)現(xiàn)盯蝴，如果chain_id不同毅哗，則監(jiān)聽的端口和連接的種子都不同：
mainnet（連接到主網(wǎng)）:?46657，會(huì)主動(dòng)連接6個(gè)種子
testnet（連接到測(cè)試網(wǎng)）:?46656捧挺，會(huì)主動(dòng)連接3個(gè)種子
solonet（本地單獨(dú)節(jié)點(diǎn)）:?46658虑绵，不會(huì)主動(dòng)連接別人（也因此不會(huì)被別人連接上），適合單機(jī)研究
這里我們需要快速的把bytomd init的執(zhí)行流程過(guò)一遍闽烙，才能清楚配置文件的寫入時(shí)機(jī)翅睛，也同時(shí)把前面的內(nèi)容串在了一起。
首先黑竞，當(dāng)我們運(yùn)行bytomd init時(shí)捕发，它對(duì)應(yīng)的代碼入口為cmd/bytomd/main.go#L54:
funcmain(){cmd:=cli.PrepareBaseCmd(commands.RootCmd,"TM",os.ExpandEnv(config.DefaultDataDir()))cmd.Execute()}
其中的config.DefaultDataDir()就對(duì)應(yīng)于前面提到數(shù)據(jù)目錄位置。
然后執(zhí)行cmd.Execute()很魂，將根據(jù)傳入的參數(shù)init扎酷，選擇下面的函數(shù)來(lái)執(zhí)行：cmd/bytomd/commands/init.go#L25-L24
funcinitFiles(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}ifconfig.ChainID=="mainnet"{cfg.EnsureRoot(config.RootDir,"mainnet")}elseifconfig.ChainID=="testnet"{cfg.EnsureRoot(config.RootDir,"testnet")}else{cfg.EnsureRoot(config.RootDir,"solonet")}log.WithField("config",configFilePath).Info("Initialized bytom")}
其中的configFilePath，就是config.toml的寫入地址遏匆，即我們前面所說(shuō)的數(shù)據(jù)目錄下的config.toml文件法挨。
cfg.EnsureRoot將用來(lái)確認(rèn)數(shù)據(jù)目錄是有效的，并且將根據(jù)傳入的chain_id不同幅聘，來(lái)生成不同的內(nèi)容寫入到配置文件中凡纳。
它對(duì)應(yīng)的代碼是config/toml.go#L10
funcEnsureRoot(rootDirstring,networkstring){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)}}
可以看到，它對(duì)數(shù)據(jù)目錄進(jìn)行了權(quán)限上的確認(rèn)帝蒿，并且發(fā)現(xiàn)當(dāng)配置文件存在的時(shí)候荐糜，不會(huì)做任何更改。所以如果我們需要生成新的配置文件陵叽，就需要把舊的刪除（或改名）狞尔。
其中的selectNetwork(network)函數(shù)，實(shí)現(xiàn)了根據(jù)chain_id的不同來(lái)組裝不同的配置文件內(nèi)容巩掺，它對(duì)應(yīng)于master/config/toml.go#L48:
funcselectNetwork(networkstring)string{ifnetwork=="testnet"{returndefaultConfigTmpl+testNetConfigTmpl}elseifnetwork=="mainnet"{returndefaultConfigTmpl+mainNetConfigTmpl}else{returndefaultConfigTmpl+soloNetConfigTmpl}}
果然就是一個(gè)簡(jiǎn)單的字符串拼接偏序，其中的defaultConfigTmpl和*NetConfgTmpl在前面已經(jīng)出現(xiàn)，這里不重復(fù)胖替。
最后調(diào)用第三方函數(shù)cmn.MustWriteFile(configFilePath, []byte(selectNetwork(network)), 0644)研儒，把拼接出來(lái)的配置文件內(nèi)容以權(quán)限0644寫入到指定的文件地址。
到這里独令，我們這個(gè)問題就算回答完畢了端朵。
