Go编译时写入数据的原理

场景

公司线上运行的Go服务存在多个版本

荔波网站制作公司哪家好，找成都创新互联公司！从网页设计、网站建设、微信开发、APP开发、成都响应式网站建设等网站项目制作，到程序开发，运营维护。成都创新互联公司从2013年成立到现在10年的时间，我们拥有了丰富的建站经验和运维经验，来保证我们的工作的顺利进行。专注于网站建设就选成都创新互联公司。

时间：某天凌晨

事情：线上Go服务突然间 crash

紧急处理：重启Go服务

故障排查：查询日志，找出可能出现的堆栈信息以及追溯源码

问题：线上同时存在多个版本，如何知道当前 crash 的程序属于哪个版本?

添加版本信息的两种方案

方案1，手动添加版本信息：

 
 
 
    
  
  
  
  1. package main
    2. 
  
  
  
  2. 
  
  
  
  3. import (
    4. 
  
  
  
  4.     "flag"
    5. 
  
  
  
  5.     "fmt"
    6. 
  
  
  
  6. )
    7. 
  
  
  
  7. // 下面三个变量，每次发版都要修改
    8. 
  
  
  
  8. var version = "v0.0.1" // 程序版本号
    9. 
  
  
  
  9. var gitTag = "v0.0.1" // git tag 号
    10. 
  
  
  
  10. var dateTime = "2021-08-14 10:00:00" // 编译生成时间
    11. 
  
  
  
  11. 
  
  
  
  12. func main() {
    13. 
  
  
  
  13.     debugVerInfo := flag.Bool("ver", false, "show app version info")
    14. 
  
  
  
  14.     flag.Parse()
    15. 
  
  
  
  15. 
  
  
  
  16.     if *debugVerInfo {
    17. 
  
  
  
  17.         fmt.Println("version is:", version)
    18. 
  
  
  
  18.         fmt.Println("dateTime is:", dateTime)
    19. 
  
  
  
  19.         fmt.Println("gitTag is:", gitTag)
    20. 
  
  
  
  20.         return
    21. 
  
  
  
  21.     }
    22. 
  
  
  
  22. 
  
  
  
  23.     fmt.Println("do other thing")
    24. 
  
  
  
  24. }
    25.

由于手动在代码中添加版本信息，所以在排查时可以查看到对应信息。

 
 
 
    
  
  
  
  1.   code  ./client -ver  
    2. 
  
  
  
  2. version is: v0.0.1
    3. 
  
  
  
  3. dateTime is: 2021-08-14 10:00:00
    4. 
  
  
  
  4. gitTag is: v0.0.1
    5.

分析：

在很多公司甚至开源项目都会采用该方式，在代码中显式地添加版本等信息。

  1. 假设不经常发版或者发版周期比较长，则完全没问题
  2. 假设发版频繁，很大概率会出现版本信息的遗漏、错误
  3. 假设版本信息忘记更改，则查询出来的信息就是错的

针对以上情况，提出一个问题：Go是编译型语言，版本等信息是否可以在编译时，自动地打包到二进制文件中?

方案2，自动打包版本信息：

 
 
 
    
  
  
  
  1. package main
    2. 
  
  
  
  2. 
  
  
  
  3. import (
    4. 
  
  
  
  4.     "flag"
    5. 
  
  
  
  5.     "fmt"
    6. 
  
  
  
  6. )
    7. 
  
  
  
  7. 
  
  
  
  8. var version = "v0.0.0"// 此处暂时只填写大的版本号
    9. 
  
  
  
  9. var gitTag string
    10. 
  
  
  
  10. var dateTime string
    11. 
  
  
  
  11. 
  
  
  
  12. func main() {
    13. 
  
  
  
  13.     debugVerInfo := flag.Bool("ver", false, "show app version info")
    14. 
  
  
  
  14.     flag.Parse()
    15. 
  
  
  
  15. 
  
  
  
  16.     if *debugVerInfo {
    17. 
  
  
  
  17.         fmt.Println("version is:", version)
    18. 
  
  
  
  18.         fmt.Println("dateTime is:", dateTime)
    19. 
  
  
  
  19.         fmt.Println("gitTag is:", gitTag)
    20. 
  
  
  
  20.         return
    21. 
  
  
  
  21.     }
    22. 
  
  
  
  22. 
  
  
  
  23.     fmt.Println("do other thing")
    24. 
  
  
  
  24. }
    25.

 在编译时，打包版本等信息到Go的二进制文件中：

 
 
 
    
  
  
  
  1. go build -ldflags \
    2. 
  
  
  
  2.     "-X main.version=v0.0.1 -X main.dateTime=`date +%Y-%m-%d,%H:%M:%S` -X main.gitTag=`git tag`" \
    3. 
  
  
  
  3.   -o client
    4.

build 通过 -ldflags 的 -X 参数可以在编译时将值写入变量

变量格式：包名称.变量名称=值

查看版本信息

 
 
 
    
  
  
  
  1.   code  ./client -ver  
    2. 
  
  
  
  2. version is: v0.0.1
    3. 
  
  
  
  3. dateTime is: 2021-08-14 10:00:00
    4. 
  
  
  
  4. gitTag is: v0.0.1
    5.

优点：

无需代码中显式添加版本等信息

避免手动添加版本信息时，遗漏或者错误等情况发生

可使用持续集成工具自动把版本等信息打包到二进制文件中

原理

二进制文件在加载到内存中之后，整个内存空间会被划分为若干段。除了代码区、数据区、堆、栈，还有有一个段为符号表。

在编译时，把版本等信息打包到符号表中，供程序运行时使用。

 
 
 
    
  
  
  
  1. [root@localhost demo]# readelf -s client | grep main
    2. 
  
  
  
  2.     ......
    3. 
  
  
  
  3.   1686: 00000000005608b0    16 OBJECT  GLOBAL DEFAULT   10 main.version
    4. 
  
  
  
  4.   1687: 00000000005608a0    16 OBJECT  GLOBAL DEFAULT   10 main.gitTag
    5. 
  
  
  
  5.   1688: 0000000000560890    16 OBJECT  GLOBAL DEFAULT   10 main.dateTime
    6. 
  
  
  
  6.     ......
    7. 
  
  
  
  7.   2320: 00000000004eb2e8     7 OBJECT  GLOBAL DEFAULT    2 main.version.str
    8. 
  
  
  
  8.   2321: 00000000004ebba0    20 OBJECT  GLOBAL DEFAULT    2 main.dateTime.str
    9. 
  
  
  
  9.   2322: 00000000004eb2e0     7 OBJECT  GLOBAL DEFAULT    2 main.gitTag.str
    10.

使用 readelf -s命令查看编译好的Go二进制文件符号表信息，可以明显看到在编译时写入的三个变量。

其中，main.version、main.gitTag、main.dateTime 大小都为16，是指 在Go中的string类型结构体大小。

 
 
 
    
  
  
  
  1. (gdb) ptype version
    2. 
  
  
  
  2. type = struct string {
    3. 
  
  
  
  3.     uint8 *str;
    4. 
  
  
  
  4.     int len;
    5. 
  
  
  
  5. }
    6. 
  
  
  
  6. 
  
  
  
  7. (gdb) ptype dateTime
    8. 
  
  
  
  8. type = struct string {
    9. 
  
  
  
  9.     uint8 *str;
    10. 
  
  
  
  10.     int len;
    11. 
  
  
  
  11. }
    12. 
  
  
  
  12. 
  
  
  
  13. (gdb) ptype gitTag
    14. 
  
  
  
  14. type = struct string {
    15. 
  
  
  
  15.     uint8 *str;
    16. 
  
  
  
  16.     int len;
    17. 
  
  
  
  17. }
    18.

不知细心的你是否发现，在符号表显示的变量具体值 main.version.str、main.dateTime.str、main.gitTag.str长度都比实际多一个字节。

虽然目前Go实现了自举，但是编译Go编译器的编译器还是用C语言写的

C语言字符串(字节数组)是非安全类型，使用尾零来标识字符串结束。其中，尾零也占用一个字节。

尾零是 ASCII 第一个元素 0， 即：NUL

 
 
 
    
  
  
  
  1. (gdb) p version
    2. 
  
  
  
  2. $1 = "v0.0.1"
    3. 
  
  
  
  3. 
  
  
  
  4. (gdb) p dateTime
    5. 
  
  
  
  5. $2 = "2021-08-13,23:26:44"
    6. 
  
  
  
  6. 
  
  
  
  7. (gdb) p gitTag
    8. 
  
  
  
  8. $3 = "v0.0.1"
    9.

当前标题：Go编译时写入数据的原理
网站URL：http://www.36103.cn/qtweb/news47/9597.html

网站建设、网络推广公司-创新互联，是专注品牌与效果的网站制作，网络营销seo公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 创新互联

猜你还喜欢下面的内容

网站收录知识

分类信息网

成都富士康招工　　 　成都花箱厂家　　 　成都网站建设　　 　微信小程序开发　　 　抖音代运营　　 　成都雨棚定制　　 　企业网站设计　　 　边坡防护网厂家　　 　宜宾冠赛网站　　 　绵阳电信服务器托管　　 　四川中建建业　　 　广汉做网站　　 　网站SEO优化　　 　短视频拍摄　　 　江油网站建设　　 　成都标识标牌设计制作　　 　成都定制网站　　 　成都二枢电信服务器托管　　 　网站建设公司　　 　云主机