💨

[Server-Side Swift] Vaporで定期実行してiOS向けの情報/記事をまとめる

2021/12/14に公開約3,800字

(本記事はZOZO Advent Calendar 2021のカレンダー5の15日目です。)

Swiftでサーバーサイドも体験してみたくなったのでVaporで簡単なものをつくってみました。
そのご紹介です。

つくったもの

yyokii/AppleDeveloperNews

  • Appleの開発者、とりわけiOSアプリ開発者向けの情報まとめ
  • 毎週日曜に自動更新される

目的

  • Vaporを触ってみたかった
  • Async/Awaitを使いたかった
  • 気になる情報は定期的に追いたいと思いつつも、気づいたらベースでみるようになっていたので、自分で作れば見るかなと思いつくってみた

技術的ポイント

Async/Await

Swift5.5から使えるasync/awaitキーワードを用いた非同期プログラミングが可能です。

Vaporには非同期プログラミングをサポートするためにSwiftNIOを取り入れています。
しかし、Swift 5.5からは Concurrency の言語機能が追加されたためasync/awaitキーワードを用いて書くことができるようになりました。

例えば以下のようにSwiftNIOベースのEventLoopFutureに基づいた記述があるとすると

return someMethodCallThatReturnsAFuture().flatMap { futureResult in
    // use futureResult
}

次のように書き換えることができます。(Vapor: Basics → Async migrating-to-asyncawait より)

let futureResult = try await someMethodThatReturnsAFuture().get()

どちらの書き方を採用するかについてですが、

  • EventLoopFuture : Event Loopを制御したい場合 or 高いパフォーマンスを期待する場合
  • async/await : 多くの場合これで事足りる。パフォーマンスは劣るが、その機能や可読性がもたらすメリットの方が大きい

ということのようです。

For applications that need explicit control over event loops, or very high performance applications, you should continue to use EventLoopFutures until custom executors are implemented. For everyone else, you should use async/await as the benefits or readability and maintainability far outweigh any small performance penalty.

Vapor: Basics → Async

ConcurrencyのキャッチアップとしてVaporで試してみるのも良さそうですね。
また、iOSアプリ開発などでConcurrencyを使っている人はその知識をそのまま利用できて良いですね。

スケジューリング

スケジューリングするためにVaporのQueuesを利用しました。
現状公式にサポートしているドライバーはQueuesRedisDriverです。(従ってRedisを利用しています。)

ScheduledJob もしくは AsyncScheduledJob に準拠したものをつくり、それを登録することでジョブのスケジューリングができます。

名前からわかるようにAsyncScheduledJob Concurrency機能に対応しています。

例えば今回のコンテンツの生成とgithubの更新ジョブは、次のように記述しています。

struct GenerateAppleDevNewsJob: AsyncScheduledJob {
    init() {}
    
    func run(context: QueueContext) async throws {
        let client = context.application.client
        let content = try await generateMdContent(client: client) // コンテンツの生成
        try await updateGitHub(client: client, content: content.content) // gihubのREADME更新
    }
  .
  .
  .

configure(アプリの設定処理を書くところ)内

    let generateAppleDevNews = GenerateAppleDevNewsJob()
    // スケジュールを設定して定期実行
    app.queues.schedule(generateAppleDevNews)
        .weekly()
        .on(.sunday)
        .at(.noon)
    try app.queues.startScheduledJobs()

データの取得

RSSとしてデータ提供がされていないものがあったのでいくつかはスクレイピングをしています。

RSSによる取得

RSSのレスポンスをパースするのは面倒だったので、RSS to JSON Converter onlineを利用しレスポンスをJSON化して利用しました。

スクレイピング

HTMLパーサーとしてSwiftSoupを利用しました。
Swift製のHTMLパーサーでありSwift Package Managerへ対応し、スターは3Kほどあります。
今回は特定ページから特定コンテンツを取得するというシンプルな利用でしたが、直感的に使えて便利でした。

おわりに

触ってみるとやはり楽しいので今後も何かつくっていけたらなと思いました。

注意点としては、swift-corelibs-foundation(Darwin以外のプラットフォームではFoundationを使用できるようにするためのSwiftライブラリ)とローカルで開発しているときに利用できるAPIとでは差異がある場合がある(swift-corelibs-foundationが少し遅い)ので、Dockerなどでデプロイ先の環境を実現しそこでビルドやテスト実行しておくことが大事と感じました。

何かの参考になれば幸いです。

参考

GitHubで編集を提案

Discussion

ログインするとコメントできます