Takumon Blog

Gatsbyにおける外部取得画像へのgatsby-image適用方法

2019/06/02

なにこれ

Gatsbyで画像を扱う場合gatsby-imageを使うとイイ感じに最適化してくれます。 Webサイトのリポジトリ内の画像についてはgatsby-config.jsで簡単に設定できますが、今回はビルド時に動的に取得する外部画像に対して設定する方法をご紹介します。

実装方法

Step1. 外部画像ファイルノード生成

Gatsbyのgatsby-source-filesystemでは、外部画像を扱うためのAPI(createRemoteFileNode)が用意されています。コチラをgatsby-node.jsのsourceNodesで呼び出せば外部画像にgatsby-imageを適用できます。あと、ちょっとしたハックとして、Reactコンポーネント側で他ファイルノードと区別できるように、ノード生成時に識別子を付けましょう。これは後述する外部画像表示用コンポーネントで使うためのものです。

gatsby-node.js

const { createRemoteFileNode } = require(`gatsby-source-filesystem`);

// sourceNodesにて外部画像のファイルノードを作成する
exports.sourceNodes = async ({ actions, createNodeId, cache, store }) => {
  /* (中略) */

  // ここでは外部画像のURLの配列を処理するサンプルを示す
  await Promise.all(sampleImageUrls.map(async sampleImageUrl => {

    // createRemoteFileNodeで外部の画像のファイルノードを作成する
    const fileNode = await createRemoteFileNode({
      url: sampleImageUrl,
      cache,
      store,
      createNode: actions.createNode,
      createNodeId: createNodeId,
    });

    // 他ファイルノードと区別するための識別子を付与
    await actions.createNodeField({
      node: fileNode,
      name: 'SampleImage',
      value: 'true',
    });

    // メタ情報として画像のURLを付与
    await actions.createNodeField({
      node: fileNode,
      name: 'link',
      value: sampleImageUrl,
    });

    return fileNode;
  }));

  /* (中略) */
}

Step2. 外部画像表示用Reactコンポーネント作成

外部画像のファイルノードを生成できたら、今度はReactコンポーネント側で、それにgatsby-iamgeを適用して表示します。 GraphQLのクエリで、ファイルノードを生成時に付与した識別子を使い、すべてのファイルノードから外部画像だけを抽出するようにしましょう。

import React from 'react';
import GatsbyImage from 'gatsby-image';
import { StaticQuery, graphql } from 'gatsby';

// OGP画像のURLを引数に取る
export default ({ url }) => (
  <StaticQuery
    query={graphql`
      query {
        allFile(
          # Gatsby Buildで付与した識別子をもとに
          # 全ファイルからOPG画像のみ抽出
          filter: {fields: {SampleImage: {eq: "true"}}}
        ){
          edges {
            node {
              childImageSharp {
                resolutions {
                  ...GatsbyImageSharpResolutions
                }
              }
              id
              fields {
                # 一応メタ情報も取得する
                SampleImage
                link
              }
            }
          }
        }
      }
    `}
    render={data => {
      // OGP画像リストの中から、コンポーネント引数で指定したURLの画像を抽出する
      const targetEdge = data.allFile.edges.find(edge => edge.node.fields.link === url);

      // 画像が取得できた場合のみgatsby-imageのコンポーネントを返す
      return (
        targetEdge && targetEdge.node.childImageSharp
          && <GatsbyImage resolutions={targetEdge.node.childImageSharp.resolutions} />
          : null
      );
    }}
  />
);

Step3. 上記で作成したコンポーネントの呼び出し

最後に上記コンポーネントの呼び出します。以下のように外部画像のURLを指定してあげましょう。

  <SampleImage url={SampleImageUrl} />

これで外部画像にgatsby-imageを適用してイイ感じに表示できます！

例：WEBサイトURLからOGP画像を取得する場合

実用的な例として、複数のWebサイトのOGP画像をgatsby-imageとして扱う方法をご紹介します。

gatsby-node.js

const axios = require('axios');
const cheerio = require('cheerio');
const { createRemoteFileNode } = require(`gatsby-source-filesystem`);

// sourceNodesにて外部画像のファイルノードを作成する
exports.sourceNodes = async ({ actions, createNodeId, cache, store }) => {
  /* (中略) */


  // WEBサイトURLからHTMLを取得してOGPを抽出
  const ogpImageUrls = [];
  // Promise.allで処理するとリクエスト多可で503になるのでfor文で一件ずつ処理する
  for (const postUrl of postUrls) {
    
    const res = await axios.get(postUrl.link, {
      headers: {'User-Agent': 'something different'},
    })

    // cheerioを使ってHMTLからOGP画像URLを抽出
    let ogpImageUrl;
    const $ = cheerio.load(res.data)
    $('head meta').each((i, el) => {
      const property = $(el).attr('property')
      const content = $(el).attr('content')
      if (property === 'og:image') {
        ogpImageUrls.push(ogpImageUrl);
      }
    });
  }

  // 取得したOGP画像URLをもとにファイルノードを生成
  await Promise.all(ogpImageUrls.map(async imageUrl => {
    const fileNode = await createRemoteFileNode({
      url: imageUrl,
      cache,
      store,
      createNode: actions.createNode,
      createNodeId: createNodeId,
    });

    // 他ファイルノードと区別するための識別子を付与
    await actions.createNodeField({
      node: fileNode,
      name: 'OgpImage',
      value: 'true',
    });

    // メタ情報として画像のURLを付与
    await actions.createNodeField({
      node: fileNode,
      name: 'link',
      value: imageUrl,
    });

    return fileNode;
  }));