但是如果我们面对的是一个像比原这样比较庞大的项目,身边又没有人指导,只能靠自己去看,这时应该怎么来阅读呢?也许每个人也都能找到自己的办法,或高效,或低效,或放弃。. h: u- w. ~, N' I1 K2 N
我在这次阅读比原源代码的过程中,尝试的是这样一种方法:从外部入手,通过与比原节点进行数据交互,来一步步了解比原的内部原理。就像剥石榴一样,一点点小心翼翼的下手,最后才能吃到鲜美的果肉。
所以这个文章系列叫作“剥开比原看代码”。% }; u" _" \. v$ }
说明
在系列中的每一章,我通常都会由一个或者几个相关的问题入手,然后通过对源代码进行分析,来说明比原的代码是如何实现的。对于与当前问题关系不大的代码,则会简单带过,等真正需要它们出场的时候再详细解说。
为了保证文章中引用代码的稳定性,我将基于比原的v1.0.1代码进行分析。随着时间推移,比原的代码也将快速更新,但是我觉得,只要把这个版本的代码理解了,再去看新的代码,应该是一件很容易的事情。3 t( J( o) j1 Q' X( W! i, s' u0 Z
在文章中,将会有一些直接指向github上bytom源代码的链接。为了方便,我专门将bytom v1.0.1的代码放到了一个新的仓库中,这样就不容易与比原官方的最新代码混淆。该仓库地址为:https://github.com/freewind/bytom-v1.0.19 T% r; v9 O) ]7 ?+ L
当然,你不必clone这个仓库(clone官方仓库http://github.com/Bytom/bytom就够了),然后在必要的时候,使用以下命令将代码切换到v1.0.1的tag,以便与本系列引用的代码一致:$ [* O. K3 e0 x4 o% Y
git fetch Z# ~: V- v' _5 j* B8 o1 Q1 ^6 V
git checkout -b v1.0.1
不论采用哪种阅读方法,我想第一步都应该先在本地把比原节点跑起来,试试各种功能。5 f) }+ M8 }( T4 e/ ?
对于如何下载、配置和安装的问题,请直接参看官方文档https://github.com/Bytom/bytom/tree/v1.0.1(注意我这里给出的是v1.0.1的文档),这里不多说。
本篇问题
当我们本地使用make bytomd编译完比原后,我们可以使用下面的命令来进行初始化:
./bytomd init --chain_id testnet
这里指定了使用的chain是testnet(还有别的选项,如mainnet等等)。运行成功后,它将会在本地文件系统生成一些配置文件,供比原启动时使用。& _& F i+ Z4 W* R
所以我的问题是:
比原初始化时,产生了什么样的配置文件,放在了哪个目录下?
下面我将结合源代码,来回答这个问题。% ]* J4 x; d7 u: I! T
目录位置
首先比原在本地会有一个目录专门用于放置各种数据,比如密钥、配置文件、数据库文件等。这个目录对应的代码位于config/config.go#L190-L205:8 Y/ w' T- v2 T
func DefaultDataDir() string {
// Try to place the data folder in the user's home dir ^0 d1 q* i. {% G" \0 F4 S
home := homeDir()
dataDir := "./.bytom"
if home != "" {
switch runtime.GOOS {7 Z' D. u& ^- r! G
case "darwin":1 Z( A! T. j5 F; U' O
dataDir = filepath.Join(home, "Library", "Bytom")
case "windows":
dataDir = filepath.Join(home, "AppData", "Roaming", "Bytom")
default:; q/ V# \8 @7 m
dataDir = filepath.Join(home, ".bytom")
}
}
return dataDir: u B( a) m" z. U& I: R
}
可以看到,在不同的操作系统上,数据目录的位置也不同:- a& b4 O8 ^' N* G7 ^
# f$ r; f/ v: L$ W! T
配置文件内容: s- l" P+ { L2 o" Z) G& m/ c
我们根据自己的操作系统打开相应的目录(我的是~/AppData/Roaming/Bytom),可以看到有一个config.toml,内容大约如下:
$ cat config.toml" k, [" f" J& \+ M8 p% y3 X1 L
# This is a TOML config file.
# For more information, see https://github.com/toml-lang/toml. \ D+ _9 c* I8 F7 r7 S; H
fast_sync = true# x2 G% l2 z" u {% O
db_backend = "leveldb"5 [2 N! b2 r) W1 @- f. T
api_addr = "0.0.0.0:9888"2 t+ x6 A/ N7 L! P
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"
它已经把一些基本信息告诉我们了,比如:
内容模板& S7 P2 U, C+ ~: t; U& U
使用不同的chain_id去初始化时,会生成不同内容的配置文件,那么这些内容来自于哪里呢?6 | ?4 J* |0 L
原来在config/toml.go#L22-L45,预定义了不同的模板内容:( D+ {/ C' f, {$ p: e) M, E
var defaultConfigTmpl = `# This is a TOML config file.
# For more information, see https://github.com/toml-lang/toml) B4 V4 T, F9 t( K% Y* t- e; w3 C
fast_sync = true9 O" O. a* [+ Z# n% q( B+ e% I
db_backend = "leveldb"; j6 q0 I3 B- |. z- [6 ^
api_addr = "0.0.0.0:9888"
`+ K/ B) a1 h) c0 T! A* m
var mainNetConfigTmpl = `chain_id = "mainnet"8 P* `2 ?6 z, K& _) E4 w! N# {, j
[p2p]
laddr = "tcp://0.0.0.0:46657"/ d6 A' g0 r1 n% Z) O7 X
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": i% R- s/ A7 g. w
`
var testNetConfigTmpl = `chain_id = "testnet"
[p2p]
laddr = "tcp://0.0.0.0:46656"+ O! R* C2 {, t9 b/ T6 `
seeds = "47.96.42.1:46656,172.104.224.219:46656,45.118.132.164:46656"
`8 u$ T& L2 @. H7 S' U0 W
var soloNetConfigTmpl = `chain_id = "solonet"
[p2p]
laddr = "tcp://0.0.0.0:46658"8 q+ l2 |: G& W6 `$ X5 h& H8 Q
seeds = ""
`8 g1 D! b6 H( n% U$ g
可以看到,原来这些端口号和seed的地址,都是事先写好在模板里的。% R& z4 H( L$ S- z8 k# A
而且,通过观察这些配置,我们可以发现,如果chain_id不同,则监听的端口和连接的种子都不同:
. ~0 s$ `- M, u: I
写入文件
这里我们需要快速的把bytomd init的执行流程过一遍,才能清楚配置文件的写入时机,也同时把前面的内容串在了一起。8 {0 g3 |0 }( M7 |
首先,当我们运行bytomd init时,它对应的代码入口为cmd/bytomd/main.go#L54:7 E/ K5 i5 V* F- t3 L. Z3 U
func main() {1 s; E3 ], e' x% f) G3 Q4 m* N
cmd := cli.PrepareBaseCmd(commands.RootCmd, "TM", os.ExpandEnv(config.DefaultDataDir()))
cmd.Execute(); A3 ]2 T; a! `+ k
}
其中的config.DefaultDataDir()就对应于前面提到数据目录位置。7 U8 F" R) v r0 z5 U9 X* R: o( x
然后执行cmd.Execute(),将根据传入的参数init,选择下面的函数来执行:cmd/bytomd/commands/init.go#L25-L24
func initFiles(cmd *cobra.Command, args []string) {' @, Y' v3 Q3 A0 U( @
configFilePath := path.Join(config.RootDir, "config.toml")
if _, err := os.Stat(configFilePath); !os.IsNotExist(err) {
log.WithField("config", configFilePath).Info("Already exists config file."). {2 I4 J+ i, n! R
return \- a' E" _5 L0 o1 C
}
if config.ChainID == "mainnet" {( Q5 t9 y, ]$ T9 O+ c& [% g
cfg.EnsureRoot(config.RootDir, "mainnet")# g" ?; I/ }7 F) k: ]
} else if config.ChainID == "testnet" {$ q1 {0 T/ P' g: I% A! H& i
cfg.EnsureRoot(config.RootDir, "testnet")( O e, ] W A) u& w
} else {
cfg.EnsureRoot(config.RootDir, "solonet")
}
log.WithField("config", configFilePath).Info("Initialized bytom")' ]: q# Y9 @5 i* w' X! G6 \
}
其中的configFilePath,就是config.toml的写入地址,即我们前面所说的数据目录下的config.toml文件。; q4 t$ C) N4 Z! t! M9 G s- b- |
cfg.EnsureRoot将用来确认数据目录是有效的,并且将根据传入的chain_id不同,来生成不同的内容写入到配置文件中。
它对应的代码是config/toml.go#L10+ e3 J) z- n) t: b2 Z0 ~/ ?' A
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) {. Y) I1 i9 U) R' x( s( }1 L
cmn.MustWriteFile(configFilePath, []byte(selectNetwork(network)), 0644)
}; A$ e+ d4 |( t
}, L/ z2 x3 j7 D \' s
可以看到,它对数据目录进行了权限上的确认,并且发现当配置文件存在的时候,不会做任何更改。所以如果我们需要生成新的配置文件,就需要把旧的删除(或改名)。
其中的selectNetwork(network)函数,实现了根据chain_id的不同来组装不同的配置文件内容,它对应于master/config/toml.go#L48: L# x+ S& }/ d5 i5 u
func selectNetwork(network string) string {# U2 |; b4 T' s' [) K" H
if network == "testnet" {
return defaultConfigTmpl + testNetConfigTmpl/ j% d- ~9 N: w0 w& x7 W/ }
} else if network == "mainnet" {6 \7 _' t% Q! q) f" Q( M. [% N, e% B
return defaultConfigTmpl + mainNetConfigTmpl
} else {1 A% _0 K5 u& _/ T6 J
return defaultConfigTmpl + soloNetConfigTmpl
}
}* d, Q* q+ s3 ~( C Q3 O5 C
果然就是一个简单的字符串拼接,其中的defaultConfigTmpl和*NetConfgTmpl在前面已经出现,这里不重复。7 M, R, b& G2 ~) M/ H/ e% d# [
最后调用第三方函数cmn.MustWriteFile(configFilePath, []byte(selectNetwork(network)), 0644),把拼接出来的配置文件内容以权限0644写入到指定的文件地址。$ m( V" V/ F3 B, }- D
到这里,我们这个问题就算回答完毕了。9 K6 g M% ]4 [* W) a F' P
感谢社区用户Freewind的辛勤写作