Golang 开发过程中 Live Reload 实践

2022-09-10 Golang GoLand VSCode Hot Reload Live Reload

Live Reload vs Hot Reload

几个月前开始尝试用 Golang 写 Web 应用时，第一次意识到：对于一个像我这样过去总写 Java 代码的老程序员来说，因各类 IDE 带来的便利性，几乎忽略了热加载（Live Reload）这个问题的存在。开始使用 Golang 之后，特别是是编写 Web 应用时，因为改写页面上一个 JavaScript 函数而需要暂停当前运行的程序，再重新运行程序实在太令人沮丧了。好在，Golang 开发相关的资料和方案都已经相当齐全，只需要找到合适的解决方案就可以愉快地编码。

任何一门编程语言，在开发过程中总是需要「编写代码」，之后「编译运行」这两个步骤。「编写代码」的过程，可以使用任何文本编辑器。「编译并运行」的过程需要编程语言提供的开发工具包来支持。而好的 IDE 可以将上述两个步骤紧密有效的链接起来，方便开发人员专注于实现业务本身。

Golang 开发过程中常见的 IDE 包括：免费的 Microsoft Visual Studio Code 以及商业收费的 JetBrains Goland。这篇文章讲解过程中，也将围绕着前述这两种 IDE 展开。

简单讲解一下关于「热加载」的概念。我们用中文书写的「热加载」相关的概念，源自于英文中的「Live Reload」以及「Hot Reload」。而在英文中，这两者有着本质区别的：

Live Reload ：当程序中的某一个或若干个文件发生变化时，重新加载或刷新整个程序。这个过程会导致程序状态丢失，比如：在界面上点击进入某个字界面等操作，会全部失效。最终的结果是，程序会重新启动并会是最初的样子。
Hot Reload ：当程序中的某一个或若干个文件发生变化时，在不丢失程序运行状态的前提下更新修改的部分。比如：flutter 开发过程中就支持这种刷新方式。

截图内容源自 stackoverflow.com

截图内容源自 stackoverflow.com

Visual Studio Code 实践方案

使用 Visual Studio Code 作为 IDE 开发时，可以借助 cosmtrek/air 来实现热加载。air 本身也是用 Golang 实现的开发辅助工具，其主要的功能包括：

监听应用文件夹内文件的变化并重新启动程序
通过配置文件实现定制化需求
可以设置忽略监听的文件以及其他辅助选项

https://github.com/cosmtrek/air

安装 Air 的过程相当简单（请注意上网姿势）：

1# binary will be $(go env GOPATH)/bin/air
2curl -sSfL https://raw.githubusercontent.com/cosmtrek/air/master/install.sh | sh -s -- -b $(go env GOPATH)/bin

1# or install it into ./bin/
2curl -sSfL https://raw.githubusercontent.com/cosmtrek/air/master/install.sh | sh -s

安装完成之后，在项目根目录执行 air init 命令，可初始化 air 配置并生成默认配置文件，其内容可参考 ohUrlShortener 项目使用的 air 配置：

 1root = "."
 2testdata_dir = "testdata"
 3tmp_dir = "tmp"
 4
 5[build]
 6  bin = "./tmp/ohurlshortener"
 7  cmd = "go build -o ./tmp/ohurlshortener ."
 8  delay = 1000
 9  exclude_dir = ["tmp", "vendor", "testdata","docker"]
10  exclude_file = []
11  exclude_regex = ["_test.go"]
12  exclude_unchanged = false
13  follow_symlink = false
14  full_bin = ""
15  include_dir = []
16  include_ext = ["go", "tpl", "tmpl", "html","css","js"]
17  kill_delay = "0s"
18  log = "build-errors.log"
19  send_interrupt = false
20  stop_on_error = true
21
22[color]
23  app = ""
24  build = "yellow"
25  main = "magenta"
26  runner = "green"
27  watcher = "cyan"
28
29[log]
30  time = false
31
32[misc]
33  clean_on_exit = true
34
35[screen]
36  clear_on_rebuild = false

通过 air -c .air.toml 命令启动应用程序，air 将会监听上述配置文件描述的内容，当有文件修改或删除、更新等操作时，会重新加载整个应用程序，从而实现 Live Reload 。

JetBrains Goland 实践方案

如果使用的是 JetBrains Goland 作为 IDE 的话，就可以不必使用 air 来做 Live Reload。毕竟，air 是直接使用 go build -o 编译并运行，做 Debug 调试是不支持的。Goland 实践方案的思路：利用 Save Actions 插件监听保存操作，当保存操作被出发之后，执行 Goland 配置好的 Run 或者 Debug 选项启动应用。

2.1 配置应用的 Debug 或 Run 选项

找到程序入口 main 函数，开启 Debug 或者 Run 选项，根据弹出框配置好应用启动必要的参数，可参考：