「静的サイトジェネレータ」という言葉だけで静的サイトを作った話

皆さんこんにちは。 私はつい最近静的サイトジェネレータという言葉を聞きました。 「静的」に興味を惹かれた私が、静的サイトジェネレータという言葉だけで静的サイトを作ってみた話をまとめます。 今回の記事は私の憶測が多いのでご注意ください（笑）

なお、当サイトはこの記事の通りに Laravel & wget & nginx による静的サイトとなっています。 もしご興味があれば、GitHubを見ていただけると幸いです。

静的サイトとは？

まず、静的サイトの意味から考える必要があります。 おそらくこれは静的なサイト、つまりリクエストに対して Web サーバーのレスポンスコンテンツが変わらないということです。 ということは、HTML, CSS, 画像アセットなどの静的なファイルを提供するだけのサイトであれば広義の静的サイトに当てはまります。

静的サイトのメリット・デメリット

ただ html を提供するだけの静的サイトであれば、なんだかインターネット初期の '90 年代のように感じてしまいます。 そこで、静的サイトのメリットをまとめてみました。

• Web サーバーが PHP などを実行することはないため、動的コンテンツによる脆弱性が存在しない。
• すでにレスポンスコンテンツが用意されているため、高速である。
• レンタルサーバーなどでは PHP を実行できない場合も多く、静的サイトであればサーバーに求める要件が低い。

次に、静的サイトのメリットをまとめます。

• 端末（スマホ、PC など）によってサーバーレスポンスを変化させることは難しい。
• REST API や検索機能などの提供は不可能。

静的サイトジェネレータとは？

静的サイトの意味が定まったところで、次は静的サイトジェネレータについて考えます。 これは静的サイトを作る、つまり静的サイトを作る元データがあり、それをコンパイルしたりミックスインしたり…… して、静的コンテンツを作るツールと考えられます。 ということは、PHP で動的コンテンツを作り、それを php コマンドで html 出力して Web サーバーで公開すれば、 PHP は静的サイトジェネレータになるということです。 逆に、動的コンテンツそのものを Web サーバーにアップロードし、アクセスがあった時点で PHP を実行して html をレスポンドするのであれば、 PHP は動的サイトのエンジンやエグゼキュータと呼べるのでしょう。

クローラは静的サイトジェネレータ？

以上のことを踏まえると、どんな動的コンテンツでも、サーバーからダウンロードしたときには静的コンテンツになっていることになります。 （JavaScript による DOM 操作などは、 あくまでクライアント側での動的コンテンツであり、サーバーとしては静的であるとみなします。） よって、ローカルな開発環境で動的サイトのサーバーを立ち上げ、それをクローラで html として取得すれば、 クローラは静的サイトジェネレータということになります。

Laravel & wget & nginx で静的サイトを作る

ということで、Laravel で動的サイトを作り、wget でクローリングして静的サイトを生成します。 具体的な作り方は後々新しい記事で紹介していきたいと思いますが、ここでは全体の概要を説明したいと思います。 なお、以下の例では GET クエリ（URL の ? 以降に続くクエリ）についても対応していますが、現在のところ動作確認していません。

Laravel

サイトデザインは PC とスマホで切り替える必要があっても、CSS のメディアクエリ によってクライアント側で対応するようにします。 また、検索機能などの動的なコンテンツは扱えないことを踏まえながら、開発をしていく必要があります。

wget

wget を使って、ローカルな Laravel サーバー localhost をクローリングします。 さらに、sitemap.xml やエラーページなどはリンクがないため、個別に curl でクローリングしています。 さらに、クローリングした html ファイル内に含まれる「localhost」を、デプロイ先の Webサーバーのドメインに置き換えます。 この処理をしないと、デプロイしたときにサイト内リンクが正しく機能しません。 また、nginx で GET クエリに対応するために、ファイル名を置き換えています。

# クローリング
wget -q --mirror --page-requisites --html-extension localhost
curl -s localhost/sitemap.xml -o localhost/sitemap.xml
curl -s localhost/404.html -o localhost/404.html
curl -s localhost/50x.html -o localhost/50x.html
mv localhost html

# ドメイン置換
grep -lr 'https://b-hood.site&/#039; html/* | xargs sed -i -e "s#https://b-hood.site/#${domain}#g"

# ファイル名置換
for path in `find html/ -name '*.html?*'`
do
  rename="${path//index.html?/_}"
  rename="${rename//.html?/.html_}"
  mv "${path}" "${rename}"
done

nginx

nginx で静的 html を提供しますが、URL に 〜.html がつかないように対応します。 まず、html ファイルは内部リダイレクトでのみアクセス可能とします。 そして、GET クエリがある場合は、レスポンドする html ファイルを名前解決して内部リダイレクトします。

server {
  listen       80;
  server_name  apps.bluehood.net;

  root   /usr/share/nginx/html;
  index  index.html;
  
  # エラーページ
  error_page  403 404              /404.html;
  location = /404.html {
    internal;
  }
  error_page   500 502 503 504  /50x.html;
  location = /50x.html {
    internal;
  }

  # html は内部リダイレクトのみ
  location ~ \.html$ {
    internal;
  }

  location / {
    # html ルーティング
    if ($is_args = ?) {
      # GET パラメータ名前解決
      rewrite ^(.*)$ ${uri}_${args}.html? break;
    }
  }
}

本来の静的サイトジェネレータ

以上の内容は、あくまで私が静的サイトジェネレータという言葉だけで静的サイトを作ってみた話です。 本来の静的サイトジェネレータの１つとして、GatsbyJS というものがあります。 Gatsby では、React を使うことで静的サイトでありながらも動的なコンテンツをレンダリングするようです。

なお、当サイトはこの記事の通りに Laravel & wget & nginx による静的サイトとなっています。 もしご興味があれば、GitHubを見ていただけると幸いです。