Express から Ktor への移行
このガイドでは、アプリケーションの生成や最初のアプリケーションの作成から、アプリケーション機能を拡張するためのミドルウェアの作成まで、基本的なシナリオにおいて Express アプリケーションを Ktor へ移行する方法を見ていきます。
アプリケーションの生成
| Express |
shell |
| Ktor | Ktor は、アプリケーションのスケルトンを生成するために以下の方法を提供しています。
詳細な手順については、チュートリアル 新しい Ktor プロジェクトの作成、オープン、および実行Ktor を使用したサーバーアプリケーションの開き方、実行方法、テスト方法について学びます。 を参照してください。 |
Hello world
このセクションでは、GET リクエストを受け付け、事前に定義されたプレーンテキストで応答する最もシンプルなサーバーアプリケーションを作成する方法を見ていきます。
| Express | 以下の例は、サーバーを起動し、ポート 3000 で接続をリッスンする Express アプリケーションを示しています。 javascript 完全な例については、1_hello プロジェクトを参照してください。 |
| Ktor | Ktor では、embeddedServer 関数を使用してコード内でサーバーパラメータを設定し、アプリケーションを迅速に実行できます。 kotlin 完全な例については、1_hello プロジェクトを参照してください。 HOCON または YAML 形式を使用する外部構成ファイルでサーバー設定を指定することもできます。 |
上記の Express アプリケーションは、次のような Date、X-Powered-By、および ETag レスポンスヘッダーを追加することに注意してください。
Date: Fri, 05 Aug 2022 06:30:48 GMT
X-Powered-By: Express
ETag: W/"c-Lve95gjOVATpfV8EL5X4nxwjKHE"Ktor で各レスポンスにデフォルトの Server および Date ヘッダーを追加するには、DefaultHeaders必要な依存関係: io.ktor:ktor-server-default-headers プラグインをインストールする必要があります。Etag レスポンスヘッダーの構成には、ConditionalHeaders必要な依存関係: io.ktor:ktor-server-conditional-headers プラグインを使用できます。
静的コンテンツの配信
このセクションでは、Express と Ktor で画像、CSS ファイル、JavaScript ファイルなどの静的ファイルを配信する方法を見ていきます。メインの index.html ページとリンクされた一連のアセットを含む public フォルダーがあると仮定します。
public
├── index.html
├── ktor_logo.png
├── css
│ └──styles.css
└── js
└── script.js| Express | Express では、フォルダー名を express.static 関数に渡します。 javascript 完全な例については、2_static プロジェクトを参照してください。 |
| Ktor | Ktor では、 kotlin 完全な例については、2_static プロジェクトを参照してください。 |
静的コンテンツを配信する際、Express は次のような複数のレスポンスヘッダーを追加します。
Accept-Ranges: bytes
Cache-Control: public, max-age=0
ETag: W/"181-1823feafeb1"
Last-Modified: Wed, 27 Jul 2022 13:49:01 GMTKtor でこれらのヘッダーを管理するには、次のプラグインをインストールする必要があります。
Accept-Ranges : PartialContent必要な依存関係: io.ktor:ktor-server-partial-content
Cache-Control : CachingHeaders必要な依存関係: io.ktor:ktor-server-caching-headers
ETag および Last-Modified : ConditionalHeaders必要な依存関係: io.ktor:ktor-server-conditional-headers
ルーティング
Routingルーティングは、サーバーアプリケーションにおいて着信リクエストを処理するためのコアとなるプラグインです。 を使用すると、特定の HTTP リクエストメソッド(GET、POST など)とパスによって定義される特定のエンドポイントに対して行われた受信リクエストを処理できます。以下の例は、/ パスに対して行われた GET および POST リクエストを処理する方法を示しています。
| Express | javascript 完全な例については、3_router プロジェクトを参照してください。 |
| Ktor | kotlin
完全な例については、3_router プロジェクトを参照してください。 |
次の例は、ルートハンドラーをパスごとにグループ化する方法を示しています。
| Express | Express では、 javascript 完全な例については、3_router プロジェクトを参照してください。 |
| Ktor | Ktor は kotlin 完全な例については、3_router プロジェクトを参照してください。 |
どちらのフレームワークでも、関連するルートを単一のファイルにグループ化できます。
| Express | Express は、マウント可能なルートハンドラーを作成するために javascript javascript 完全な例については、3_router プロジェクトを参照してください。 |
| Ktor | Ktor では、実際のルートを定義するために kotlin kotlin 完全な例については、3_router プロジェクトを参照してください。 |
URL パスを文字列として指定する以外にも、Ktor にはタイプセーフなルートResourcesプラグインを使用すると、型安全なルーティングを実装できます。を実装する機能が含まれています。
ルートパラメータとクエリパラメータ
このセクションでは、ルートパラメータとクエリパラメータにアクセスする方法を説明します。
ルート(またはパス)パラメータは、URL 内のその位置に指定された値をキャプチャするために使用される名前付きの URL セグメントです。
| Express | Express でルートパラメータにアクセスするには、 javascript 完全な例については、4_parameters プロジェクトを参照してください。 |
| Ktor | Ktor では、ルートパラメータは kotlin 完全な例については、4_parameters プロジェクトを参照してください。 |
以下の表は、クエリ文字列のパラメータにアクセスする方法を比較しています。
| Express | Express でクエリパラメータにアクセスするには、 javascript 完全な例については、4_parameters プロジェクトを参照してください。 |
| Ktor | Ktor では、クエリパラメータにアクセスするために kotlin 完全な例については、4_parameters プロジェクトを参照してください。 |
レスポンスの送信
前のセクションでは、プレーンテキストのコンテンツで応答する方法を既に確認しました。ここでは、JSON、ファイル、およびリダイレクトのレスポンスを送信する方法を見ていきましょう。
JSON
| Express | Express で適切なコンテンツタイプを持つ JSON レスポンスを送信するには、 javascript 完全な例については、5_send_response プロジェクトを参照してください。 |
| Ktor | Ktor では、ContentNegotiationContentNegotiation プラグインには、主に2つの目的があります。クライアントとサーバー間でのメディアタイプのネゴシエーション、および特定の形式でのコンテンツのシリアライズ/デシリアライズです。 プラグインをインストールし、JSON シリアライザーを構成する必要があります。 kotlin データを JSON にシリアライズするには、 kotlin その後、 kotlin 完全な例については、5_send_response プロジェクトを参照してください。 |
ファイル
| Express | Express でファイルをレスポンスとして返すには、 javascript 完全な例については、5_send_response プロジェクトを参照してください。 |
| Ktor | Ktor は、クライアントにファイルを送信するための kotlin 完全な例については、5_send_response プロジェクトを参照してください。 |
Express アプリケーションは、ファイルで応答する際に Accept-Ranges HTTP レスポンスヘッダーを追加します。サーバーはこのヘッダーを使用して、ファイルダウンロードに関するクライアントからの部分リクエスト(レンジリクエスト)のサポートを通知します。Ktor では、部分リクエストをサポートするために PartialContent必要な依存関係: io.ktor:ktor-server-partial-content プラグインをインストールする必要があります。
添付ファイル
| Express |
javascript 完全な例については、5_send_response プロジェクトを参照してください。 |
| Ktor | Ktor では、ファイルを添付ファイルとして転送するために Content-Disposition ヘッダーを手動で構成する必要があります。 kotlin 完全な例については、5_send_response プロジェクトを参照してください。 |
リダイレクト
| Express | Express でリダイレクトレスポンスを生成するには、 javascript 完全な例については、5_send_response プロジェクトを参照してください。 |
| Ktor | Ktor では、 kotlin 完全な例については、5_send_response プロジェクトを参照してください。 |
テンプレート
Express と Ktor の両方で、ビューを扱うためのテンプレートエンジンを使用できます。
| Express | views フォルダーに次の Pug テンプレートがあるとします。 このテンプレートで応答するには、 javascript 完全な例については、6_templates プロジェクトを参照してください。 |
| Ktor | Ktor は、FreeMarker、Velocity などのいくつかの JVM テンプレートエンジンHTML/CSS または JVM テンプレートエンジンを使用して構築されたビューを扱う方法を学びます。をサポートしています。例えば、アプリケーションリソースに配置された FreeMarker テンプレートで応答する必要がある場合は、 kotlin 完全な例については、6_templates プロジェクトを参照してください。 |
リクエストの受信
このセクションでは、さまざまな形式のリクエスト本文を受信する方法を説明します。
プレーンテキスト
以下の POST リクエストは、テキストデータをサーバーに送信します。
POST http://0.0.0.0:3000/text
Content-Type: text/plain
Hello, world!このリクエストの本文をサーバー側でプレーンテキストとして受信する方法を見てみましょう。
| Express | Express で受信リクエストの本文を解析するには、 javascript
javascript 完全な例については、7_receive_request プロジェクトを参照してください。 |
| Ktor | Ktor では、 kotlin 完全な例については、7_receive_request プロジェクトを参照してください。 |
JSON
このセクションでは、JSON 本文を受信する方法を見ていきます。以下のサンプルは、本文に JSON オブジェクトを含む POST リクエストを示しています。
POST http://0.0.0.0:3000/json
Content-Type: application/json
{
"type": "Fiat",
"model" : "500",
"color": "white"
}| Express | Express で JSON を受信するには、 javascript 完全な例については、7_receive_request プロジェクトを参照してください。 |
| Ktor | Ktor では、ContentNegotiationContentNegotiation プラグインには、主に2つの目的があります。クライアントとサーバー間でのメディアタイプのネゴシエーション、および特定の形式でのコンテンツのシリアライズ/デシリアライズです。 プラグインをインストールし、 kotlin 受信したデータをオブジェクトにデシリアライズするには、データクラスを作成する必要があります。 kotlin 次に、このデータクラスをパラメータとして受け取る kotlin 完全な例については、7_receive_request プロジェクトを参照してください。 |
URL エンコード
次に、application/x-www-form-urlencoded タイプを使用して送信されたフォームデータを受信する方法を見てみましょう。以下のコードスニペットは、フォームデータを含む POST リクエストの例を示しています。
POST http://localhost:3000/urlencoded
Content-Type: application/x-www-form-urlencoded
username=JetBrains&email=example@jetbrains.com&password=foobar&confirmation=foobar| Express | プレーンテキストや JSON と同様に、Express では javascript 完全な例については、7_receive_request プロジェクトを参照してください。 |
| Ktor | Ktor では、 kotlin 完全な例については、7_receive_request プロジェクトを参照してください。 |
バイナリデータ
次のユースケースは、バイナリデータの処理です。以下のリクエストは、application/octet-stream を持つ PNG 画像をサーバーに送信します。
POST http://localhost:3000/raw
Content-Type: application/octet-stream
< ./ktor_logo.png| Express | Express でバイナリデータを処理するには、パーサータイプを javascript 完全な例については、7_receive_request プロジェクトを参照してください。 |
| Ktor | Ktor は、バイトシーケンスの非同期読み取り/書き込み用の kotlin 完全な例については、7_receive request プロジェクトを参照してください。 |
マルチパート
最後のセクションでは、multipart 本文を処理する方法を見ていきます。以下の POST リクエストは、multipart/form-data タイプを使用して説明付きの PNG 画像を送信します。
POST http://localhost:3000/multipart
Content-Type: multipart/form-data; boundary=WebAppBoundary
--WebAppBoundary
Content-Disposition: form-data; name="description"
Content-Type: text/plain
Ktor logo
--WebAppBoundary
Content-Disposition: form-data; name="image"; filename="ktor_logo.png"
Content-Type: image/png
< ./ktor_logo.png
--WebAppBoundary--| Express | Express でマルチパートデータを解析するには、別のモジュールが必要です。以下の例では、multer を使用してファイルをサーバーにアップロードしています。 javascript 完全な例については、7_receive_request プロジェクトを参照してください。 |
| Ktor | Ktor でマルチパートリクエストの一部として送信されたファイルを受信する必要がある場合は、 kotlin 完全な例については、7_receive_request プロジェクトを参照してください。 |
ミドルウェアの作成
最後に見るのは、サーバー機能を拡張できるようにするミドルウェアを作成する方法です。以下の例は、Express と Ktor を使用してリクエストロギングを実装する方法を示しています。
| Express | Express では、ミドルウェアは javascript 完全な例については、8_middleware プロジェクトを参照してください。 |
| Ktor | Ktor では、カスタムプラグイン独自のカスタムプラグインを作成する方法を学びます。を使用して機能を拡張できます。以下のコード例は、リクエストロギングを実装するために kotlin 完全な例については、8_middleware プロジェクトを参照してください。 |
次のステップ
セッション管理、認証、データベース統合など、このガイドでは取り上げていないユースケースがまだたくさんあります。これらの機能のほとんどについて、Ktor は必要に応じてアプリケーションにインストールして構成できる専用のプラグインを提供しています。Ktor の学習を続けるには、ステップバイステップのガイドやそのまま使えるサンプルが用意されている Learn ページにアクセスしてください。
