但是如果我们面对的是一个像比原这样比较庞大的项目,身边又没有人指导,只能靠自己去看,这时应该怎么来阅读呢?也许每个人也都能找到自己的办法,或高效,或低效,或放弃。0 X4 c2 I9 r g. n) i
我在这次阅读比原源代码的过程中,尝试的是这样一种方法:从外部入手,通过与比原节点进行数据交互,来一步步了解比原的内部原理。就像剥石榴一样,一点点小心翼翼的下手,最后才能吃到鲜美的果肉。
所以这个文章系列叫作“剥开比原看代码”。
说明
在系列中的每一章,我通常都会由一个或者几个相关的问题入手,然后通过对源代码进行分析,来说明比原的代码是如何实现的。对于与当前问题关系不大的代码,则会简单带过,等真正需要它们出场的时候再详细解说。
为了保证文章中引用代码的稳定性,我将基于比原的v1.0.1代码进行分析。随着时间推移,比原的代码也将快速更新,但是我觉得,只要把这个版本的代码理解了,再去看新的代码,应该是一件很容易的事情。
在文章中,将会有一些直接指向github上bytom源代码的链接。为了方便,我专门将bytom v1.0.1的代码放到了一个新的仓库中,这样就不容易与比原官方的最新代码混淆。该仓库地址为:https://github.com/freewind/bytom-v1.0.1' i8 g- u) J; h. E$ A, I% Y( v
当然,你不必clone这个仓库(clone官方仓库http://github.com/Bytom/bytom就够了),然后在必要的时候,使用以下命令将代码切换到v1.0.1的tag,以便与本系列引用的代码一致:
git fetch
git checkout -b v1.0.1
不论采用哪种阅读方法,我想第一步都应该先在本地把比原节点跑起来,试试各种功能。- D) v" I6 F& T7 [2 M
对于如何下载、配置和安装的问题,请直接参看官方文档https://github.com/Bytom/bytom/tree/v1.0.1(注意我这里给出的是v1.0.1的文档),这里不多说。
本篇问题. v; K$ R8 i0 x( w5 @4 F1 d
当我们本地使用make bytomd编译完比原后,我们可以使用下面的命令来进行初始化:- @5 P% N# E b0 B2 q" F; r7 u
./bytomd init --chain_id testnet- q) r& S* O( l( s4 N
这里指定了使用的chain是testnet(还有别的选项,如mainnet等等)。运行成功后,它将会在本地文件系统生成一些配置文件,供比原启动时使用。
所以我的问题是:
比原初始化时,产生了什么样的配置文件,放在了哪个目录下?+ R7 _9 }! L/ O" V0 l
下面我将结合源代码,来回答这个问题。 d0 B0 W5 b2 d( H; e
目录位置
首先比原在本地会有一个目录专门用于放置各种数据,比如密钥、配置文件、数据库文件等。这个目录对应的代码位于config/config.go#L190-L205:- e5 m5 S7 q s5 [- T# z8 {% L
func DefaultDataDir() string {- E, D& A; ~$ k5 G" s4 r+ o J
// Try to place the data folder in the user's home dir
home := homeDir()
dataDir := "./.bytom") z4 K8 C( w* y& l" a
if home != "" {( x+ ~* r1 o3 m
switch runtime.GOOS {
case "darwin":+ R# C5 ~- H% Z+ Y4 D
dataDir = filepath.Join(home, "Library", "Bytom")+ k$ Z% Q0 a& g6 W9 k5 I
case "windows":; I& u2 Y8 k+ O( f1 o
dataDir = filepath.Join(home, "AppData", "Roaming", "Bytom")
default:; u @. @, z! `% l7 M7 s
dataDir = filepath.Join(home, ".bytom")
}
}
return dataDir. H( K( w2 d" m, r/ w$ g U% [; I
}- m1 a7 c# G: v
可以看到,在不同的操作系统上,数据目录的位置也不同:
配置文件内容
我们根据自己的操作系统打开相应的目录(我的是~/AppData/Roaming/Bytom),可以看到有一个config.toml,内容大约如下:* }1 |& |0 o- Q$ |3 o) ^2 H0 c
$ cat config.toml
# This is a TOML config file.
# For more information, see https://github.com/toml-lang/toml! u( k( E5 T9 w' @3 M0 l, c
fast_sync = true; f6 L: v. S1 O c( s
db_backend = "leveldb"
api_addr = "0.0.0.0:9888"
chain_id = "testnet"" d# G5 w: t6 p. W4 H& W
[p2p]
laddr = "tcp://0.0.0.0:46656"9 K0 B: A$ m/ @* m
seeds = "47.96.42.1:46656,172.104.224.219:46656,45.118.132.164:46656"3 L2 J: o) r" Q! M3 p
它已经把一些基本信息告诉我们了,比如:
内容模板! i1 w- C' D' q( O
使用不同的chain_id去初始化时,会生成不同内容的配置文件,那么这些内容来自于哪里呢?0 `; V# @4 U \1 \+ T: @% |# f
原来在config/toml.go#L22-L45,预定义了不同的模板内容:) L4 r' Y/ P9 ~% n4 }& ~
var defaultConfigTmpl = `# This is a TOML config file.! _; t5 a$ A) z* @& o$ C
# For more information, see https://github.com/toml-lang/toml+ H0 H+ P" B8 K. o: v
fast_sync = true
db_backend = "leveldb"; ^/ q0 m' B! V- y
api_addr = "0.0.0.0:9888"
`
var mainNetConfigTmpl = `chain_id = "mainnet"( h o- Y- j' B* P: w' c" l4 d
[p2p]
laddr = "tcp://0.0.0.0:46657"" i+ x5 l8 j0 I7 p1 H* a& O
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"7 a- t' O: }, d4 _4 [+ N
`
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", c) U& A, S; f' a; \: R
`9 T' m) y& a2 r) `4 l+ v
var soloNetConfigTmpl = `chain_id = "solonet"
[p2p]
laddr = "tcp://0.0.0.0:46658"" C. ~$ X! P: L1 M {; ~6 L
seeds = ""
`
可以看到,原来这些端口号和seed的地址,都是事先写好在模板里的。
而且,通过观察这些配置,我们可以发现,如果chain_id不同,则监听的端口和连接的种子都不同:
. G; E+ \7 `3 y1 a" t$ ]8 w
写入文件* e+ r" S8 E' C: s! H) I( h) {
这里我们需要快速的把bytomd init的执行流程过一遍,才能清楚配置文件的写入时机,也同时把前面的内容串在了一起。2 U9 p, D* \" j4 @; R8 ]# Y3 q7 D
首先,当我们运行bytomd init时,它对应的代码入口为cmd/bytomd/main.go#L54:
func main() {
cmd := cli.PrepareBaseCmd(commands.RootCmd, "TM", os.ExpandEnv(config.DefaultDataDir())); `1 R' h* A5 c8 c5 G
cmd.Execute()/ P' N- g6 L& V" z" W# S
}6 X/ E4 |0 m+ O5 {
其中的config.DefaultDataDir()就对应于前面提到数据目录位置。7 ?) G8 @# I& E# w& l+ } g. N
然后执行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) {. s5 E8 X9 g/ z3 P# @! o
log.WithField("config", configFilePath).Info("Already exists config file.")8 O( R A7 W. _. `- T
return, v" L/ a) B9 g& @% _4 O5 }/ H
}
if config.ChainID == "mainnet" {. S$ E* T7 p: y; x+ ~- Z) W
cfg.EnsureRoot(config.RootDir, "mainnet")
} else if config.ChainID == "testnet" {6 `; ^. H2 U1 e7 F& g
cfg.EnsureRoot(config.RootDir, "testnet")
} else {# e9 ?$ U: u) o; ?
cfg.EnsureRoot(config.RootDir, "solonet")
}
log.WithField("config", configFilePath).Info("Initialized bytom")# Z8 y6 K. e+ Y2 E R1 B/ t) t
}
其中的configFilePath,就是config.toml的写入地址,即我们前面所说的数据目录下的config.toml文件。2 s$ r S( c9 d q) a( `5 i
cfg.EnsureRoot将用来确认数据目录是有效的,并且将根据传入的chain_id不同,来生成不同的内容写入到配置文件中。4 c7 c( v* o4 j
它对应的代码是config/toml.go#L10
func EnsureRoot(rootDir string, network string) {
cmn.EnsureDir(rootDir, 0700)
cmn.EnsureDir(rootDir+"/data", 0700)3 C8 t% k. ^, U& e$ u r- j3 E1 I
configFilePath := path.Join(rootDir, "config.toml")
// Write default config file if missing.
if !cmn.FileExists(configFilePath) {
cmn.MustWriteFile(configFilePath, []byte(selectNetwork(network)), 0644)
}
}! u# o" F& {1 o" R; P2 e: Y
可以看到,它对数据目录进行了权限上的确认,并且发现当配置文件存在的时候,不会做任何更改。所以如果我们需要生成新的配置文件,就需要把旧的删除(或改名)。6 e0 c* @' b' Q! N) e# y
其中的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 {" \& k0 h& C T" p7 R, U; ~
return defaultConfigTmpl + soloNetConfigTmpl$ D. H: b0 K2 L2 Z9 w' I* K' e g
}) m6 F: `$ a2 I
}
果然就是一个简单的字符串拼接,其中的defaultConfigTmpl和*NetConfgTmpl在前面已经出现,这里不重复。
最后调用第三方函数cmn.MustWriteFile(configFilePath, []byte(selectNetwork(network)), 0644),把拼接出来的配置文件内容以权限0644写入到指定的文件地址。$ e) l9 \2 i7 F; k8 B
到这里,我们这个问题就算回答完毕了。
感谢社区用户Freewind的辛勤写作