Ktorを試してみた

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴アジェンダ 1. はじめに 2. Ktorについて 3. 事前準備 4. Features
5. 非同期接続について 6. 実践 7. まとめ 3 Copyright © 2019 Toranoana Inc. All Rights Reserved.

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 1.はじめに 4 • 本日の内容

虎の穴　虎の穴　虎の穴　虎の穴　虎の穴　虎の穴 5 Copyright © 2019 Toranoana Inc. All Rights Reserved.
• 「ケイター」と読みます。 • Kotlinで開発されています。 • Kotlin同様 JetBrains社により開発されています。 • 単体では非常にシンプルな micro framework です。 2.Ktorについて

• Featuresと呼ばれるHTML Template、認証機能などの各種機能をプラグイン形式で追加が可能 • 非同期処理を行うサーバの開発を容易にできる • 標準のサーブレットエンジンの他に、Jetty、 Nettyなどのサーブレットエンジンと差し替え可能 2.Ktorについて

事前準備として、IntelliJ IDEAを使用した Ktorプロジェクトの作成方法を説明します。 3.事前準備

1.Ktorプラグインの追加 3.事前準備 IntelliJ IDEA を起動し、Welcome画面右下の「Configure」から「Plugins」を選択して Plugin画面を表示させます。 Plugins を選択します。

1.Ktorプラグインの追加 3.事前準備 Plugin画面で、画面上部の検索欄に「Ktor」と入力すると、Ktorプラグインが表示されるので、プラグインの「Install」ボタンをクリックします。 1. Ktorと入力 2. Install をクリック

1.Ktorプラグインの追加 3.事前準備プラグインのインストール後はIDEの再起動ボタンが表示されるので、ボタンをクリックして再起動を行います。 Restart IDE をクリック

2.Ktorプロジェクトの作成手順 3.事前準備 Welcome画面の「Create New Project」をクリックします。

2.Ktorプロジェクトの作成手順 3.事前準備画面左側の「Ktor」を選択し、利用するプラグインを選択して「Next」ボタンをクリックします。 1. Ktor を選択 2. 各種プラグインを選択 3. Nextボタンをクリック

2.Ktorプロジェクトの作成手順 3.事前準備「GroupId」「ArtifactId」を適宜入力し、「Next」ボタンをクリックします。 1. GroupId、ArtifactIdを適宜入力 2. Nextボタンをクリック

2.Ktorプロジェクトの作成手順 3.事前準備「Project name」を入力すると「Project location」（プロジェクトのディレクトリの作成場所）が自動的に変更されます。内容を確認後、「Finish」ボタンをクリックします。 1. Project name を入力 2. Finishボタンをクリック

2.Ktorプロジェクトの作成手順 3.事前準備 Gradleの設定画面が表示されるので「Use auto-import」をチェック状態に変更後、「OK」ボタンをクリックします。 1. Use auto-import をチェック 2. OKボタンをクリック

2.Ktorプロジェクトの作成手順 3.事前準備プロジェクト画面が表示されて完了です。

Ktorの公式サイトで紹介されている Guides を参考に、Ktorにプラグインとして提供されているFeatures（機能）を見ていきます。 https://ktor.io/quickstart/guides.html 4. Features

Routing 4.Features import io.ktor.routing.* （中略） routing { get("/") { call.respondText("HELLO WORLD!", contentType = ContentType.Text.Plain) } get("/html-dsl") { call.respondHtml { （中略） } } （以下略）

Routing 4.Features import io.ktor.routing.* （中略） routing { get("/") { call.respondText("HELLO WORLD!", contentType = ContentType.Text.Plain) } get("/html-dsl") { call.respondHtml { （中略） } } （以下略）構造化ルートと関連するハンドラを定義することができます。つまり、リクエストを受け付けるURLと、それに対するアクションを指定できるようになります。 Locations というFeaturesを利用することで、タイプセーフなURLパラメータを扱うことも可能です。

HTML DSL 4.Features get("/html-dsl") { call.respondHtml { head { link(rel = "stylesheet", href = "/styles.css", type = "text/css") } body { h1 { +"HTML" } ul { for (n in 1..10) { li { +"$n" } } } p("myclass") { +"I am using myclass" } } } } Kotlinのコードを使用してHTMLを生成できるようになります。

CSS DSL 4.Features get("/styles.css") { call.respondCss { body { backgroundColor = Color.red } p { fontSize = 2.em } rule("p.myclass") { color = Color.blue } } } Kotlinのコードを使用してCSSを生成できるようになります。

StatusPages 4.Features install(StatusPages) { exception<AuthenticationException> { cause -> call.respond(HttpStatusCode.Unauthorized) } exception<AuthorizationException> { cause -> call.respond(HttpStatusCode.Forbidden) } } class AuthenticationException : RuntimeException() class AuthorizationException : RuntimeException() 例外が発生した際のアクションを定義できるようになります。

Sessions 4.Features install(Sessions) { cookie<MySession>("MY_SESSION") { cookie.extensions["SameSite"] = "lax" } } get("/session/increment") { val session = call.sessions.get<MySession>() ?: MySession() call.sessions.set(session.copy(count = session.count + 1)) call.respondText("Counter is ${session.count}. Refresh to increment.") } data class MySession(val count: Int = 0)

Sessions 4.Features install(Sessions) { cookie<MySession>("MY_SESSION") { cookie.extensions["SameSite"] = "lax" } } get("/session/increment") { val session = call.sessions.get<MySession>() ?: MySession() call.sessions.set(session.copy(count = session.count + 1)) call.respondText("Counter is ${session.count}. Refresh to increment.") } data class MySession(val count: Int = 0) セッションのサポートを追加します。

Static Content 4.Features // Static feature. Try to access `/static/ktor_logo.svg` static("/static") { resources("static") } 定義された場所から静的ファイルを配信します。左記のようなコードの場合、 /static/ktor_logo.svg を指定されると/resources/static/ ktor_logo.svg を求めます。

Freemarker 4.Features install(FreeMarker) { templateLoader = ClassTemplateLoader(this::class.java.classLoader, "templates") } get("/html-freemarker") { call.respond(FreeMarkerContent("index.ftl", mapOf("data" to IndexData(listOf(1, 2, 3))), "")) } レスポンスとして、 FreeMarkerContent に指定されたテンプレートindex.ftiと、mapOf データを渡しています。

Freemarker 4.Features <#-- @ftlvariable name=“data” type=“com.example.IndexData” --> <html> <body> <ul> <#list data.items as item> <li>${item}</li> </#list> </ul> </body> </html> (index.fti)

CORS 4.Features install(CORS) { method(HttpMethod.Options) method(HttpMethod.Put) method(HttpMethod.Delete) method(HttpMethod.Patch) header(HttpHeaders.Authorization) header("MyCustomHeader") allowCredentials = true anyHost() // @TODO: Don't do this in production if possible. Try to limit it. } オリジン間リソース共有（CORS）を有効にする為の設定が行えます。（HTTPメソッドの追加、ヘッダーの追加等）

Jackson 4.Features install(ContentNegotiation) { jackson { enable(SerializationFeature.INDENT_OUTPUT) } } get("/json/jackson") { call.respond(mapOf("hello" to "world")) } Jacksonライブラリを使用して JSONのシリアル化を処理します。

小まとめ・必要と思われる機能の大半は揃っているように思う。・Kotlinベースの為、Javaのライブラリも使用可能。 4.Features

KtorはKotlinのコルーチンを利用して開発がされています。そのコルーチンを利用した非同期処理が可能なつくりとなっています。 5.非同期処理について

コルーチンとはざっくり説明をすると、以下のような特性を持ちます。・軽量なスレッドのようなもの・メインスレッドをブロックせずに非同期に動作させることができる・軽量な為、大量に作成することができる 5.非同期処理について

つまり、大量の同時アクセスに対応できる 5.非同期処理について

Ktorで作成されたWebアプリに、Kotlinで作成したクライアントプログラムで大量のアクセスを試みます。 6.実践

・サーバーは新規のKtorプロジェクトで、Features にRoutingだけを指定して作成したものを、そのまま使用します。 7.実践 fun main(args: Array<String>): Unit = io.ktor.server.netty.EngineMain.main(args) @Suppress("unused") // Referenced in application.conf @kotlin.jvm.JvmOverloads fun Application.module(testing: Boolean = false) { routing { get("/") { call.respondText("HELLO WORLD!", contentType = ContentType.Text.Plain) } } }

・クライアント側はKotlinのコルーチンを使用して作成した非常に簡単なものです。 7.実践 import kotlinx.coroutines.runBlocking fun main() = runBlocking { repeat(100) { launch { val result : = clientCall() println("$result") } } } fun clientCall(): String { val requestUrl = "http://127.0.0.1:8080/"

・現段階でも使用には耐えそう・Features（機能）はこれからも増えそう？・GitHubのリリースの頻度を見ると、まだ鋭意開発中のフレームワークなので、本格的に使用する場合はリリースノートなどを追う必要があるかも 7.まとめ

Ktorを試してみた

Ktorを試してみた

More Decks by 虎の穴ラボ株式会社

Other Decks in Technology

Featured

Transcript