[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 会发生什么?

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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,335评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,895评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,766评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,918评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,042评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,169评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,219评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,976评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,393评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,711评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,876评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,562评论 4 336
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,193评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,903评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,142评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,699评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,764评论 2 351

推荐阅读更多精彩内容