log.pocka.io

Vue.jsで作るSPAブログ

概要

この技術ブログは、Nuxt.jsに移行する前はVue.js(2系)を用いたSPAをNetlify上でホスティングして動いていました。

この記事ではその構築を通してわかったことや、 ブログのようなシンプルなコンテンツサイトのSPA化のメリット、デメリットについて紹介したいと思います。

フロー

フローは以下のような形になっています。

  1. ローカル開発マシンで記事を書いて、GitHubへPush
  2. GitHubへのPushを受けてNetlifyは最新のソースコードを取得する
  3. 予め指定してあるビルドコマンド(ここではnpm run build)を実行
  4. HTML,JS,posts.json(記事一覧),各記事のJSONファイルが生成されて、log.pocka.ioから閲覧可能になる

structure

npm run buildでは記事のJSONを生成する自作スクリプト(Node)と記事一覧を生成する自作スクリプト(Node)、そしてVue.jsアプリケーションとHTMLファイルをビルドするwebpackのビルドタスクを実行しています

[build] -> [build posts]     -> <post>.json
        -> [build post list] -> posts.json
        -> [build app]       -> index.html, bundle.js

自作スクリプトでやる理由

今世の中にはJekyllやHugo、Gatsbyといった様々なSSG(静的サイトジェネレータ)があります。 それにも関わらず自作のスクリプトを使う理由はなんでしょう？

一つはSPA向きのそういったツールがないことです。

SSGはStatic Site Generatorという名前の通り、テンプレートと記事を元に静的で完成されたHTMLを吐き出します。 これらはHTMLを吐き出す為に作られており、好きなフォーマットのデータファイルのみ生成するということが(当たり前ですが)難しくなっています。

また、Gatsbyの場合はランタイムがReact限定になり、バンドル処理が全てGatsbyによって隠蔽されている(SSGを使うメリットではあるが)ためチューニングが難しくなります。

もうひとつの理由としては、「MarkdownをJSONに変換する」処理が大した処理ではない、ということです。

npm上には優秀なMarkdownパーサであるmarked、Yaml Front MatterをJSONに変換するyaml-front-matter、そしてMarkdownの特殊記号を除去してただのプレインテキストに変換するremove-markdownというモジュールが(幸いにも)存在します。 そのため、生成スクリプトとして必要な処理は

  • 記事ファイルを各モジュールへ渡す
  • 生成されたJSONをファイルとして保存

のみとなるのです。

仕組み

基本的にはVue.js+Vuex+vue-routerの普通のSPAです。

Vueは2.xを使い、Single File Componentを用いて記述しています。(コンパイルにはWebpackを使用)

ルーティングとページ読み込み

ルーティングにはvue-routerを使用しており、各記事の読み込みはPostコンポーネントのロード時にfetchを叩いて実現しています(ソースコード)。 トップページやAboutページは単にコンポーネントを読み込んでいるだけですが、各記事ページではURI内/posts/:nameのnameを元にJSONファイルを取得し、その内容を反映させるようになっています。

ページ移動エフェクト

各ページの移動時にはfadeのtransitionが走るようになっています。 これはVueのtransition組込コンポーネントを使って実現しています。

ただ、vue-routerの公式ページ通りに実装すると複数のルートを同じページコンポーネントが受ける場合にtransitionが発火しません。 transitionコンポーネントは子要素が変わった場合のみtransitionイベントを発火させる為、プロパティが変わっただけでは発火しないのです(されても困りますが)。

その為、router-viewのkeyに現在のパスである$route.pathを指定し、URIが変更されるとコンポーネントを別のものとして認識させ、強制的にtransitionを発火させています。

<transition>
    <router-view :key="$route.path"></router-view>
</transition>

SPA化のメリット

上2つはどちらかというとサイトの静的化に伴うメリット

  • 読み込みの高速化
  • 静的サイトホスティングサービスがあれば運用可能
    • Amazon S3やGitHub Pages等でも可能
  • サイト内遷移の爆速化
  • デザインから何から全て自分でカスタマイズできる
  • テーマやプラグインに縛られない
  • 楽しい

SPA化によるデメリット

  • SPAを構築するだけのフロントエンドの知識が必要
  • 記事の更新にgitやmarkdownの知識が必要(Netlify CMSで解決可能)
  • 読み込むJSが少し大きくなりがち(このサイトの場合239KB(gzip 78KB))
  • JSが大きくなることによって初回ロードに少し時間がかかるようになる
  • コマンドポチポチで完成しない

まとめ

SPA化には確かにデメリットがありますが、いずれも対処して問題ないレベルまで落とし込めるようなものばかりなので、個人的には(フロントエンドエンジニアにとっては)ほぼメリットしかないと思っています。

SPAライブラリもReact+ReduxだけでなくVue(+Vuex)やAngular2、Riot.jsと様々なものがあるので、使い勝手を知ったり、実際に案件で使う前の練習として簡単なSPAブログを構築してみるのもよいかもしれませんね。