relay nextjs

Creが雇っています！フロントエンドの最先端で作業することに興味がありますか？
詳細については、[email protected]にアクセスしてください。

リレー + next.js

ドキュメント|ディスカッション|最新リリース

relay-nextjs同じプロジェクトでリレーとnext.jsを使用する最良の方法です！漸進的な移行をサポートし、サスペンスの準備ができており、大手企業が生産して運営されています。

概要

relay-nextjsページコンポーネント、GraphQLクエリ、およびリレーを使用してデータフェッチを自動的にフックアップするヘルパーメソッドをラップします。初期ロードでリレー環境が作成され、データはサーバー側にフェッチされ、ページがレンダリングされ、結果の状態はスクリプトタグとしてシリアル化されます。クライアントのブートでは、そのシリアル化された状態を使用して、新しいリレー環境とプリロードクエリが作成されます。データは、後続のナビゲーションでクライアント側のリレー環境を使用してフェッチされます。

注： relay-nextjs 、現時点ではNextJS 13アプリルーターをサポートしていません。

• 詳細については、GitHub Issue＃89を参照してください。

はじめる

NPMまたは他のお気に入りのパッケージマネージャーを使用してインストールしてください：

$ npm install relay-nextjs

relay-nextjsルーティングを適切に傍受および処理するために_appで構成する必要があります。

リレー環境のセットアップ

リレー環境に関する基本情報については、リレードキュメントをご覧ください。

relay-nextjsクライアント側とサーバー側のレンダリングを念頭に置いて設計されました。そのため、クライアント側またはサーバー側のリレー環境のいずれかを使用できる必要があります。図書館は、使用する環境を処理する方法を知っていますが、これらの環境を作成する方法を説明する必要があります。このために、2つの機能を定義します。GetClientEnvironmentとcreateServerEnvironment getClientEnvironment区別に注意してください - クライアントでは、1つのアプリしかないために1つの環境のみが作成されますが、サーバーには、リクエスト間でキャッシュが共有されないことを確認するためにレンダーごとに環境を作成する必要があります。

まず、 getClientEnvironmentを定義します。

 // lib/client_environment.ts
import { Environment , Network , Store , RecordSource } from 'relay-runtime' ;

export function createClientNetwork ( ) {
  return Network . create ( async ( params , variables ) => {
    const response = await fetch ( '/api/graphql' , {
      method : 'POST' ,
      credentials : 'include' ,
      headers : {
        'Content-Type' : 'application/json' ,
      } ,
      body : JSON . stringify ( {
        query : params . text ,
        variables ,
      } ) ,
    } ) ;

    const json = await response . text ( ) ;
    return JSON . parse ( json ) ;
  } ) ;
}

let clientEnv : Environment | undefined ;
export function getClientEnvironment ( ) {
  if ( typeof window === 'undefined' ) return null ;

  if ( clientEnv == null ) {
    clientEnv = new Environment ( {
      network : createClientNetwork ( ) ,
      store : new Store ( new RecordSource ( ) ) ,
      isServer : false ,
    } ) ;
  }

  return clientEnv ;
}

そして、 createServerEnvironment ：

 import { graphql } from 'graphql' ;
import { GraphQLResponse , Network } from 'relay-runtime' ;
import { schema } from 'lib/schema' ;

export function createServerNetwork ( ) {
  return Network . create ( async ( text , variables ) => {
    const context = {
      token ,
      // More context variables here
    } ;

    const results = await graphql ( {
      schema ,
      source : text . text ! ,
      variableValues : variables ,
      contextValue : context ,
    } ) ;

    return JSON . parse ( JSON . stringify ( results ) ) as GraphQLResponse ;
  } ) ;
}

export function createServerEnvironment ( ) {
  return new Environment ( {
    network : createServerNetwork ( ) ,
    store : new Store ( new RecordSource ( ) ) ,
    isServer : true ,
  } ) ;
}

メモは、ローカルスキーマに対して実行しているサーバー環境の例に注意してください。ただし、リモートAPIからも取得できます。

_appの構成

 // pages/_app.tsx
import { RelayEnvironmentProvider } from 'react-relay/hooks' ;
import { useRelayNextjs } from 'relay-nextjs/app' ;
import { getClientEnvironment } from '../lib/client_environment' ;

function MyApp ( { Component , pageProps } : AppProps ) {
  const { env , ... relayProps } = useRelayNextjs ( pageProps , {
    createClientEnvironment : ( ) => getClientSideEnvironment ( ) ! ,
  } ) ;

  return (
    < >
      < RelayEnvironmentProvider environment = { env } >
        < Component { ... pageProps } { ... relayProps } />
      </ RelayEnvironmentProvider >
    </ >
  ) ;
}

export default MyApp ; 

ページ内の使用

 // src/pages/user/[uuid].tsx
import { withRelay , RelayProps } from 'relay-nextjs' ;
import { graphql , usePreloadedQuery } from 'react-relay/hooks' ;

// The $uuid variable is injected automatically from the route.
const ProfileQuery = graphql `
  query profile_ProfileQuery($uuid: ID!) {
    user(id: $uuid) {
      id
      firstName
      lastName
    }
  }
` ;

function UserProfile ( { preloadedQuery } : RelayProps < { } , profile_ProfileQuery > ) {
  const query = usePreloadedQuery ( ProfileQuery , preloadedQuery ) ;

  return (
    < div >
      Hello { query . user . firstName } { query . user . lastName }
    </ div >
  ) ;
}

function Loading ( ) {
  return < div > Loading... </ div > ;
}

export default withRelay ( UserProfile , UserProfileQuery , {
  // Fallback to render while the page is loading.
  // This property is optional.
  fallback : < Loading /> ,
  // Create a Relay environment on the client-side.
  // Note: This function must always return the same value.
  createClientEnvironment : ( ) => getClientEnvironment ( ) ! ,
  // variablesFromContext allows you to declare and customize variables for the graphql query.
  // by default variablesFromContext is ctx.query
  variablesFromContext : ( ctx : NextRouter | NextPageContext ) => ( { ... ctx . query , otherVariable : true } ) ,
  // Gets server side props for the page.
  serverSideProps : async ( ctx ) => {
    // This is an example of getting an auth token from the request context.
    // If you don't need to authenticate users this can be removed and return an
    // empty object instead.
    const { getTokenFromCtx } = await import ( 'lib/server/auth' ) ;
    const token = await getTokenFromCtx ( ctx ) ;
    if ( token == null ) {
      return {
        redirect : { destination : '/login' , permanent : false } ,
      } ;
    }

    return { token } ;
  } ,
  // Server-side props can be accessed as the second argument
  // to this function.
  createServerEnvironment : async (
    ctx ,
    // The object returned from serverSideProps. If you don't need a token
    // you can remove this argument.
    { token } : { token : string }
  ) => {
    const { createServerEnvironment } = await import ( 'lib/server_environment' ) ;
    return createServerEnvironment ( token ) ;
  } ,
} ) ;