Hi 游客

更多精彩,请登录!

比特池塘 区块链技术 正文
人们常说,“阅读源代码”是学习编程的一种重要方法。作为程序员,我们在平时的学习工作中,都应该阅读过不少源代码。但是对于大多数人来说,阅读的可能更多是一些代码片断、示例,或者在老师、同事的指导下,先对要阅读的项目代码有了整体的了解之后,再进行针对性的阅读。# d/ S3 X+ `  W- |; x& |
但是如果我们面对的是一个像比原这样比较庞大的项目,身边又没有人指导,只能靠自己去看,这时应该怎么来阅读呢?也许每个人也都能找到自己的办法,或高效,或低效,或放弃。, e% j0 k9 ~, t6 b
我在这次阅读比原源代码的过程中,尝试的是这样一种方法:从外部入手,通过与比原节点进行数据交互,来一步步了解比原的内部原理。就像剥石榴一样,一点点小心翼翼的下手,最后才能吃到鲜美的果肉。
& P2 z2 ^! o. a1 F' |3 G: d, i所以这个文章系列叫作“剥开比原看代码”。
" i" q8 d/ `8 u& ~. D& e说明( Y8 i) Y" ^( u" n' ]: x
在系列中的每一章,我通常都会由一个或者几个相关的问题入手,然后通过对源代码进行分析,来说明比原的代码是如何实现的。对于与当前问题关系不大的代码,则会简单带过,等真正需要它们出场的时候再详细解说。# a3 x' ], T  t' `, q" k
为了保证文章中引用代码的稳定性,我将基于比原的v1.0.1代码进行分析。随着时间推移,比原的代码也将快速更新,但是我觉得,只要把这个版本的代码理解了,再去看新的代码,应该是一件很容易的事情。
: W* Z" Z% q; G# b4 t9 v- ~! h在文章中,将会有一些直接指向github上bytom源代码的链接。为了方便,我专门将bytom v1.0.1的代码放到了一个新的仓库中,这样就不容易与比原官方的最新代码混淆。该仓库地址为:https://github.com/freewind/bytom-v1.0.1
' T$ ?- J5 W3 T0 A2 |当然,你不必clone这个仓库(clone官方仓库http://github.com/Bytom/bytom就够了),然后在必要的时候,使用以下命令将代码切换到v1.0.1的tag,以便与本系列引用的代码一致:
1 S' B  A5 B( y( _( [6 f; ]6 mgit fetch  k4 z% P6 R* W
git checkout -b v1.0.10 C/ u' T" @+ w
不论采用哪种阅读方法,我想第一步都应该先在本地把比原节点跑起来,试试各种功能。7 x1 {+ B7 ]) {( K+ ~. j
对于如何下载、配置和安装的问题,请直接参看官方文档https://github.com/Bytom/bytom/tree/v1.0.1(注意我这里给出的是v1.0.1的文档),这里不多说。
$ S, W  t1 a* C8 L& h本篇问题9 A" V" v. {% B! ?
当我们本地使用make bytomd编译完比原后,我们可以使用下面的命令来进行初始化:0 w1 W3 C3 u# [5 U
./bytomd init --chain_id testnet8 W5 n" B8 Y% S3 ?! f) N/ S  X$ ^
这里指定了使用的chain是testnet(还有别的选项,如mainnet等等)。运行成功后,它将会在本地文件系统生成一些配置文件,供比原启动时使用。4 A/ a+ s7 j6 {
所以我的问题是:
1 N5 C+ }1 K6 k; u比原初始化时,产生了什么样的配置文件,放在了哪个目录下?
' ~/ T  ]5 _! d下面我将结合源代码,来回答这个问题。
$ n+ J& c# r3 U目录位置
6 m, x* b& b7 c0 t" z5 T( K首先比原在本地会有一个目录专门用于放置各种数据,比如密钥、配置文件、数据库文件等。这个目录对应的代码位于config/config.go#L190-L205:
3 K( Z; k  ?) `8 B! S0 efunc DefaultDataDir() string {! ^4 r( p8 z: d2 D0 y3 E. r
    // Try to place the data folder in the user's home dir4 l, O& ^1 W; w% B. c+ ]
    home := homeDir()
# V2 C# I! ~& H' m6 c2 N; S/ M    dataDir := "./.bytom"
5 V( D9 ^" v. H( l$ _    if home != "" {
, B- V. a/ ~' u+ S( ~; G0 Y        switch runtime.GOOS {
1 p8 @% F# i9 {# i- `$ q        case "darwin":8 [" {7 t5 e* U! z9 }6 D
            dataDir = filepath.Join(home, "Library", "Bytom")
( ?9 u. A4 E" Y        case "windows":  h1 V% [. |/ ]  R( \
            dataDir = filepath.Join(home, "AppData", "Roaming", "Bytom")9 z, Z% C5 h! W0 |" `6 J
        default:
$ R4 S% G- ~8 g            dataDir = filepath.Join(home, ".bytom")
) }* H9 o3 e+ F; @+ V8 a        }: z5 a6 Q4 G6 W: D7 E3 O
    }( N4 V0 x+ a9 U
    return dataDir
- F% t6 N( w* K- P% y( m}
& s8 f4 `' x4 V( E) m; ?可以看到,在不同的操作系统上,数据目录的位置也不同:
7 y7 B7 [1 C7 W. ?, L! v& S+ m3 m& N
  • 苹果系统(darwin):~/Library/Bytom
  • Windows(windows): ~/AppData/Roaming/Bytom
  • 其它(如Linux):~/.bytom
    9 B7 _$ |+ t  [0 V
    $ m1 s7 C$ M7 e% S& T0 I4 J) ]- Y$ V配置文件内容3 R$ a9 U; B  A( q0 Z8 C1 u3 Y: _) x* {
    我们根据自己的操作系统打开相应的目录(我的是~/AppData/Roaming/Bytom),可以看到有一个config.toml,内容大约如下:  E5 i8 B9 k/ q! m6 X
    $ cat config.toml
    % ?& N# _% R9 r) Y$ N' @# This is a TOML config file.
    + w* P9 r$ {- m. p# For more information, see https://github.com/toml-lang/toml
    : t$ R& A8 c) @8 V5 p# afast_sync = true5 Y: m- n- u2 j6 g$ f( v' \1 r
    db_backend = "leveldb"1 D& ]+ b" ?8 |" m. E
    api_addr = "0.0.0.0:9888"# t& l' T0 Y! V
    chain_id = "testnet"5 q% J. I: J& U3 N* G
    [p2p]4 g9 j# K; t: H3 `" S. c
    laddr = "tcp://0.0.0.0:46656"
    2 b+ e& I  h& y; Z: Tseeds = "47.96.42.1:46656,172.104.224.219:46656,45.118.132.164:46656"
    2 ?! S! ?: z: i# J4 [8 E+ J3 P它已经把一些基本信息告诉我们了,比如:
    5 O0 V2 j& l. {/ J4 u0 M
  • db_backend = "leveldb":说明比原内部使用了leveldb作为数据库(用来保存块数据、帐号、交易信息等)
  • api_addr = "0.0.0.0:9888":我们可以在浏览器中打开http://localhost:9888来访问dashboard页面,进行查看与管理
  • chain_id = "testnet":当前连接的是testnet,即测试网,里面挖出来的比原币是不值钱的
  • laddr = "tcp://0.0.0.0:46656":本地监听46656端口,别的节点如果想连我,就需要访问我的46656端口
  • seeds = "47.96.42.1:46656,172.104.224.219:46656,45.118.132.164:46656":比原启动后,会主动连接这几个地址获取数据3 O: B1 n4 ?9 f4 T! ~; ^% ?

    # m/ s7 B8 {- ^( E! Y内容模板
    5 \& [1 K( ?- x使用不同的chain_id去初始化时,会生成不同内容的配置文件,那么这些内容来自于哪里呢?6 d$ d7 d2 u6 p
    原来在config/toml.go#L22-L45,预定义了不同的模板内容:
    4 I) _- L) {& [* `. r9 g2 y/ R8 `var defaultConfigTmpl = `# This is a TOML config file.
    ' d7 B) t% e* G6 P! N1 E' K# For more information, see https://github.com/toml-lang/toml4 T% _1 S/ F4 E/ j
    fast_sync = true) m4 [) a8 A3 F: b4 ^) O- U
    db_backend = "leveldb"7 h1 z$ o1 {3 E" u+ |
    api_addr = "0.0.0.0:9888"( X9 a; i3 z( _% f0 ]
    `+ ~- r! C: Q$ z* w0 f0 o% d
    var mainNetConfigTmpl = `chain_id = "mainnet"9 c2 ~0 I" x7 X6 M7 C3 E
    [p2p]6 L; m- [3 f0 @9 X% X  j/ W
    laddr = "tcp://0.0.0.0:46657"' j/ R# u$ ~3 i
    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"
      b2 M' x  Z1 T, `9 u* E1 ?; N! ]; ~`$ x+ M3 I( |+ C3 y: f
    var testNetConfigTmpl = `chain_id = "testnet"7 ]4 B% d  s8 W2 e! e- q+ u
    [p2p]& u$ j+ S6 M* K/ j* |( Y( G
    laddr = "tcp://0.0.0.0:46656"& E/ K6 a, p  P  b% Z& R- G- s4 n
    seeds = "47.96.42.1:46656,172.104.224.219:46656,45.118.132.164:46656"
    " I' b& Z) i" B* Z, b`6 o3 s8 h5 H4 m# m! ^" ]3 J
    var soloNetConfigTmpl = `chain_id = "solonet") b/ R0 k' Q* N4 w6 i
    [p2p]
    9 L/ J$ r5 `; Y+ mladdr = "tcp://0.0.0.0:46658"! Q: o) y2 R3 {
    seeds = ""5 l! a# u4 D5 c$ u5 F7 I, }
    `
    . R$ h0 A' E) D, o7 k& r可以看到,原来这些端口号和seed的地址,都是事先写好在模板里的。! B, h) J  ^5 |
    而且,通过观察这些配置,我们可以发现,如果chain_id不同,则监听的端口和连接的种子都不同:! E" I" H" Z/ L; L
  • mainnet(连接到主网): 46657,会主动连接6个种子
  • testnet(连接到测试网): 46656,会主动连接3个种子
  • solonet(本地单独节点): 46658,不会主动连接别人(也因此不会被别人连接上),适合单机研究
    0 I+ ^8 [5 d0 E) H0 K: v/ }- A% ?. |1 }5 b
    写入文件- t3 u6 P; }) a; n3 D
    这里我们需要快速的把bytomd init的执行流程过一遍,才能清楚配置文件的写入时机,也同时把前面的内容串在了一起。/ j( |# F2 S+ Q4 |# ?, X/ G
    首先,当我们运行bytomd init时,它对应的代码入口为cmd/bytomd/main.go#L54:
    . x+ X9 }7 V( Wfunc main() {
    9 Q/ s5 A$ ]! q# n6 F- o    cmd := cli.PrepareBaseCmd(commands.RootCmd, "TM", os.ExpandEnv(config.DefaultDataDir()))
    ; ^7 K- F6 `, L0 o( b4 W    cmd.Execute()
    ) A" x( Y* }  J7 n! [$ G}- _6 x: h, N% i7 Y! B) l
    其中的config.DefaultDataDir()就对应于前面提到数据目录位置。, o5 T0 y  ]$ E1 v  z
    然后执行cmd.Execute(),将根据传入的参数init,选择下面的函数来执行:cmd/bytomd/commands/init.go#L25-L24
    3 t1 {1 Z* v6 E) L) t0 Qfunc initFiles(cmd *cobra.Command, args []string) {
    ; r, |+ M$ D5 l6 v" _    configFilePath := path.Join(config.RootDir, "config.toml")
    8 F) }5 z: ^; g    if _, err := os.Stat(configFilePath); !os.IsNotExist(err) {
    ; h( o! s% \4 M' q        log.WithField("config", configFilePath).Info("Already exists config file.")2 D0 @- J& i1 }% P4 j  \
            return
    . K8 M! w0 |7 B$ `* Z" }    }
    9 Q" B% u  D, f    if config.ChainID == "mainnet" {
    2 Q# w$ R+ g$ L0 q4 F        cfg.EnsureRoot(config.RootDir, "mainnet")  D: e; g4 g" F, |! D( C0 l0 G
        } else if config.ChainID == "testnet" {) Z' ]% }  l1 c7 j4 w4 o8 p3 p" k6 q
            cfg.EnsureRoot(config.RootDir, "testnet"). ^. \3 e- \' N, D7 k+ D( k7 ^( V
        } else {& u5 U6 J0 I; s6 |, x3 J: W
            cfg.EnsureRoot(config.RootDir, "solonet")
    % l# v6 A. N) ?' q% U    }7 d9 @, G3 H  x
        log.WithField("config", configFilePath).Info("Initialized bytom")5 r4 Y2 H1 o. W9 j
    }
    , j" R  I) t6 _# f( d其中的configFilePath,就是config.toml的写入地址,即我们前面所说的数据目录下的config.toml文件。! }4 b% X& S$ Q  T. w4 B
    cfg.EnsureRoot将用来确认数据目录是有效的,并且将根据传入的chain_id不同,来生成不同的内容写入到配置文件中。
    $ o% W) S$ `' H它对应的代码是config/toml.go#L10) _8 n7 r$ H! k# `6 K$ t' P
    func EnsureRoot(rootDir string, network string) {
    : W# w1 i( n( y, W- G8 f4 D    cmn.EnsureDir(rootDir, 0700), Y& }0 e5 d( {- T6 ~' X. w
        cmn.EnsureDir(rootDir+"/data", 0700)
    " s/ l' P( |, W# R# j    configFilePath := path.Join(rootDir, "config.toml")1 p" j  v7 f  ?% Y& B. G5 F+ Q
        // Write default config file if missing.
    7 ^1 n8 K* N, _3 n7 r2 }    if !cmn.FileExists(configFilePath) {# r0 f- O# [" R9 x, h' H
            cmn.MustWriteFile(configFilePath, []byte(selectNetwork(network)), 0644)
    9 E9 H! a  H3 q) ?, B5 p* w    }
    4 r- Z: b. t* D& g' _5 h}
    " Y! R( L9 r0 F3 |) s. q5 p可以看到,它对数据目录进行了权限上的确认,并且发现当配置文件存在的时候,不会做任何更改。所以如果我们需要生成新的配置文件,就需要把旧的删除(或改名)。
    " K' r+ `9 h- \# n其中的selectNetwork(network)函数,实现了根据chain_id的不同来组装不同的配置文件内容,它对应于master/config/toml.go#L48:2 {' h7 E! E; B4 K3 Y7 G# b
    func selectNetwork(network string) string {! Q- g# k* }- I) h, W5 a$ f% v
        if network == "testnet" {) c7 r0 z. A' J) i' x0 h
            return defaultConfigTmpl + testNetConfigTmpl/ z9 O1 f6 }. P9 {
        } else if network == "mainnet" {5 X% f. z/ X8 B
            return defaultConfigTmpl + mainNetConfigTmpl
    ! a8 v3 n% R- O2 [3 ]& H2 _    } else {* s7 I, A( D4 O' T, S) v' ?$ \9 x
            return defaultConfigTmpl + soloNetConfigTmpl6 \# r6 G  o3 C2 i/ R7 g( E
        }0 e$ M: z9 p% `6 D: H1 s
    }
    - h) J+ V+ o5 \5 d( i果然就是一个简单的字符串拼接,其中的defaultConfigTmpl和*NetConfgTmpl在前面已经出现,这里不重复。
    - v8 t( P6 Y. K- [- r! ?最后调用第三方函数cmn.MustWriteFile(configFilePath, []byte(selectNetwork(network)), 0644),把拼接出来的配置文件内容以权限0644写入到指定的文件地址。
    ( e5 r# s4 X/ |2 `" z3 x' b到这里,我们这个问题就算回答完毕了。
    % k! B; N6 F& E+ b2 l. i感谢社区用户Freewind的辛勤写作
  • BitMere.com 比特池塘系信息发布平台,比特池塘仅提供信息存储空间服务。
    声明:该文观点仅代表作者本人,本文不代表比特池塘立场,且不构成建议,请谨慎对待。
    您需要登录后才可以回帖 登录 | 立即注册

    本版积分规则

    成为第一个吐槽的人

    一夜雨十年灯潞 初中生
    • 粉丝

      0

    • 关注

      7

    • 主题

      11