但是如果我们面对的是一个像比原这样比较庞大的项目,身边又没有人指导,只能靠自己去看,这时应该怎么来阅读呢?也许每个人也都能找到自己的办法,或高效,或低效,或放弃。) H( J& n* O9 b6 z
我在这次阅读比原源代码的过程中,尝试的是这样一种方法:从外部入手,通过与比原节点进行数据交互,来一步步了解比原的内部原理。就像剥石榴一样,一点点小心翼翼的下手,最后才能吃到鲜美的果肉。3 o6 w2 n& l& D, I: w2 v
所以这个文章系列叫作“剥开比原看代码”。5 i2 T( `; j( X" F2 B) \6 g
说明 X2 W, |5 y& i! b" R
在系列中的每一章,我通常都会由一个或者几个相关的问题入手,然后通过对源代码进行分析,来说明比原的代码是如何实现的。对于与当前问题关系不大的代码,则会简单带过,等真正需要它们出场的时候再详细解说。
为了保证文章中引用代码的稳定性,我将基于比原的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 L S% l3 X2 V# ]
git checkout -b v1.0.1( s4 _+ @3 ^0 o6 V& D6 l5 C
不论采用哪种阅读方法,我想第一步都应该先在本地把比原节点跑起来,试试各种功能。
对于如何下载、配置和安装的问题,请直接参看官方文档https://github.com/Bytom/bytom/tree/v1.0.1(注意我这里给出的是v1.0.1的文档),这里不多说。# O1 v* [2 ?- P7 S* w
本篇问题; N* z6 v7 G0 Z, ]+ H8 @
当我们本地使用make bytomd编译完比原后,我们可以使用下面的命令来进行初始化:% G0 H1 |+ F0 g+ o" a( b, W
./bytomd init --chain_id testnet' D, n! q4 T( G# W: C& i
这里指定了使用的chain是testnet(还有别的选项,如mainnet等等)。运行成功后,它将会在本地文件系统生成一些配置文件,供比原启动时使用。
所以我的问题是:
比原初始化时,产生了什么样的配置文件,放在了哪个目录下?" }6 d, |/ c+ U1 r* J- d
下面我将结合源代码,来回答这个问题。
目录位置1 f! R) y( |! O2 O8 }0 `7 C
首先比原在本地会有一个目录专门用于放置各种数据,比如密钥、配置文件、数据库文件等。这个目录对应的代码位于config/config.go#L190-L205:0 W! |7 A' p3 o m* k
func DefaultDataDir() string {1 H, }( c+ U8 ?+ }' s# n7 E" ?
// Try to place the data folder in the user's home dir; v% {/ {; _( R! j# a
home := homeDir()
dataDir := "./.bytom"
if home != "" {5 {7 x. H! e4 Y, W2 l+ r0 ]5 _
switch runtime.GOOS {3 h: r$ {5 x) o* {7 m# H( y
case "darwin":' i. R- X+ i8 |9 W
dataDir = filepath.Join(home, "Library", "Bytom"), i2 H a0 v0 W* a2 V" R
case "windows":
dataDir = filepath.Join(home, "AppData", "Roaming", "Bytom")
default:
dataDir = filepath.Join(home, ".bytom")
}2 A+ U0 y8 j* L! Q% V7 z% P! s' C: o0 o
}7 h, x" H2 `% O
return dataDir
}
可以看到,在不同的操作系统上,数据目录的位置也不同:; R) s1 x7 p6 M3 ?- P* o7 w6 R
配置文件内容4 r3 _; y3 o+ }# s1 p5 A
我们根据自己的操作系统打开相应的目录(我的是~/AppData/Roaming/Bytom),可以看到有一个config.toml,内容大约如下:- D" [5 K$ Y; R$ S6 }" b1 ?
$ cat config.toml: F" n4 X# g+ |. @: r" q
# This is a TOML config file.
# For more information, see https://github.com/toml-lang/toml6 n, R, T; i! O, ^. z' r: k
fast_sync = true
db_backend = "leveldb"
api_addr = "0.0.0.0:9888"
chain_id = "testnet"
[p2p]0 j1 j" A9 D0 u& I W
laddr = "tcp://0.0.0.0:46656"
seeds = "47.96.42.1:46656,172.104.224.219:46656,45.118.132.164:46656"! Z; V: |4 r( `4 {/ {
它已经把一些基本信息告诉我们了,比如:
内容模板( Q, y5 V% L7 B7 P, E3 `
使用不同的chain_id去初始化时,会生成不同内容的配置文件,那么这些内容来自于哪里呢?! t+ Y! p+ E! i, B
原来在config/toml.go#L22-L45,预定义了不同的模板内容:& h9 R( ?$ j" `. E
var defaultConfigTmpl = `# This is a TOML config file.
# For more information, see https://github.com/toml-lang/toml
fast_sync = true5 y W- W7 `# @; c1 ^9 C
db_backend = "leveldb", ~4 J8 O4 H4 M) N. k4 Z3 b
api_addr = "0.0.0.0:9888"9 ~6 x/ L6 m' B4 P: \' E: ]8 L
`" k \% ]; I+ d2 T
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": J+ V% L3 S; Y- D* r
`
var testNetConfigTmpl = `chain_id = "testnet") ^) P" ?: V& E2 N7 S
[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"4 A5 s/ L) i j
[p2p]( r; u' Y) l# r) x( J, q ?: O
laddr = "tcp://0.0.0.0:46658"
seeds = ""
`5 Y/ o ?! v, o' s6 h) @9 }2 F6 J
可以看到,原来这些端口号和seed的地址,都是事先写好在模板里的。
而且,通过观察这些配置,我们可以发现,如果chain_id不同,则监听的端口和连接的种子都不同:
; s; n1 h- x! o# x" }0 \6 m: L
写入文件' ~/ y# X* a' S! b
这里我们需要快速的把bytomd init的执行流程过一遍,才能清楚配置文件的写入时机,也同时把前面的内容串在了一起。8 p9 r) D. B7 `9 h
首先,当我们运行bytomd init时,它对应的代码入口为cmd/bytomd/main.go#L54:& ^+ Q" _' R/ L( T0 \' G
func main() {# C9 L4 A8 G* M* J; |
cmd := cli.PrepareBaseCmd(commands.RootCmd, "TM", os.ExpandEnv(config.DefaultDataDir()))
cmd.Execute()
}
其中的config.DefaultDataDir()就对应于前面提到数据目录位置。4 d; F/ e! f- m+ w1 N6 P6 @& y# M
然后执行cmd.Execute(),将根据传入的参数init,选择下面的函数来执行:cmd/bytomd/commands/init.go#L25-L24
func initFiles(cmd *cobra.Command, args []string) {& X& s6 s2 O1 B1 R7 A
configFilePath := path.Join(config.RootDir, "config.toml")
if _, err := os.Stat(configFilePath); !os.IsNotExist(err) {
log.WithField("config", configFilePath).Info("Already exists config file.")4 ^* \) y% H; f- k7 @' O1 t
return v% [4 t. T4 Y7 D3 d
}
if config.ChainID == "mainnet" {
cfg.EnsureRoot(config.RootDir, "mainnet")
} else if config.ChainID == "testnet" {
cfg.EnsureRoot(config.RootDir, "testnet")7 }1 ?# L) ~* w2 j5 x% W1 O- X
} else {& V$ }: X. G, g6 ~9 q
cfg.EnsureRoot(config.RootDir, "solonet")
}
log.WithField("config", configFilePath).Info("Initialized bytom")- @1 S) x, k! W* f+ j
}
其中的configFilePath,就是config.toml的写入地址,即我们前面所说的数据目录下的config.toml文件。- I) {" V6 j8 z e& @$ ?; u' {
cfg.EnsureRoot将用来确认数据目录是有效的,并且将根据传入的chain_id不同,来生成不同的内容写入到配置文件中。* i5 `5 G7 ^, _
它对应的代码是config/toml.go#L10% W" p. F( H. F2 c, ]! z
func EnsureRoot(rootDir string, network string) {
cmn.EnsureDir(rootDir, 0700)6 p( X4 b0 `8 G9 H
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)- V. X. h6 z1 A+ N; Y" z6 n
}
}' R9 r9 b/ L# P# U: C
可以看到,它对数据目录进行了权限上的确认,并且发现当配置文件存在的时候,不会做任何更改。所以如果我们需要生成新的配置文件,就需要把旧的删除(或改名)。
其中的selectNetwork(network)函数,实现了根据chain_id的不同来组装不同的配置文件内容,它对应于master/config/toml.go#L48:
func selectNetwork(network string) string {
if network == "testnet" {
return defaultConfigTmpl + testNetConfigTmpl: h) j# x+ A* i L o6 w; ?
} else if network == "mainnet" {
return defaultConfigTmpl + mainNetConfigTmpl% {- G$ V+ L |* q
} else {: c7 b$ [9 H) J% e7 [5 x. d
return defaultConfigTmpl + soloNetConfigTmpl
}
}
果然就是一个简单的字符串拼接,其中的defaultConfigTmpl和*NetConfgTmpl在前面已经出现,这里不重复。
最后调用第三方函数cmn.MustWriteFile(configFilePath, []byte(selectNetwork(network)), 0644),把拼接出来的配置文件内容以权限0644写入到指定的文件地址。
到这里,我们这个问题就算回答完毕了。
感谢社区用户Freewind的辛勤写作