SERVER FRIENDLY
大学のサーバーに、
迷惑をかけない。
つくぷらは筑波大学の学生が作っている非公式アプリです。 manaba・TWINS・KdBといった大学のシステムは、筑波大生みんなの学びを支える共有のインフラ。 だからこそ「サーバーに余計な負荷をかけない」ことを、機能と同じくらい大切な設計目標にしています。 このページに出てくる数値は、すべてアプリの実装コードにある値そのままです。
PRINCIPLES
負荷を増やさないための、4つの原則。
アプリからの通信は、この順番の考え方で設計しています。
1. まずキャッシュを読む
一度取得したデータは端末に持ち、期限が切れるまではサーバーへ行きません。
2. 同期には最低間隔
自動同期は前回からの経過時間を必ず確認し、間隔が空くまで動きません。
3. 取得には上限
1回のチェックで読むページ数・件数に上限を置き、それ以上は読みません。
4. だめならすぐ引く
すべての通信にタイムアウトを設定。つながらない時は接続を引きずりません。
CACHE FIRST
まずキャッシュ。サーバーは「どうしても」の時だけ。
画面を開くたびにサーバーへ取りに行くのではなく、端末の中に持っているデータを先に使います。 サーバーへのアクセスは、キャッシュの期限が切れた時だけです。
キャッシュが効く仕組み
機能ごとに適切な保持期間を決めて、同じデータを何度も取りに行かないようにしています。
- 試験まとめ(KdBシラバス)は一度取得したら端末に保存。再取得が走るのはユーザーが更新操作をした時だけで、24時間経過後も「更新を促す」表示にとどめ、勝手に再取得はしません
- バス時刻表はアプリに内蔵。オンライン更新分も開発者が管理する配信データ(GitHub)から取得するため、時刻表のために大学や交通事業者のサーバーへアクセスすることはありません。取得後1時間はメモリキャッシュを使い、同時に複数の取得が走りそうな時は1本に合流させます
- 「いまヒマ」のクラウド読み取りも同じ方針です。常時接続のリアルタイムリスナーは使わず、必要な時に1回だけ読む get() 方式+10分のメモリキャッシュで読み取り回数を抑えています
図1: キャッシュが効く仕組み。サーバーへ行くのは点線の経路だけです。
THROTTLE
manabaの自動同期は、60分に1回まで。
課題の自動同期は便利ですが、放っておくとサーバーへのアクセスが増えがちな機能でもあります。 つくぷらでは「同期しすぎない」仕組みを何重にも入れています。
同期スロットルの仕組み
自動同期は、前回の同期からの経過時間を必ず確認してから動きます。
- 初期設定はオフ。設定でONにした人の端末だけが同期します
- 前回同期から60分未満の間は、アプリを何度起動・復帰させても同期しません
- バックグラウンド同期も約60分周期で、同じ「60分ルール」を尊重します
- 同時に走る同期は常に1本だけ(多重実行ガード)。手動の「今すぐ同期」を連打しても、実行されるのは1回分です
- manabaへのログインは、同期が実際に走る時だけ行い、終わったらセッションを必ず破棄(Cookie消去・接続クローズ)します
- 読み取るのは課題の集約ページ3枚(レポート・小テスト・アンケート)だけ。履修コースを1つずつ巡回することはありません
- 大学のシステムの画面が変わって取り込みがうまくいかなくなったときに備え、運営側でmanaba・TWINSの取り込みを一時停止できる仕組み(Firebase Remote Config)を入れています。停止中はアプリにその旨を表示し、大学のサーバーへのアクセスを止めます
図2: 同期スロットルのタイムライン。間隔が空くまで同期は走りません。
TWINS SYNC
TWINS連携の自動照合は、12時間に1回まで。
TWINS連携は、アプリでの履修登録・削除をTWINSへ反映し、TWINSの登録状況と照合する機能です。 履修という大事な手続きを扱い、1回の確認に必要なページ数も多いため、manabaの同期よりさらに控えめに動かしています。
照合と反映の上限
自動の照合は、前回の照合からの経過時間を必ず確認してから動きます。
- 初期設定はオフ。設定でONにして確認に同意するまで、TWINS連携としてのログイン・照合・反映は一切行いません
- 自動の照合は、前回から12時間(半日)たつまで行いません。失敗したときも、再試行は1時間以上あけます
- TWINSの履修登録一覧は1モジュールずつしか表示されないため、照合では全モジュールを順番にたどります。1件の登録・削除でも確認を含めて約20リクエストかかるので、背景タスクで反映する未反映の操作は1回につき1件までに絞っています
- ログインと書き込みは常に1本ずつ(多重実行ガード)。同時に複数の操作を走らせません
- ID・パスワードが拒否されたら自動での再ログインを止め、3回続けてログインに失敗したら24時間は自動で試しません。メンテナンス中の連打や、パスワード誤りによるアカウントロックを防ぎます
- 対象は現在の年度の履修だけ。反映できなかった操作の再試行も5回までで打ち切り、通知でお知らせします
- 成績・GPAの機能は、TWINSの「成績照会」で自分でダウンロードしたCSVファイルを取り込む方式です。成績のためにアプリがTWINSへアクセスすることはありません
図3: TWINS自動照合のタイムライン。この間隔を待たずに照合するのは、設定の「今すぐTWINSと照合」や時間割の「TWINSから取り込む」を自分で押したときだけです。
REQUEST BUDGET
1回のチェックに、リクエストの上限。
試験クイックチェックや大学お知らせのように外部ページを読む機能は、 「何を・何件まで読むか」をあらかじめ決めて、それ以上は読みません。
試験チェックは、ユーザーが押した時だけ。
試験クイックチェックのmanabaアクセスは、ユーザーが「manaba連携」を明示的に実行した時だけ行います。自動でmanabaにアクセスすることはありません。
- 1科目あたりの取得は、ニュース一覧1ページ+ニュース本文 最大12件、コースページ一覧1ページ+本文 最大10件で打ち切ります
- manaba側に対応するコースが見つからない科目には、1リクエストも送りません
- リクエストは1件ずつ順番に送り、並列で一斉にアクセスしません(1リクエストは15秒で打ち切り)
- KdBシラバスの一括取得は同時5接続までに制限し、科目数が多くても一斉アクセスにならないようにしています
- 取得した試験まとめは端末にキャッシュされるため、結果を見直すだけなら再アクセスは発生しません
図4: 1回のチェックで送るリクエスト数の上限(1科目あたり)。
大学お知らせは、公開ページに1リクエスト。
TWINSの掲示一覧は、ログイン不要の公開ページを1回取得するだけです。 サーバーから見れば、ブラウザでページを1回開いたのと同じ負荷しかかかりません。
- 一覧の取得は公開ページへの1リクエストだけで完結します
- 重いHTML解析はサーバーではなく、端末内の別スレッド(isolate)で実施します
- 掲示の本文は、ユーザーが開いたその1件だけを取得します
図5: 取得は1回、解析の仕事は大学ではなく端末側が引き受けます。
TIMEOUT
つながらない時は、すぐ引き下がる。
障害や混雑でサーバーが重い時に接続を保持し続けると、それ自体が負荷になります。 つくぷらの通信にはすべて明示的なタイムアウトを設定しています。
接続を引きずらない
- manabaログイン15秒・KdBシラバス15秒・バス時刻表15秒・TWINSお知らせ20秒・TWINS連携15秒(背景では7秒)で打ち切ります
- バックグラウンド処理は全体をmanaba同期25秒・TWINS照合22秒以内に収め、超えたら静かに終了します
- 失敗してもその場で連続リトライはせず、キャッシュや内蔵データで表示を続けます
- manabaのログインセッションは使い終わるたびに必ず破棄し、接続を閉じます
図6: ここまで待ってつながらなければ、接続を打ち切ります。