[Ktor] 实现开发时的热部署

在开发中,我们经常会需要运行起服务,并作一系列测试的场景,频繁的执行 gradle run 显然不是一个好方法。有没有办法实现修改代码后立即被部署执行呢?答案就是本文了。

按官方的文档,有两种监视方式,可以满足对变更代码即热部署的需求。


JDK 版本

要使用 Ktor 的热部署,就必须实现对指定目录的监控,在发现内容变化时,自动进行部署,要使用这一功能,必须确保编译用的 JDK 是 8 版本,而不能是更高版本,如 JDK 9 是不工作的。


一、使用 embeddedServer

通常情况下我们会直接声明 Server 类型并直接调用所对应的 main 函数来启动一个 Ktor 服务,如:

fun main(args: Array<String>): Unit = io.ktor.server.tomcat.EngineMain.main(args)

fun Application.module() {
    ... ...
}

要将它改为带有监视的,可以简单的做如下操作:

fun main(args: Array<String>) = embeddedServer(
    Tomcat,
    watchPaths = listOf("Path to Project"),
    port = 80,
    module = Application::module
).start(true)

fun Application.module() {
    ... ...
}

这样就可以完成对项目目录的监视,当代码发生变化时,即可以做到热部署。同样的,watchPaths 可以被拆开成多个子目录,表示监视子目录而非监视整个项目,当项目较大时,监视指定的子目录会使热部署变得更快。

现在使用 gradle run 就可以运行起项目并实现热部署了。

在这里有一个注意事项,即是在 embeddedServer 行内,不能使用 lambda 表达式来表示 module,这样会使代码无法工作,如下即是个错误的例子:

fun main(args: Array<String>) = embeddedServer(
    Tomcat,
    watchPaths = listOf("nCoVMap"),
    port = 80
) {
    routing { 
        get("/sample") {
            ... ...
        }
    }
}.start(true)

二、使用 application.conf 文件

一般情况下,修改 application.conf 来完成监视是更常见的做法,它无需动到代码,没有耦合,最简单的改法如下:

ktor {
    deployment {
        port = 80
        port = ${?PORT}
        watch = [ Path to Project ]
    }
    application {
        modules = [ ApplicationKt.module ]
    }
}

增加一个 watch 配置并且写入要监视的目录即可,和 embeddedServer 的改法一样,也可以在这里写入多个要监视的子目录。

完成这一步后,就需要启动项目,采用改配置文件的方法时,启动项目需要多做一步命令,启动一个新的 Terminal 并执行: gradle -t installDist,然后再执行可以 gradle run 即可。

注意必须是新开一个 Terminal,而不是采用 & 来将命令放入后台,原因是当终止 gradle run 的时候,我们通常也希望终止 gradle -t installDist,放入后台会让终止一事变得麻烦。


最后再来一个猛的,如果既改了 embeddedServer 又改了 application.conf 会发生什么?

答案是两者都会生效,这下就再也不担心热部署的问题了,一路调试下去吧,即时的!

推荐阅读更多精彩内容