サーバーサイドレンダリング

どのようなものか

サーバーサイドレンダリングは、誰かがページを要求した時点で、そのHTML
をサーバー上で生成することです。通常はSSRと略されます。ブラウザーに
はコンテンツがすでに入った完全な文書が届き、スクリプトが動く前から表
示できます。JavaScriptフレームワークでは、その後、同じコンポーネント
がブラウザーでももう一度動き、受け取ったHTMLを引き継いで操作できるよ
うにします。

この用語が答えるのは、HTMLをいつ、どこで作るかという問いです。よくあ
る答えは3つあります。静的サイトジェネレーターはビルド時に1回作り、全
員に同じファイルを配信します。サーバーサイドレンダリングはリクエスト
ごとにサーバーで作るため、要求した人や、その時点のデータに応じたペー
ジにできます。CSRとも呼ばれるクライアントサイドレンダリングは、ほぼ
空の文書とJavaScriptのバンドルを送り、ブラウザーでページを組み立てま
す。実際のアプリケーションは、ルートごとにこの3つを使い分けることが
よくあります。

Next.jsも同じように説明しています。ドキュメントでは、ダイナミックレ
ンダリングをSSRの別名として挙げ、ページのHTMLをリクエストごとに生成
するとしています。Pages
Routerでは、ページが`getServerSideProps`という非同期関数をエクスポー
トするとSSRが有効になり、サーバーはリクエストのたびにこの関数を呼び
ます。対になる`getStaticProps`は、同じ役割をビルド時に1回だけ果たし
ます。その土台となる仕組みを提供するのがReactです。
`react-dom/server`のAPIは、コンポーネントのツリーをサーバー上でHTML
に変換します。Node.js向けの`renderToPipeableStream`やWeb
Streams向けの`renderToReadableStream`ならストリームとして、従来の
`renderToString`なら一括で生成します。Reactは最後のAPIを、機能に制限
のあるレガシーAPIとして位置付けています。

後半の処理はブラウザーで行い、ハイドレーションと呼びます。Next.jsは
最初の読み込みについて、まずHTMLで操作のできないプレビューを素早く表
示し、その後JavaScriptでコンポーネントをハイドレーションすると説明し
ています。ハイドレーションとは、Reactが既存のDOMにイベントハンドラー
を結び付け、ページが入力に反応するようにする処理です。Reactの
`hydrateRoot`リファレンスは、その利点と代償を率直に述べています。
HTMLのスナップショットによりアプリケーションの読み込みが早く見えます
が、ページは本当に操作できるようになる少し前から、準備ができたように
見えます。

なぜ重要なのか

最初の応答にコンテンツが入っています。低速な回線の利用者にも、
JavaScriptがまだ届いていない間から文字や画像を見せられます。
JavaScriptを実行しないクローラーも、空の外枠ではなく、人が見るのと同
じページを読み取れます。ブラウザーは、スクリプトを実行してからデータ
を取得するまで待たずに、実際のコンテンツを描画できます。

リクエストに応じてページを変えられる点も、静的ビルドとの違いです。
Next.jsは、認可ヘッダーや訪問者の所在地など、利用者固有のデータやリ
クエスト時にしか分からないデータには`getServerSideProps`を勧め、それ
以外にはビルド時の生成を勧めています。データの取得は、そのデータがあ
る場所の近くで行います。関数内のコードはサーバーでしか動かず、そのイ
ンポートはクライアント向けバンドルから除かれ、データベースやコンテン
ツ管理システムへ直接問い合わせられます。ブラウザーならスクリプトを読
み込んだ後に順番に送る複数のリクエストを、サーバーとの1往復で置き換
えられます。

静的サイトで省ける分が、そのまま負担になります。動作中のサーバーが必
要で、リクエストのたびにレンダリングを繰り返します。データがそろうま
で応答を開始できないため、ストリーミングを使わなければ、最も遅いクエ
リがページ全体の速度を決めます。また、サーバーで描画してもJavaScript
が不要になるわけではありません。ブラウザーはハイドレーションに必要な
すべてのコンポーネントを引き続きダウンロードし、処理が完了するまで
は、画面に見えるボタンが押しても動かないことがあります。

そのため、プロジェクト全体ではなくページごとに選ぶべき仕組みです。誰
が読んでも同じページをリクエストのたびに描画し直す利点はわずかです。
利用者によって変わるページや、分刻みで動くデータを使うページでこそ、
SSRのためにサーバーを用意する意味があります。当サイトは静的生成を採
用しています。技術構成では、適した箇所では静的生成を優先しており、こ
れらのページはリクエスト時にアプリケーションを実行する必要がありませ
ん。サイトのビルドにはHugoを使っています。

実際の活用例

次のページはこの記事のために書いたもので、Pages
Routerを使っています。ログイン済みの顧客の注文を一覧表示し、セッショ
ンのない訪問者はログインページへ送り、どのキャッシュにも結果を保存し
ないよう指示します。`readSession`と`db`は、アプリケーションが実際に
使うセッションとデータの仕組みを表す仮の名前です。

```jsx
// pages/orders.js
export async function getServerSideProps({ req, res }) {
  const session = await readSession(req.cookies.session);
  if (!session) {
    return { redirect: { destination: "/sign-in", permanent: false } };
  }

  const rows = await db.orders.listFor(session.userId);
  res.setHeader("Cache-Control", "no-store");

  return {
    props: {
      orders: rows.map((o) => ({
        id: o.id,
        number: o.number,
        status: o.status,
      })),
    },
  };
}

export default function Orders({ orders }) {
  return (
    <ul>
      {orders.map((o) => (
        <li key={o.id}>
          {o.number}: {o.status}
        </li>
      ))}
    </ul>
  );
}
```

Next.jsは`/orders`へのリクエストごとにこの関数を実行します。
`req.cookies`は、すでに解析されたリクエストのCookieヘッダーです。
`redirect`で`permanent:
false`を指定すると、恒久的ではなく一時的なリダイレクトになります。
`props`として返す値は`JSON.stringify`でシリアライズできなければなり
ません。また、Reactがサーバーと同じデータで一覧をハイドレーションで
きるよう、最初のHTMLの一部としてブラウザーにも届きます。このため、こ
の関数はデータベースの行をそのまま渡さず、ページに表示する3つの
フィールドだけに絞っています。利用者が後から`next/link`のリンクを
通ってページへ移る場合、Next.jsはサーバーに関数の再実行を求め、ペー
ジ全体を読み直さずにpropsをJSONで受け取ります。

創業者が現在NextMarinerで取り組んでいるNext.js
16のフロントエンドは、この仕組みが解決する問題を示しています。その実
績記事の出発点は、素早く表示され、操作への反応も保つ必要があった認証
付きダッシュボードです。すべてをブラウザーで取得すると初回読み込みが
遅くなり、N+1パターンも生じます。各コンポーネントが動き始めて個別に
リクエストを送るため、1つのページで通信の往復が連鎖するからです。こ
のダッシュボードと大規模なディレクトリー一覧では、現在は
`createPrefetchedServerPage`というファクトリーがサーバーでページの
データを取得し、データをそろえた状態でクライアントへ渡します。コン
ポーネントは個別に問い合わせに出ず、最初からデータを持って動き始めま
す。このファクトリーへ移行したページは、多数の往復ではなく1往復で表
示されます。同じ記事では、他の2方式も適した場所に残しています。公開
ページは利用者ごとに変わらないため静的に生成し、本当に対話的な部分は
クライアントで描画します。また、データを新鮮に保ちつつ、アプリケー
ションがすでに持つデータを再取得しないよう、データリクエストごとの
キャッシュ無効化戦略も記録しています。

問題が起きるところ

サーバーとブラウザーで出力が一致しません。
ハイドレーションは、ブラウザーの最初のレンダリングでサーバーと同じ出
力が得られることを前提にしています。`typeof
window`を調べるコンポーネント、描画中に`window.matchMedia`を呼ぶコン
ポーネント、現在時刻を表示するコンポーネントは、サーバーとブラウザー
で異なるものを描画します。Reactが挙げる原因には、両者のデータの相違
や、ルート要素内の余分な空白もあります。不一致は、軽くてもハイドレー
ションを遅らせ、最悪の場合はイベントハンドラーを別の要素に結び付けて
しまいます。そのため、`hydrateRoot`リファレンスは「不一致はバグとし
て扱い、修正すべきです」と明言しています。両側で同じものを描画してく
ださい。ブラウザーで本当に異なる表示が必要なら、まずサーバーと同じも
のを描画し、ハイドレーション後にエフェクトで切り替えます。ただし、こ
れには2回目のレンダリングが必要です。`suppressHydrationWarning`はタ
イムスタンプなど避けられない差に限って使い、1階層分にしか効かないこ
とにも注意します。

秘密情報がpropsと一緒に届きます。
propsとして返すものはすべて、ブラウザーでハイドレーションできるよう
最初のHTMLに書き込まれます。Next.jsのドキュメントは、機密情報をこの
方法で渡さないよう警告しています。利用者のレコード全体を返す関数は、
ページのソースを開いた誰にでもパスワードハッシュや内部フラグを渡して
しまいます。上の例のように、ページに表示するフィールドだけを返しま
す。

共有キャッシュが、ある利用者のページを次の利用者へ配ります。
Next.jsのドキュメントは、サーバーで描画したページのキャッシュ例に
`Cache-Control: public,
s-maxage=10,
stale-while-revalidate=59`を使っています。これを個人向けのページにコ
ピーすると、サーバーの前にあるコンテンツ配信ネットワークやプロキシ
に、応答を保存して次に要求した人へ渡すよう許可してしまいます。RFC
9111では、`public`は通常なら拒む応答の保存をキャッシュへ許可するも
の、`s-maxage`は共有キャッシュ向けの有効期間と定義されています。どち
らの指定も、`Authorization`ヘッダーを持つリクエストへの応答を共有
キャッシュが再利用できないという規則を解除します。Cookieや認証情報に
基づくページには、共有キャッシュでの保存を禁止する`private`か、すべ
てのキャッシュでの保存を禁止する`no-store`が必要です。

最も遅いクエリがページ全体を待たせます。
ページを一括で描画すると、その裏で動くすべてのクエリが返るまで何も送
られません。1つの遅いクエリが、ヘッダーもナビゲーションも他のすべて
も遅らせます。Reactのストリーミングレンダラーは、`<Suspense>`の境界
でページを分けます。どの境界の内側にもない部分であるシェルは、準備で
き次第、未完了部分の代替表示を入れて送ります。その後、残りの部分を順
に流し、小さなインラインスクリプトで差し替えます。早く送ることには注
意点があります。ストリーミングの開始後はステータスコードを変更できな
いため、レコードの欠落や検査の失敗はシェルを送る前に確定させる必要が
あり、エラーステータスを設定する場所は`onShellError`です。

参考資料

  * サーバーサイドレンダリング（SSR） —
リクエストごとのHTML生成と、`getServerSideProps`と`getStaticProps`の
違いについてのNext.jsの説明です。

  * getServerSideProps —
使う場面、最初のHTMLでクライアントに届くもの、`Cache-Control`による
キャッシュを説明しています。

  * サーバー向けReact DOM API —
コンポーネントをサーバー上でHTMLに変換するための、ストリーミングAPI
と従来のAPIです。

  * hydrateRoot —
Reactによるサーバー生成HTMLの引き継ぎと、ハイドレーションの不一致の
よくある原因を説明しています。

  * renderToPipeableStream —
シェル、`<Suspense>`の境界、ストリーミング時のステータスコードの注意
点を説明しています。

  * RFC 9111：HTTPキャッシュ —
`public`、`private`、`s-maxage`、`no-store`の各ディレクティブと共有
キャッシュの規則を説明しています。

hこのページのウェブ版	URL:https://engineer.company/ja/glossary/server-side-rendering/	engineer.company	70
