Ktor 从入门到放弃(一) 新建与部署

Ktor 这是一个由 Kotlin 团队打造的 Web 框架,可用于创建异步、高性能和轻量级的 Web 服务器,并使用 Kotlin 惯用的 API 构建非阻塞的多平台 Web 客户端,由于 DSL 的存在,使得在 Ktor 下编写代码尤如写配置,非常的方便灵活。

上面这句是抄的!


在实际开发中,我们需要将 Ktor 程序部署到容器内运行,比如说 tomcat。然而使用 Idea 内的 Ktor 向导创建的 tomcat 项目并不能让我们如愿,具体的不多说了,自己创建一下便知。那这篇的目的很简单了,就是让官方提供的那个超简单的 demo 在 tomcat 上跑起来。

官方的 demo 到底有多简单呢?看以下代码就可以了:

package io.ktor.sample

import io.ktor.application.*
import io.ktor.http.*
import io.ktor.response.*
import io.ktor.routing.*
import io.ktor.server.engine.*
import io.ktor.server.netty.*

fun main(args: Array<String>) {
    val server = embeddedServer(Netty, port = 8080) {
        routing {
            get("/") {
                call.respondText("Hello World!", ContentType.Text.Plain)
            }
            get("/demo") {
                call.respondText("HELLO WORLD!")
            }
        }
    }
    server.start(wait = true)
}

可以看到,它使用了嵌入的 netty 服务器,如果我们要在 tomcat 上运行,必然不能用它了,删掉之,直接使用 routing

fun Application.main() {
    routing {
        get("/") {
                call.respondText("Hello World!", ContentType.Text.Plain)
            }
            get("/demo") {
                call.respondText("HELLO WORLD!")
            }
    }
}

很简单的了,接下去就是如何运行的问题。很可惜的,依然要吐槽一下官方的向导,通过它建立起来的工程并不能够直接运行于 tomcat,需要自己做一些修改。

首先要增加 web/WEB-INF 目录,它与 src 目录是同级的,然后编写 web.xml 文件,在这里有个好消息,用于 Ktorweb.xml 是固定不变的,照抄就好:

<?xml version="1.0" encoding="utf-8"?>
<web-app xmlns="http://java.sun.com/xml/ns/javaee"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
       version="3.0">
   <servlet>
       <display-name>KtorServlet</display-name>
       <servlet-name>KtorServlet</servlet-name>
       <servlet-class>io.ktor.server.servlet.ServletApplicationEngine</servlet-class>
       <init-param>
           <param-name>io.ktor.config</param-name>
           <param-value>application.conf</param-value>
       </init-param>
       <async-supported>true</async-supported>
       <multipart-config>
           <max-file-size>304857600</max-file-size>
           <max-request-size>304857600</max-request-size>
           <file-size-threshold>0</file-size-threshold>
       </multipart-config>
   </servlet>
   <servlet-mapping>
       <servlet-name>KtorServlet</servlet-name>
       <url-pattern>/</url-pattern>
   </servlet-mapping>
</web-app>

在这个配置内,你可以自己修改最大的文件上传和请求的 size,其他的东西都无须变动。

接下来修改一下 application.conf 文件,它位于 resources 目录下,对于 Ktor 程序来说,resources 目录非常重要,你可以把一切静态内容都扔进去。

ktor {
   application {
       modules = [ io.ktor.sample.ApplicationKt.main ]
   }
}

只需要改这一句就可以了,它的组成格式为 包名.类名.函数名,需要注意的是,针对一个没有 class 声明的 Kotlin 文件,它在编译后会生成形如 文件名Kt.class 文件,这也是配置 内 ApplicationKt 的由来。

最后一步,编写 build.gradle,这个脚本主要做两件事,一件是将工程打包为 war 包,另一件是帮助调试运行,再次说一句可惜,因为官方的向导依然没能帮助我们完成这些(怎么一直在吐槽2333)。

buildscript {
    ext.ktor_version = "1.1.2"
    ext.kotlin_version = "1.3.20"
    ext.tomcat_plugin_version = "2.4.2"
    ext.tomcat_version = "9.0.4"
    ext.slf4j_version = "1.7.25"

    repositories {
        google()
        jcenter()
        maven { url 'https://dl.bintray.com/kotlin/ktor' }
        maven { url 'https://dl.bintray.com/kotlin/kotlin-eap' }
    }

    dependencies {
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
        classpath "com.bmuschko:gradle-tomcat-plugin:$tomcat_plugin_version"
    }
}

apply plugin: "kotlin"
apply plugin: "war"
apply plugin: 'com.bmuschko.tomcat'
webAppDirName = "web"

tomcat {
    contextPath = "/"
    httpProtocol = "org.apache.coyote.http11.Http11Nio2Protocol"
    ajpProtocol  = "org.apache.coyote.ajp.AjpNio2Protocol"
}

sourceSets {
    main.kotlin.srcDirs = ["src"]
    main.resources.srcDirs = ["resources"]
}
repositories {
    google()
    jcenter()
    mavenCentral()
    maven { url "https://dl.bintray.com/kotlin/kotlin-eap" }
}
dependencies {
    compile "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
    compile "io.ktor:ktor-server-servlet:$ktor_version"
    compile "io.ktor:ktor-html-builder:$ktor_version"
    compile "org.slf4j:slf4j-jdk14:$slf4j_version"
    tomcat "org.apache.tomcat.embed:tomcat-embed-core:$tomcat_version",
            "org.apache.tomcat.embed:tomcat-embed-jasper:$tomcat_version"
}

task run(dependsOn: tomcatRun)

tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile).all {
    kotlinOptions.freeCompilerArgs += ["-Xuse-experimental=kotlin.Experimental"]
}

完整的 gradle 文件如上,暂时不要管那么多,跑就是了!

$ gradle clean build    // 可以完成一个 war 包的编译
$ gradle run            //  可以将项目运行于 tomcat

运行后,只需要访问 http://localhost:8080 就可以看到我们的页面了,本篇也到此先告一段落。


下一篇预告:《Ktor 从入门到放弃(二) 项目结构与文件访问》

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

推荐阅读更多精彩内容