<p>初めまして、<a href="https://jobs.smartround.com/" target="_blank" rel="nofollow noopener noreferrer">株式会社スマートラウンド</a>CTOの小山（<a href="https://twitter.com/doyaaaaaken" target="_blank" rel="nofollow noopener noreferrer">@doyaaaaaken</a>）です。</p>
<p>私達が開発しているプロダクトsmartroundではKotlin製のWebフレームワークであるKtorをバージョン<code>1.0.0-beta</code>の頃から利用しています。<br>
先月Ktorのバージョン2が出たため、メジャーバージョンのアップグレードをしました。</p>
<p>その感想やハマりどころについて雑に書いてみたいと思います。</p>
<h1 id="ktor2%E3%81%AE%E3%82%A2%E3%83%83%E3%83%97%E3%83%87%E3%83%BC%E3%83%88%E5%86%85%E5%AE%B9">
<a class="header-anchor-link" href="#ktor2%E3%81%AE%E3%82%A2%E3%83%83%E3%83%97%E3%83%87%E3%83%BC%E3%83%88%E5%86%85%E5%AE%B9" aria-hidden="true"></a> Ktor2のアップデート内容</h1>
<p>残念ながらユーザにとってあまり大きなアップデートはないです。強いていうならカスタムのPluginを作りやすくなったぐらいでしょうか。<br>
バージョン2はKtor自体の内部構造（パッケージなど）を大幅にリファクタしたリリースという位置づけです。</p>
<p>アップデート内容については、今年2月にServer-Side Kotlin Meetupというイベントで発表した以下の資料でも紹介しています。<br>
<a href="https://speakerdeck.com/doyaaaaaken/xian-qu-riktor2-dot-0" target="_blank" rel="nofollow noopener noreferrer">先取りKtor2.0</a></p>
<p>ちなみに資料にも書きましたが、（Ktor2とは間接的にしか関係ない話ですが）3rd-party（開発者自作）のPluginを公開する構想があるそうなので、個人的には楽しみです。</p>
<h1 id="%E3%81%A9%E3%81%AE%E3%81%90%E3%82%89%E3%81%84%E5%A4%A7%E5%A4%89%E3%81%A0%E3%81%A3%E3%81%9F%EF%BC%9F">
<a class="header-anchor-link" href="#%E3%81%A9%E3%81%AE%E3%81%90%E3%82%89%E3%81%84%E5%A4%A7%E5%A4%89%E3%81%A0%E3%81%A3%E3%81%9F%EF%BC%9F" aria-hidden="true"></a> どのぐらい大変だった？</h1>
<p>流石メジャーバージョンのアップグレードということもあり、まる2日ぐらいかかりました。<br>
軽量なフレームワークなのでやり始めた段階では半日ぐらいで終わりそうだと思っていましたが、後述するようにPluginの挙動が一部変わった箇所もあったため、時間がかかってしまいました。</p>
<h1 id="%E5%85%AC%E5%BC%8F%E3%83%89%E3%82%AD%E3%83%A5%E3%83%A1%E3%83%B3%E3%83%88">
<a class="header-anchor-link" href="#%E5%85%AC%E5%BC%8F%E3%83%89%E3%82%AD%E3%83%A5%E3%83%A1%E3%83%B3%E3%83%88" aria-hidden="true"></a> 公式ドキュメント</h1>
<p>Ktorの公式ドキュメント内に<a href="https://ktor.io/docs/migrating-2.html" target="_blank" rel="nofollow noopener noreferrer">1.6-&gt;2.0へのマイグレーションガイド</a>のページがあります。<br>
ただし、ざっくりどんなアップデートがあったのかはわかるのですが、「具体的にどう修正すればいいのか」に関してはそこまで書いていないので、情報としてそこまでは充実していないなと感じました。</p>
<p>おすすめの進め方は、ドキュメントを参考としてざっと読んだ後、実際にバージョンをアップグレードしてみて、エラーが出たり気になったりしたPluginのドキュメントを読み込む進め方です。</p>
<h1 id="%E3%83%91%E3%83%83%E3%82%B1%E3%83%BC%E3%82%B8%E5%90%8D%E5%A4%89%E6%9B%B4">
<a class="header-anchor-link" href="#%E3%83%91%E3%83%83%E3%82%B1%E3%83%BC%E3%82%B8%E5%90%8D%E5%A4%89%E6%9B%B4" aria-hidden="true"></a> パッケージ名変更</h1>
<p>パッケージ名がほぼすべてというレベルで変わったので、Diffは大量に出ます。<br>
smartroundでは単純なインポート文の修正が300ファイルぐらいに出ました。</p>
<p>手で修正だと厳しいので、IntelliJを使っている場合はKtorプラグインが便利なので使ってみましょう。<br>
（なぜか公式ドキュメントには紹介されていませんでした。なぜ……？？？）</p>
<p>以下画像のように設定すると、Ktorのバージョンが最新バージョンでない場合には、最新版を使うようサジェストしてくれるというおせっかいなプラグインです。<br>
サジェストに従ったら、インポート文の修正を自動でしてくれました。（一部うまくできていない部分はありましたが）<br>
<img src="https://res.cloudinary.com/zenn/image/fetch/s--Xq4clvwr--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/825e6e3b1655e67a5cde6eff.png%3Fsha%3Db6a3fcbcd93fd1652643ad9390344d588c9527f3" alt="Ktor Pluginの設定" loading="lazy" class="md-img"></p>
<h1 id="%E4%BF%AE%E6%AD%A3%E3%81%8C%E5%A4%A7%E3%81%8D%E3%81%8B%E3%81%A3%E3%81%9F%E9%83%A8%E5%88%86">
<a class="header-anchor-link" href="#%E4%BF%AE%E6%AD%A3%E3%81%8C%E5%A4%A7%E3%81%8D%E3%81%8B%E3%81%A3%E3%81%9F%E9%83%A8%E5%88%86" aria-hidden="true"></a> 修正が大きかった部分</h1>
<p>修正が大きかった部分についてピックアップしてみます。</p>
<h2 id="testing-api">
<a class="header-anchor-link" href="#testing-api" aria-hidden="true"></a> Testing API</h2>
<p><strong>v1の頃とは全然別のAPIになっています。</strong><br>
大きく書き直すことは覚悟したほうがいいかと思います。</p>
<p>私の場合既存の実装のことは忘れ、Testingについてのドキュメントを読みながら新しく書き直しました。</p>
<p>なおメインのAPIである<code>testApplication</code>メソッドは、テストの実行ごとにテスト用のKtorアプリケーションを起動する仕組みなので、Ktorアプリケーション起動時に一緒にDB接続をするような仕組みにしていると、DBへの接続過多でテストが落ちるので注意が必要です。</p>
<h2 id="ktor-client">
<a class="header-anchor-link" href="#ktor-client" aria-hidden="true"></a> Ktor client</h2>
<p>Ktor client自体、元々安定した機能じゃなかったこともあり、修正は多めでした。<br>
ただし変数名が変わったという程度の修正が多かったため、<a href="https://ktor.io/docs/migrating-2.html#client" target="_blank" rel="nofollow noopener noreferrer">migratingGuide</a>を見ながら進めれば問題なく修正できました。</p>
<h2 id="status-pages-plugin">
<a class="header-anchor-link" href="#status-pages-plugin" aria-hidden="true"></a> Status Pages Plugin</h2>
<p>特にmigrationGuideには記載はなかったですが、<a href="https://ktor.io/docs/status-pages.html" target="_blank" rel="nofollow noopener noreferrer">Status Pages Plugin</a>の挙動が微妙に変わっていました。<br>
v1だと<code>exception</code>ブロック内で、<code>call.respond(ttpStatusCode.Unauthorized)</code>的なことをすれば、<code>status</code>ブロックで処理が拾われる仕様でしたが、Ktorの内部実装を見ると<code>exception</code>ブロックに引っかかった場合は<code>status</code>ブロックの処理は呼び出されない仕様に変わっていました。</p>
<p>こういうサイレント仕様修正もあるかと思うので、充分にテストしたほうが良いかと思います。</p>
<h1 id="%E3%81%8A%E3%82%8F%E3%82%8A%E3%81%AB">
<a class="header-anchor-link" href="#%E3%81%8A%E3%82%8F%E3%82%8A%E3%81%AB" aria-hidden="true"></a> おわりに</h1>
<p>雰囲気は伝わりましたでしょうか。この記事が今後Ktor2にアップグレードする方の参考になれば幸いです！</p>
<p>最後に宣伝としてスマートラウンドの採用ページを貼っておきます。<br>
Meetyで社内メンバーとのカジュアル面談も可能なので、ご興味ある方是非お待ちしてます！<br style="display:none">
<span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__0ded489fbe854" src="https://embed.zenn.studio/card#zenn-embedded__0ded489fbe854" data-content="https%3A%2F%2Fjobs.smartround.com%2F" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://jobs.smartround.com/" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://jobs.smartround.com/</a></p>


Ktor2へアップグレードしてみた

Discussion