37
Help us understand the problem. What are the problem?

More than 1 year has passed since last update.

posted at

updated at

Organization

Vercel + Next.js + micro CMSで作る、jamstackなCMS構築

概要

こんにちは、都内でフロントエンドエンジニアをしてますかめぽんです。先日、便利なツールしか開発しないことで有名なあのZEITの名前が変わりVercelになった、というニュースは記憶に新しいかと思います。どんどん使い勝手がよくなっていくということで注目していきたいわけですが、昨今ではjavascrptあるいはtypescriptを中心としたアプリケーションが主流になっている中で、jamstackと呼ばれるアーキテクチャが注目されていると思います。jamstack自体は過去に執筆した記事でも紹介していて、基礎的な内容はそちらで確認してみてください。

以前はNuxt.js + Contentful + Netlifyの組み合わせでやってみましたが、今回はVercelのプロダクトと国産のヘッドレスCMSで有名なmicro CMSを使って、jamstackなブログサイトを作ってみたいと思います。

top1.png

jamstackな構成は気になっている人も多かと思いますが、コンテンツとViewを切り離せることやパフォーマンスの観点でもかなり強いので、この記事で体系的な知識群として参考にしてもらえれば、と思います。今回の記事は割とボリュームが多いですが、一通りやればjamstackなcms構築はなんとなく肌感は掴めると思うので、ぜひ最後まで読んでみてください。

アークテクチャ

top2.png

  • Next.js
  • Vercel (旧ZEIT now)
  • micro CMS

今回使う構成は以上の通りで、クライアントサイドはNext.jsを使い、コンテンツマネジメントはmicro CMS、そしてVercelでホスティングをします。そして、コンテンツの公開時や変更がされた場合micro CMSからVercelに対してWebhookでPOSTをし、最新の情報を取り込んだ静的コンテンツとしてホスティングされる、という流れを作っていきます。

URLは以下の様に設計していきます。//aboutは完全に静的なコンテンツであるため、今回は /blogs/blogs/:idについて書いていきます。

/
/about
/blogs // コンテンツを一覧で表示する
/blogs/:id // 該当するコンテンツの詳細を表示する

micro CMSの準備

最初にコンテンツの管理をしますが、事前にmicro CMSのアカウントを作成し専用のワークスペースを作っておいてください。

APIの設定

micro CMSでやることは、APIのエンドポイントの作成、スキーマの設定、コンテンツの作成になります。管理画面に入ってもらい、画面左上のコンテンツの右側の+ボタンを押します。

cms1.png

そうするとAPIの設定に入っていくので画面に従って入力していきます。APIのエンドポイントはNext.js側のURL設計と合わせるため同じ名前にします。

APIスキーマの設定

APIスキーマの設定で、リスト形式とオブジェクト形式の選択がありますが今回はリスト形式を選択します。次にスキーマを設定していきますが、記事のタイトル(title)、日付(date)、本文コンテンツ(content)の3つを用意します。一項目につきフィールドID、表示名、種類

cms2.png

コンテンツの作成

APIスキーマの設定が終わると以下の画面が出ると思います。ここから記事を増やしていきます。

cms3_1.png

とりあえず3つほど作ってみます。

cms3_2.png

Next.jsの準備

ここからは実際にコンテンツを受け取り表示するNext.js部分を準備していきます。実際に作ったソースはGithubに載せておきますので参考にしてみてください。

ディレクトリ構成は以下の様にしています。ちなみに、Next.jsではダイナミックルーティングをするときに blogs/[id].tsxの様に、ファイル名を[]で括ることで動的ルーティングに対応します。また、[]で括られた名前をコード内で取得することが出来ます。後で紹介します。

components/ //共通コンポーネントの置き場
service/
 └─blogs.ts micro //CMSにアクセスするためのAPIユーティリティ
pages/
 ├─ index.tsx
 ├─ about.tsx
 └─ blogs/
         ├─ index.tsx  // 記事コンテンツの一覧表示ページ
         └─ [id].tsx  // 単体記事のページ

next.config.jsの設定

micro CMSにリクエストを送る際に、X_API_KEYをセットします。

require("dotenv").config({path: './.env'}); //プロジェクト直下においた環境変数ファイルを読み込む
...
module.exports = {
    ...
    env: {
    X_API_KEY: process.env.X_API_KEY
  }
    ...
};

X_API_KEYはmicro CMSのAPIリファレンスで確認することが出来ます。それをプロジェクト直下の .envファイルに記述しnext.configでセットします。

cms4.png

Service層の準備

Service層では主にAPI取得に関する機能を提供します。getBlogsは記事の全権取得で/blogs/で使い、getBlogByは/blogs/:idで使います。

import axios from 'axios';

const X_API_KEY: string = process.env.X_API_KEY || '';

export const getBlogs = () => (
  axios.get('https://sample-cms.microcms.io/api/v1/blogs', { headers: {
    'Content-type': 'application/json',
    'X-API-KEY': X_API_KEY
  }})
)

export const getBlogBy = id => (
  axios.get('https://sample-cms.microcms.io/api/v1/blogs/' + id, { headers: {
    'Content-type': 'application/json',
    'X-API-KEY': X_API_KEY
  }})
)

コンポーネントの準備

componets/templates/navigations.tsx

各ページで使うナビゲーションメニューを用意します。

import * as React from 'react';
import Link from 'next/link'

const containerStyle = {
  display: 'flex'
}

const itemStyle = {
  padding: 10
}

const Navigation: React.FC = () => {
  return (
    <div style={containerStyle}>
      <Link href="/">
        <p style={itemStyle}>Index</p>
      </Link>
      <Link href="/about">
        <p style={itemStyle}>About</p>
      </Link>
      <Link href="/blogs">
        <p style={itemStyle}>Blogs</p>
      </Link>
    </div>
  )
}
export default Navigation

pages/blogs/index.tsx

blogの一覧ページでやることは、serivece/blogsのgetBlogsでmicro CMSに保存している記事一覧を取得し、ページに表示させます。今回はコンテンツが正しく取得できるか検証するためスタイルの実装は最低限にしています。

Netx.jsで新しく追加されたgetStaticPropsでページコンポーネントが表示される前のタイミングでデータをフェッチします。getStaticPropsは前のバージョンで使われていたgetInitialPropsに変わるもので、プリレンダリング専用の関数になります。jamstack構成や静的サイトで取り扱う場合に使うと良いでしょう。

もう一つ、getServerSidePropsもNext.jsの新しいバージョンから推奨してますがこちらはサーバーサイドレンダリングで作動するものなので今回は使いません。

記事一覧を動的にリンク化させるために、<Link href="/blogs/[id]" as={/blogs/${id}}></Link>  の記述をします。これを行うことによりパスに記事のidを付与することが出来ます。

import { NextPage } from 'next';
import Link from 'next/link'
import React from 'react';

import { getBlogs } from '../../service/blogs';
import Head from '../../components/templates/head';
import Navigation from '../../components/templates/navigation'

...
const BlogItem: React.FC<BlogItemType> = props => {
  const { id, title , date } = props.items;

  return (
    <div style={ BlogItemStyle }>
      <Link href="/blogs/[id]" as={`/blogs/${id}`}>
        <div>
          <span>{ date }</span>
          <span>{ title }</span>
        </div>
      </Link>
    </div>
  )
}

const Blogs: NextPage = (props: any) => {
  const { contents } = props;

  return (
    <div className="blog-container">
      <Head title="Blogs page" description="" url="" ogImage="" />
      <Navigation />
      {
        contents.map( item => <BlogItem items={ item } key={ item.id } />)
      }
    </div>
  )
}

export const getStaticProps = async () => {
  const { data } = await getBlogs();
  return { props: { contents: data.contents } };
}

export default Blogs;

pages/blogs/[id].tsx

ここでは、/blogs/index.tsxから記事をクリックしたときに遷移するページです。こちらでも先ほど説明した getStaticPropsを使います。このページではパスにidが含まれるので、getStaticPropsでparamsを取得します。そこからパスに含まれるidを取得しgetBlogBy関数でmicro CMSに保存している記事を取得します。

そして、もう一つgetStaticPathsとありますが、こちらはダイナミックルーティングがSSGでは対応していないため、next export時にデータをフェッチして生成するファイルのパスを教えてあげるメソッドになります。こちらを設定しないとjamstackな静的コンテンツを意図した分出力出来なくなるので注意しましょう。

import { NextPage } from 'next'

import Head from '../../components/templates/head';
import Navigation from '../../components/templates/navigation'
import { getBlogBy, getBlogs } from '../../service/blogs'

interface BlogItemType {
  id: String,
  createdAt: String,
  updatedAt: String,
  title: String,
  date: String,
  content: String
}

const BlogsItemPage: NextPage<BlogItemType> = (props) => {
  const { title, date, content } = props;
  return (
    <>
      <Head title="Blogs page" description="" url="" ogImage="" />
      <Navigation />
      <section>
        <h2>{ title }</h2>
        <p>{ date }</p>
        <div>{ content }</div>
      </section>
    </>
  )
}

export const getStaticPaths = async () => {
  const { data } = await getBlogs();
  const paths = data.contents.map(item => `/blogs/${item.id}`);
  return {
    paths,
    fallback: true
  }
}

export const getStaticProps = async ({ params }) => {
  const { id } = params;
  const { data } = await getBlogBy(id);
  return { props: { ...data }}
}

export default BlogsItemPage;

ここで一旦動作確認するために、npm run dev (nextでも良い)でローカル環境で試してみます。(npm scriptsの例はこちら

/blogs/にアクセスしてみてmicro CMSで準備したデータが取れていれば成功です。

next1.png

一覧が表示されたらどれか記事をクリックしてみて、以下の様に詳細ページに飛べたら成功です。

next2.png

静的サイトジェネレート

先ほど作ったソースがSSG(静的サイトジェネレート)で、正しく出力されるか npm run exportで確認します。コマンドを実行すると以下の様にファイルが書き出され、ダイナミックルーティング部分もid付きで名前がついていれば成功です。実際に書き出されるファイルはデフォルトでoutディレクトリに書き出されます。

next3.png

Vercelの準備

Next.jsとmicro CMSでクライアント部分とコンテンツ部分が出来たところでホスティング部分をやっていきます。事前にVercelのアカウントを作り管理画面に入れる様にしておいてください。

import ProjectからあらかじめGithub上に上がっている本プロジェクトを取り込みます。

vercel1.png

途中で作ったディレクトリをVercel上でビルド・デプロイするときの設定をします。

BUILD COMMANDではSSGをするコマンド、OUTPUT DIRECTORYは実際の生成物、DEVELOP COMMANDは開発用のコマンドを入力します。OUTPUT DIRECTORYで一点注意があり、SSGをするときoutディレクトリに出力されますが、ここでoutを指定してしまうとbuild-manifest.jsonが見つからないとエラーが出るので.next(npm run buildで出力されるディレクトリ)を指定しましょう。

vercel4.png

VercelのメニューでSetting > Environment Variablesに遷移します。ローカル環境にてdotenvでX_API_KEYを設定したと思いますが、Vercel上でservice/blogsのAPIを正しく動かすために環境変数を瀬定しましょう。

vercel5.png

Next.jsをVercel上で動かすための設定は一旦完了です。ビルド&デプロイが自動で走ると思うのでDeploymentのメニューでビルトステータスがReadyになっていることが確認できればビルド成功しています。

vercel6.png

該当するデプロイ結果を確認するために、Visitで実際のデプロイされた資材をみに行ってみましょう。以下の様な画面が出ていれば成功です。

vercel7.png

Webhookの設定

先ほどまではNext.jsをVercel上で動かせる様にしただけなのですので、ソースコードのプッシュをすれば再ビルドはかかりますが、micro CMSで記事コンテンツを更新してもサイトの方には反映されません。

それでは実運用で使えないので、コンテンツのステータスが変わったタイミングでデプロイを実行させる様にします。具体的にはmicro CMS側でコンテンツのステータスを変えたタイミングでVercelに対してWebhookでPOSTリクエストを送ります。そのリクエストを受け取ったVercel側で再ビルドされ、その時点で最新のコンテンツを取得した状態でデプロイされます。

Vercel側の設定

Settings > Git Integration > Deploy Hooksで新しくフックの設定をします。フックの名前と該当するブランチの名前を設定し、Create Hookボタンを押します・

webhook1.png

そうするとWebhookのAPIが表示されるのでクリップボードにコピーしましょう。

webhook2.png

micro CMS側の設定

今度はmicro CMS側の設定ですが、API設定 > Webhookに遷移し、カスタム通知を選択します。

ここで先ほどコピーしたWebhook URLとフックを作動させるタイミングを選択します。今回は、コンテンツの公開時・下書き保存時・削除時にフックを飛ばす様に設定します。micro CMSの設定はこれだけになります。

webhook3.png

動作確認

ここから動作検証をしていくので、試しにコンテンツを追加してみます。

webhook3_2.png

コンテンツを追加したらビルドがすぐに自動的に走るので、VercelのPreview Deploymentの画面を確認します。するとステータスがBuildingになっていると思います。これがmicro CMSからフックで自動的にビルド&デプロイされている証拠になります。

webhook4.png

ステータスがReadyに変わったらサイトを確認してみましょう。以下の様に一覧ページに追加したコンテンツや、そのコンテンツのページに遷移出来たら成功です。これで、jamstackな静的サイトが一通り作れたと思います。

一覧ページ
webhook5.png

詳細ページ
webhook6.png

まとめ

  • SSGのNext.jsを使うときはダイナミックルーティング、getStaticProps・getStaticPathsに注意使用
  • jamstackであってもなくても、Vercel + Next.jsでかなり開発フローが楽になる
  • ヘッドレスCMSは非常に便利で使い勝手が良いので、アーキテクチャに柔軟性を持たせることができる。

いかがだったでしょうか、ちょっと長かったかもしれませんが、jamstackなCMSを一通り作れたと思います。このアーキテクチャは特定のフレームワークに依存するものではなく、壊しやすく作れるので導入する要件によっては強力な一手になるんじゃないかと思います。

Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Sign upLogin
37
Help us understand the problem. What are the problem?