但是如果我们面对的是一个像比原这样比较庞大的项目,身边又没有人指导,只能靠自己去看,这时应该怎么来阅读呢?也许每个人也都能找到自己的办法,或高效,或低效,或放弃。7 r; ~6 n8 y% f3 R8 l4 q' ]! w
我在这次阅读比原源代码的过程中,尝试的是这样一种方法:从外部入手,通过与比原节点进行数据交互,来一步步了解比原的内部原理。就像剥石榴一样,一点点小心翼翼的下手,最后才能吃到鲜美的果肉。) o8 e9 _1 W: `- G. V) {6 v
所以这个文章系列叫作“剥开比原看代码”。
说明% e7 a8 e6 {5 h) @; @/ s
在系列中的每一章,我通常都会由一个或者几个相关的问题入手,然后通过对源代码进行分析,来说明比原的代码是如何实现的。对于与当前问题关系不大的代码,则会简单带过,等真正需要它们出场的时候再详细解说。* j% d! q' i& H* n7 ^$ @& C, z
为了保证文章中引用代码的稳定性,我将基于比原的v1.0.1代码进行分析。随着时间推移,比原的代码也将快速更新,但是我觉得,只要把这个版本的代码理解了,再去看新的代码,应该是一件很容易的事情。- r6 F! L: W+ T9 u
在文章中,将会有一些直接指向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. J z N7 C! d& b( Q# m
不论采用哪种阅读方法,我想第一步都应该先在本地把比原节点跑起来,试试各种功能。
对于如何下载、配置和安装的问题,请直接参看官方文档https://github.com/Bytom/bytom/tree/v1.0.1(注意我这里给出的是v1.0.1的文档),这里不多说。$ L7 }. Y4 d" c% m3 Q u3 f
本篇问题
当我们本地使用make bytomd编译完比原后,我们可以使用下面的命令来进行初始化:. A% p4 ?3 E2 V5 x' P
./bytomd init --chain_id testnet
这里指定了使用的chain是testnet(还有别的选项,如mainnet等等)。运行成功后,它将会在本地文件系统生成一些配置文件,供比原启动时使用。* a' W$ \2 P' y) i
所以我的问题是:
比原初始化时,产生了什么样的配置文件,放在了哪个目录下?/ D/ q0 ^$ k' B$ V d
下面我将结合源代码,来回答这个问题。
目录位置! P9 M1 u$ w$ X7 C; U9 H
首先比原在本地会有一个目录专门用于放置各种数据,比如密钥、配置文件、数据库文件等。这个目录对应的代码位于config/config.go#L190-L205:
func DefaultDataDir() string {* M. Q0 j! {1 l A' ], c. M c! K
// Try to place the data folder in the user's home dir
home := homeDir()
dataDir := "./.bytom"
if home != "" {5 ^9 z3 C# f" E" A' O
switch runtime.GOOS {
case "darwin":2 k+ t8 [. N W
dataDir = filepath.Join(home, "Library", "Bytom")8 H8 K \0 c/ f2 j
case "windows":# U4 b; s) b; _
dataDir = filepath.Join(home, "AppData", "Roaming", "Bytom")
default:
dataDir = filepath.Join(home, ".bytom")
}
}
return dataDir" p& Y+ w6 w5 l6 k
}
可以看到,在不同的操作系统上,数据目录的位置也不同:% |2 i s, h8 G4 R- ~3 ~
配置文件内容( B1 a( Z; _7 {( m# b: O' n7 E
我们根据自己的操作系统打开相应的目录(我的是~/AppData/Roaming/Bytom),可以看到有一个config.toml,内容大约如下:% H' s% u+ G: E, O* h# Y
$ cat config.toml
# This is a TOML config file.; @8 o5 ]! h# D% f; a' b
# For more information, see https://github.com/toml-lang/toml
fast_sync = true4 F6 _$ g o& t* P3 K, G
db_backend = "leveldb"
api_addr = "0.0.0.0:9888". m% U* \, J8 E
chain_id = "testnet"
[p2p]5 T# q. A+ t/ E* _' |5 y
laddr = "tcp://0.0.0.0:46656"7 a) S3 L$ R8 m' @! Q
seeds = "47.96.42.1:46656,172.104.224.219:46656,45.118.132.164:46656"( E( O9 z' {) A. ~, U( P$ g
它已经把一些基本信息告诉我们了,比如:9 q1 h: e$ L. m" q9 b% L: k3 u
内容模板% h7 i) B3 j; y; ^+ ]
使用不同的chain_id去初始化时,会生成不同内容的配置文件,那么这些内容来自于哪里呢?0 K. B" Q4 X2 X- Z$ [: R
原来在config/toml.go#L22-L45,预定义了不同的模板内容:" D+ p0 f1 j8 [5 b
var defaultConfigTmpl = `# This is a TOML config file.
# For more information, see https://github.com/toml-lang/toml/ Q, k8 ^, Q: y4 e. k9 t% h5 Y
fast_sync = true0 j5 J/ g# O* }
db_backend = "leveldb"5 J3 S1 q& b9 Z& P* S( B' e3 ~" k6 Y
api_addr = "0.0.0.0:9888"2 {4 y3 o9 s( n
`& w1 f4 D9 p% W( y. p( I* J9 J
var mainNetConfigTmpl = `chain_id = "mainnet"( u, P* H. W$ R3 r9 ]0 \" e
[p2p]* U2 R# `, ^2 j" Q0 K8 h- X3 z- p
laddr = "tcp://0.0.0.0:46657" n/ r3 n' S' W) b
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"- ^, W& W4 F, ]( P7 W0 R
`
var testNetConfigTmpl = `chain_id = "testnet"
[p2p]
laddr = "tcp://0.0.0.0:46656"& N7 p9 W. n. k! e1 f
seeds = "47.96.42.1:46656,172.104.224.219:46656,45.118.132.164:46656"* Q; e( M6 K+ q6 e- f
`: P- S' P" F4 e' \! P" E( t
var soloNetConfigTmpl = `chain_id = "solonet"3 K( q! K- V. l* Y0 B
[p2p]
laddr = "tcp://0.0.0.0:46658"7 t" ~- s5 R4 t4 X. k4 t; H1 I# L& A
seeds = ""4 V5 X: y. d H- N( T* v
`( J% ]% D0 T/ }+ u* [7 E
可以看到,原来这些端口号和seed的地址,都是事先写好在模板里的。: I! w. n) t+ ~3 _4 \. M: ?) @
而且,通过观察这些配置,我们可以发现,如果chain_id不同,则监听的端口和连接的种子都不同:( s% X# T# R" F; l4 M
( E- T% D0 o7 _
写入文件
这里我们需要快速的把bytomd init的执行流程过一遍,才能清楚配置文件的写入时机,也同时把前面的内容串在了一起。! o# b" V/ Z# T5 e/ K8 j [
首先,当我们运行bytomd init时,它对应的代码入口为cmd/bytomd/main.go#L54:
func main() {
cmd := cli.PrepareBaseCmd(commands.RootCmd, "TM", os.ExpandEnv(config.DefaultDataDir()))
cmd.Execute()$ u, n# P1 A3 g: A$ g+ [
}
其中的config.DefaultDataDir()就对应于前面提到数据目录位置。
然后执行cmd.Execute(),将根据传入的参数init,选择下面的函数来执行:cmd/bytomd/commands/init.go#L25-L24
func initFiles(cmd *cobra.Command, args []string) {" a" I6 r& a0 e9 u2 L
configFilePath := path.Join(config.RootDir, "config.toml"), S x% d+ {( B) c5 v1 [$ B
if _, err := os.Stat(configFilePath); !os.IsNotExist(err) {
log.WithField("config", configFilePath).Info("Already exists config file.")$ P( b/ C: X$ y' X( f
return' H3 v8 e$ e! b
}- f9 X5 |& `" m. z2 }* v. I
if config.ChainID == "mainnet" {7 b8 \$ b8 @6 `; V4 I$ k- D0 s
cfg.EnsureRoot(config.RootDir, "mainnet"). Z7 M7 j, Z* P4 R
} else if config.ChainID == "testnet" {
cfg.EnsureRoot(config.RootDir, "testnet")
} else {- D; r+ z4 v$ o! K
cfg.EnsureRoot(config.RootDir, "solonet")
}, o+ m" O2 v2 C; f4 f- O1 h
log.WithField("config", configFilePath).Info("Initialized bytom")( u0 F2 z+ r& B
}
其中的configFilePath,就是config.toml的写入地址,即我们前面所说的数据目录下的config.toml文件。
cfg.EnsureRoot将用来确认数据目录是有效的,并且将根据传入的chain_id不同,来生成不同的内容写入到配置文件中。1 y$ F' ?5 s6 E3 O2 ~
它对应的代码是config/toml.go#L10
func EnsureRoot(rootDir string, network string) {+ Q9 O7 Y5 v5 m0 ~
cmn.EnsureDir(rootDir, 0700)$ K* k, R: _9 c4 v% U
cmn.EnsureDir(rootDir+"/data", 0700)* H0 X1 F t/ D0 p d% B" E
configFilePath := path.Join(rootDir, "config.toml")
// Write default config file if missing.
if !cmn.FileExists(configFilePath) {- o Q0 ]$ q* v' v& f9 ]2 o
cmn.MustWriteFile(configFilePath, []byte(selectNetwork(network)), 0644). i+ a) J5 B9 e2 `# G: g A
}
}
可以看到,它对数据目录进行了权限上的确认,并且发现当配置文件存在的时候,不会做任何更改。所以如果我们需要生成新的配置文件,就需要把旧的删除(或改名)。. A9 I) n8 } A8 q! J9 C4 U/ B
其中的selectNetwork(network)函数,实现了根据chain_id的不同来组装不同的配置文件内容,它对应于master/config/toml.go#L48:! e+ @0 Q. k6 E3 A1 m
func selectNetwork(network string) string {
if network == "testnet" {8 F# L* N" C. t4 l( e8 ~ R6 v) M
return defaultConfigTmpl + testNetConfigTmpl6 k. `1 n; c! i8 ]0 S
} else if network == "mainnet" {
return defaultConfigTmpl + mainNetConfigTmpl
} else {
return defaultConfigTmpl + soloNetConfigTmpl
}
}
果然就是一个简单的字符串拼接,其中的defaultConfigTmpl和*NetConfgTmpl在前面已经出现,这里不重复。& }+ a! g2 q, L9 g
最后调用第三方函数cmn.MustWriteFile(configFilePath, []byte(selectNetwork(network)), 0644),把拼接出来的配置文件内容以权限0644写入到指定的文件地址。
到这里,我们这个问题就算回答完毕了。
感谢社区用户Freewind的辛勤写作