<p data-line="0" class="code-line">こんにちは、株式会社スマートラウンドの<a href="https://x.com/tsukakei1012" target="_blank" rel="nofollow noopener noreferrer">tsukakei1012</a>です！</p>
<p data-line="3" class="code-line">私達が開発しているプロダクトsmartroundではKotlin製のWebフレームワークであるKtorをバージョン1.0.0-betaの頃から利用しており、3年ほど前にはバージョン2へアップグレードしました。</p>
<p data-line="5" class="code-line"><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__f474e7dd439f4" src="https://embed.zenn.studio/card#zenn-embedded__f474e7dd439f4" data-content="https%3A%2F%2Fzenn.dev%2Fsmartround_dev%2Farticles%2F2-ktor-2-upgrade" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://zenn.dev/smartround_dev/articles/2-ktor-2-upgrade" style="display:none" target="_blank">https://zenn.dev/smartround_dev/articles/2-ktor-2-upgrade</a></p>
<p data-line="8" class="code-line">先日Ktorのバージョン3が出たため、再度メジャーバージョンのアップグレードをしました。</p>
<p data-line="10" class="code-line">その感想やハマりどころについて雑に書いてみたいと思います！</p>
<h1 id="ktor3%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" data-line="12" class="code-line">
<a class="header-anchor-link" href="#ktor3%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> Ktor3のアップデート内容</h1>
<p data-line="14" class="code-line">Ktor2からKtor3へのアップデートは、いくつかの主要な変更点と改善が含まれていますが、その中でも個人的に嬉しいのは<strong>Server-Sent Events (SSE) のサポート</strong>でしょうか。</p>
<p data-line="16" class="code-line">弊プロダクト内でいくつかWebSocketを使った実装がありますが、そのうちのいくつかはSSEに置換できるのではないかと企んでいます。</p>
<p data-line="18" class="code-line"><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__a000c4153f355" src="https://embed.zenn.studio/card#zenn-embedded__a000c4153f355" data-content="https%3A%2F%2Fblog.jetbrains.com%2Fkotlin%2F2024%2F10%2Fktor-3-0%2F" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://blog.jetbrains.com/kotlin/2024/10/ktor-3-0/" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://blog.jetbrains.com/kotlin/2024/10/ktor-3-0/</a></p>
<h1 id="%E3%81%A9%E3%81%AE%E3%81%8F%E3%82%89%E3%81%84%E5%A4%A7%E5%A4%89%E3%81%A0%E3%81%A3%E3%81%9F%EF%BC%9F" data-line="20" class="code-line">
<a class="header-anchor-link" href="#%E3%81%A9%E3%81%AE%E3%81%8F%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 data-line="22" class="code-line">メジャーバージョンのアップグレードということもあり、まる1日ぐらいかかりました。<br>
<a href="https://ktor.io/docs/migrating-3.html" target="_blank" rel="nofollow noopener noreferrer">マイグレーションガイド</a>が整備されていたので、ある程度まで作業はさくさく進みましたが、後述するようなハマりどころがガイドに記載されておらず、いくつかは直接Ktorのソースコードを参考にして修正する必要がありました😇</p>
<h1 id="%E3%82%84%E3%81%A3%E3%81%9F%E3%81%93%E3%81%A8%E3%81%A8%E3%83%8F%E3%83%9E%E3%81%A3%E3%81%9F%E3%81%A8%E3%81%93" data-line="25" class="code-line">
<a class="header-anchor-link" href="#%E3%82%84%E3%81%A3%E3%81%9F%E3%81%93%E3%81%A8%E3%81%A8%E3%83%8F%E3%83%9E%E3%81%A3%E3%81%9F%E3%81%A8%E3%81%93" aria-hidden="true"></a> やったこととハマったとこ</h1>
<h2 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" data-line="29" class="code-line">
<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> パッケージ名変更</h2>
<p data-line="31" class="code-line">2系では<code>io.ktor.server.plugins.callloging</code>だったのを、3系では<code>io.ktor.server.plugins.calllogging</code>になったので、それを直すだけでした。</p>
<p data-line="33" class="code-line"><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__32e132cd2a762" src="https://embed.zenn.studio/card#zenn-embedded__32e132cd2a762" data-content="https%3A%2F%2Fktor.io%2Fdocs%2Fmigrating-3.html%23calllogging-plugin-package-has-been-renamed" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://ktor.io/docs/migrating-3.html#calllogging-plugin-package-has-been-renamed" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://ktor.io/docs/migrating-3.html#calllogging-plugin-package-has-been-renamed</a></p>
<h2 id="websocket%E3%81%AE%E8%A8%AD%E5%AE%9A%E6%96%B9%E6%B3%95%E3%81%AE%E5%A4%89%E6%9B%B4" data-line="35" class="code-line">
<a class="header-anchor-link" href="#websocket%E3%81%AE%E8%A8%AD%E5%AE%9A%E6%96%B9%E6%B3%95%E3%81%AE%E5%A4%89%E6%9B%B4" aria-hidden="true"></a> WebSocketの設定方法の変更</h2>
<p data-line="37" class="code-line">WebSocketのconfigurationで2系では<code>java.time.Duration</code>を使っていたのが、3系では<code>kotlin.time.Duration</code>になったので、それに合わせて修正しました。</p>
<p data-line="39" class="code-line"><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__3e005159c3ddf" src="https://embed.zenn.studio/card#zenn-embedded__3e005159c3ddf" data-content="https%3A%2F%2Fktor.io%2Fdocs%2Fmigrating-3.html%23replacement-of-java-time-in-websockets-configuration" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://ktor.io/docs/migrating-3.html#replacement-of-java-time-in-websockets-configuration" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://ktor.io/docs/migrating-3.html#replacement-of-java-time-in-websockets-configuration</a></p>
<h2 id="session%E3%81%AEserializer%E5%A4%89%E6%9B%B4%EF%BC%88%E3%83%8F%E3%83%9E%E3%81%A3%E3%81%9F%E3%81%A8%E3%81%93%E2%91%A0%EF%BC%89" data-line="41" class="code-line">
<a class="header-anchor-link" href="#session%E3%81%AEserializer%E5%A4%89%E6%9B%B4%EF%BC%88%E3%83%8F%E3%83%9E%E3%81%A3%E3%81%9F%E3%81%A8%E3%81%93%E2%91%A0%EF%BC%89" aria-hidden="true"></a> SessionのSerializer変更（ハマったとこ①）</h2>
<p data-line="43" class="code-line">超重要な変更にも関わらず、（いまだにマイグレーションガイドにも記載されていないのですが、）SessionのデフォルトのSerializerがしれっと変更されていました。</p>
<p data-line="45" class="code-line">それに伴って、Sessionに使うデータクラスにも<code>@Serializable</code>をつける必要があります。</p>
<p data-line="47" class="code-line"><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__628800dcd2ca6" src="https://embed.zenn.studio/card#zenn-embedded__628800dcd2ca6" data-content="https%3A%2F%2Fktor.io%2Fdocs%2Fserver-sessions.html" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://ktor.io/docs/server-sessions.html" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://ktor.io/docs/server-sessions.html</a></p>
<p data-line="49" class="code-line">また、デフォルトのSerializerが変更されたため、基本的には2系でシリアライズされたセッション情報はデシリアライズできないのですが、<a href="https://api.ktor.io/ktor-server/ktor-server-plugins/ktor-server-sessions/io.ktor.server.sessions.serialization/-kotlinx-backward-compatible-session-serializer.html" target="_blank" rel="nofollow noopener noreferrer">KotlinxBackwardCompatibleSessionSerializer</a>を使うことでこの問題は回避できます。</p>
<h2 id="partdata.fileitem.streamprovider()%E3%81%8C%E4%BE%8B%E5%A4%96%E3%82%92%E6%8A%95%E3%81%92%E3%82%8B%E3%82%88%E3%81%86%E3%81%AB%E3%82%B5%E3%82%A4%E3%83%AC%E3%83%B3%E3%83%88%E4%BB%95%E6%A7%98%E5%A4%89%E6%9B%B4%E3%81%97%E3%81%A6%E3%81%84%E3%81%9F%EF%BC%88%E3%83%8F%E3%83%9E%E3%81%A3%E3%81%9F%E3%81%A8%E3%81%93%E2%91%A1%EF%BC%89" data-line="52" class="code-line">
<a class="header-anchor-link" href="#partdata.fileitem.streamprovider()%E3%81%8C%E4%BE%8B%E5%A4%96%E3%82%92%E6%8A%95%E3%81%92%E3%82%8B%E3%82%88%E3%81%86%E3%81%AB%E3%82%B5%E3%82%A4%E3%83%AC%E3%83%B3%E3%83%88%E4%BB%95%E6%A7%98%E5%A4%89%E6%9B%B4%E3%81%97%E3%81%A6%E3%81%84%E3%81%9F%EF%BC%88%E3%83%8F%E3%83%9E%E3%81%A3%E3%81%9F%E3%81%A8%E3%81%93%E2%91%A1%EF%BC%89" aria-hidden="true"></a> <code>PartData.FileItem.streamProvider()</code>が例外を投げるようにサイレント仕様変更していた（ハマったとこ②）</h2>
<p data-line="54" class="code-line">以前からDeprecatedになっていた<code>PartData.FileItem.streamProvider()</code>でしたが、これが例外を投げるような実装になっており、検証フェーズで発見されました。</p>
<p data-line="56" class="code-line"><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__6940026b90fb6" src="https://embed.zenn.studio/card#zenn-embedded__6940026b90fb6" data-content="https%3A%2F%2Fyoutrack.jetbrains.com%2Fissue%2FKTOR-7731" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://youtrack.jetbrains.com/issue/KTOR-7731" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://youtrack.jetbrains.com/issue/KTOR-7731</a></p>
<p data-line="58" class="code-line">改修自体はすぐにできましたが、マイグレーションガイドにも当時は記載がなかったため、めちゃくちゃ焦りました。（今は無事にマイグレーションガイドに載っています！）</p>
<p data-line="60" class="code-line"><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__e9418dc513151" src="https://embed.zenn.studio/card#zenn-embedded__e9418dc513151" data-content="https%3A%2F%2Fktor.io%2Fdocs%2Fmigrating-3.html%23partdata-fileitem-streamprovider-is-deprecated" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://ktor.io/docs/migrating-3.html#partdata-fileitem-streamprovider-is-deprecated" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://ktor.io/docs/migrating-3.html#partdata-fileitem-streamprovider-is-deprecated</a></p>
<h2 id="%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%82%A2%E3%83%83%E3%83%97%E3%83%AD%E3%83%BC%E3%83%89%E6%A9%9F%E8%83%BD%E3%81%A750mb%E3%82%92%E8%B6%85%E3%81%88%E3%82%8B%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%8C%E3%82%A2%E3%83%83%E3%83%97%E3%83%AD%E3%83%BC%E3%83%89%E3%81%A7%E3%81%8D%E3%81%AA%E3%81%8F%E3%81%AA%E3%81%A3%E3%81%9F%EF%BC%88%E3%83%8F%E3%83%9E%E3%81%A3%E3%81%9F%E3%81%A8%E3%81%93%E2%91%A2%EF%BC%89" data-line="63" class="code-line">
<a class="header-anchor-link" href="#%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%82%A2%E3%83%83%E3%83%97%E3%83%AD%E3%83%BC%E3%83%89%E6%A9%9F%E8%83%BD%E3%81%A750mb%E3%82%92%E8%B6%85%E3%81%88%E3%82%8B%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%8C%E3%82%A2%E3%83%83%E3%83%97%E3%83%AD%E3%83%BC%E3%83%89%E3%81%A7%E3%81%8D%E3%81%AA%E3%81%8F%E3%81%AA%E3%81%A3%E3%81%9F%EF%BC%88%E3%83%8F%E3%83%9E%E3%81%A3%E3%81%9F%E3%81%A8%E3%81%93%E2%91%A2%EF%BC%89" aria-hidden="true"></a> ファイルアップロード機能で50MBを超えるファイルがアップロードできなくなった（ハマったとこ③）</h2>
<p data-line="65" class="code-line">（事の詳細については弊社エンジニアのsiosioさんが描いてくれたブログ記事を読んでいただきたいです！）</p>
<p data-line="67" class="code-line"><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__8fcd6c1f99471" src="https://embed.zenn.studio/card#zenn-embedded__8fcd6c1f99471" data-content="https%3A%2F%2Fsiosio.hatenablog.com%2Fentry%2F2025%2F02%2F05%2F082046" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://siosio.hatenablog.com/entry/2025/02/05/082046" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://siosio.hatenablog.com/entry/2025/02/05/082046</a></p>
<p data-line="69" class="code-line"><code>ApplicationCall.receiveMultipart()</code>によるアップロードでファイルサイズに50MBの最大値がデフォルト設定されていました。（これも当時はサイレント仕様変更😇）</p>
<p data-line="71" class="code-line">こちらも検証フェーズで発見し、すぐ改修できたからよかったものの、めちゃくちゃ焦りました。（こちらも今は無事にマイグレーションガイドに載っています！）</p>
<p data-line="73" class="code-line"><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__992079ff59568" src="https://embed.zenn.studio/card#zenn-embedded__992079ff59568" data-content="https%3A%2F%2Fktor.io%2Fdocs%2Fmigrating-3.html%23new-default-limit-for-binary-and-file-items" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://ktor.io/docs/migrating-3.html#new-default-limit-for-binary-and-file-items" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://ktor.io/docs/migrating-3.html#new-default-limit-for-binary-and-file-items</a></p>
<h1 id="%E7%B5%82%E3%82%8F%E3%82%8A%E3%81%AB" data-line="76" class="code-line">
<a class="header-anchor-link" href="#%E7%B5%82%E3%82%8F%E3%82%8A%E3%81%AB" aria-hidden="true"></a> 終わりに</h1>
<p data-line="78" class="code-line">当時は<a href="https://note.com/smartround/n/ne009df92ac9b" target="_blank" rel="nofollow noopener noreferrer">育休明け</a>で、手元に大きな開発タスクがなかったこともあり、Ktorアップグレードを行いました。</p>
<p data-line="80" class="code-line">しかし、その後のマイグレーションガイドの充実ぶりを見ると、少し間を空けたほうがよかったのかなと反省しています。</p>
<p data-line="82" class="code-line">どのハマりポイントも検証フェーズまでには発見、かつすぐに各エンジニアが問題発見&amp;解決方法を見つけ出してくれ、チームには大きく助けていただきました🙏</p>
<p data-line="84" class="code-line">この記事が今後Ktor3にアップグレードする方の参考になれば幸いです！</p>
<p data-line="86" class="code-line">最後に宣伝です！<br>
KotlinのことでもAI開発のことでも何でもカジュアルに話せますので、ご興味ある方是非お待ちしてます！<br style="display:none">
<span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__b403f545ddd7e" src="https://embed.zenn.studio/card#zenn-embedded__b403f545ddd7e" 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>


Ktor3へアップグレードした

SessionのSerializer変更（ハマったとこ①）

PartData.FileItem.streamProvider()が例外を投げるようにサイレント仕様変更していた（ハマったとこ②）

ファイルアップロード機能で50MBを超えるファイルがアップロードできなくなった（ハマったとこ③）

Discussion