sena-v.com

sena-v.com
画像

画像

画像
scroll top

GatsbyにおけるGraphQLの役割について

2020-12-27    

Gatsby における GraphQL の挙動について、公式チュートリアル・参考サイトで得られる情報は 順番に学習することを想定しているため、ピンポイントでの理解が難しくなっている。

差別化のため、この記事では<u><b>何をしたいときにどこを触るか</b></u>という逆引き形式で Gatsby における GraphQL の使用方法をまとめる。

GraphQL 挙動の前提

基本的には各コンポーネントを構成する.js ファイル内で定義をすることで、内部処理が行われ Gatsby の黒魔術で結果が返却される。 おおまかな流れとしては以下になる。

JSX を生成するコンポーネントを読み込む ↓ query を export して読み込んだ graphQL モジュールに投げる ↓ モジュール内部で処理し、結果を data オブジェクトとしてグローバルに返却 ↓ 返却された data オブジェクトを用いて JSX で表示させる。

用途に応じた GraphQL 記法の違い

テンプレートを使用したページを生成する場合(各記事画面等)

  • gatsby-node.js 内部にクエリを記述し、ビルド時に処理される
  • クエリにて取得した値について任意のラベル付けを行い、テンプレートに流し込んでページを生成する
  • 複数のページ生成を実施したい場合、各 Object のラベル付けが必要

2 個のオブジェクトを生成するクエリを発行 data:{ posts:{ obj }, tags:{ obj } }

const result = await graphql(`
    query {
      posts: allMarkdownRemark {              // ①各記事の表示に使用する情報
        edges {
          node {
            frontmatter {
              slug
              tags
            }
          }
        }
      }
      tags: allMarkdownRemark(limit: 1000) {  // ②タグ表示に使用する情報
        group(field: frontmatter___tags) {
          tag: fieldValue
          totalCount
        }
      }
    }
  `)

Top ページ等の主ページコンポーネントで情報を取得する場合

  • 主コンポーネントで query を定義して export する事により、graphQL モジュールが吸い上げて処理し data オブジェクトを返却する
  • query の定義自体は特に指定箇所は無いが、できるだけ視認性を良くするため間に挟まないようにする

1 個のオブジェクトを生成するクエリを発行 data: allMarkdownRemark{ obj }

export const query = graphql`
  query {
    allMarkdownRemark(sort: { fields: [frontmatter___date], order: DESC }) {
      edges {
        node {
          frontmatter {
            title
            date(formatString: "YYYY年MM月DD日")
            tags
            slug
          }
          excerpt
        }
      }
    }
  }
`

コンポーネントに読み込んだ子の内側で情報を取得する場合

  • 子コンポーネント内で useStaticQuery を使用する
  • export しているメソッド内で JSX を return する形に変更し、return 前に query を記述する

1 個のオブジェクトを生成するクエリを発行 data: allMarkdownremark:{ obj }

const data = useStaticQuery(
  graphql`
    query {
      allMarkdownRemark(limit: 1000) {
        group(field: frontmatter___tags) {
          tag: fieldValue
          totalCount
        }
      }
    }
  `
)

/* 以下、dataにて取得結果を使用できる */

未検証

親から子コンポーネントへ渡せなくはないと思うが…

子要素の中で graphQL の結果を使用したい場合、子要素内でクエリ発行を行う方法(useStaticQuery)と 親コンポーネントで生成した query から取得した Object を子要素に渡す方法が考えられる

SQL と同じ考え方をするのであれば、子要素内でクエリ発行する場合単純化でき保守性が上がるメリットがあり、 親コンポーネントから子要素へ渡す場合はクエリ発行回数が 1 回以上減らせるメリットがある。

Gatsby レベルの動作であれば props のバケツリレーをするよりクエリ発行してしまったほうが実装が楽なので 親でクエリを複雑にするよりは子コンポーネントを作ってしまったほうが楽じゃないかなと~思う。 (子要素が 10-20 個とかになるなら発行回数の差がエグいけど、そんなケースなさそうだし)

まとめ

data は単数のコンポーネントで取得したい?  →  複数  →  <u>gatsby-node.js に記述</u>                 ↓                単数                 ↓ そのコンポーネントはメインの JSX を出力する?  →   NO   →  親コンポーネントの<u>グローバル変数にクエリを記述</u>                 ↓                Yes                 ↓ 子コンポーネントのため<u>useStaticQuery を用いてメインメソッドのローカル変数にクエリを記述</u>

    

Tags

    ALL(11)
    Firebase(1)
    GraphQL(1)
    JavaScript(7)
    Nuxt(2)
    React(2)
    TypeScript(2)
    Vue(1)
    個人開発(1)
    勉強法(1)
    技術(6)
    振り返り(1)