relay nextjs

Revere Cre는 채용 중입니다! 프론트 엔드의 최첨단 작업에 관심이 있습니까?
자세한 내용은 [email protected]으로 연락하십시오.

릴레이 + next.js

문서 | 토론 | 최신 릴리스

relay-nextjs 동일한 프로젝트에서 릴레이 및 다음.js를 사용하는 가장 좋은 방법입니다! 점진적인 마이그레이션을 지원하고 서스펜스가 준비 되며 주요 회사가 생산하고 있습니다.

개요

relay-nextjs 페이지 구성 요소, 그래프 QL 쿼리 및 일부 도우미 방법을 랩핑하여 릴레이를 사용하여 데이터를 자동으로 연결합니다. 초기로드에서 릴레이 환경이 생성되고 데이터가 서버 측면으로 가져오고 페이지가 렌더링되며 결과 상태는 스크립트 태그로 직렬화됩니다. 클라이언트의 부팅시 해당 직렬화 된 상태를 사용하여 새로운 릴레이 환경과 사전로드 된 쿼리가 생성됩니다. 후속 탐색에서 클라이언트 측 릴레이 환경을 사용하여 데이터가 가져옵니다.

참고 : relay-nextjs 현재 NextJS 13 앱 라우터를 지원하지 않습니다.

• 자세한 내용은 Github Issue #89를 참조하십시오.

시작하기

NPM 또는 기타 좋아하는 패키지 관리자를 사용하여 설치하십시오.

$ npm install relay-nextjs

_app 에서 relay-nextjs 구성하여 라우팅을 올바르게 차단하고 처리해야합니다.

릴레이 환경 설정

릴레이 환경에 대한 기본 정보는 릴레이 문서를 참조하십시오.

relay-nextjs 클라이언트 측 및 서버 측 렌더링을 염두에두고 설계되었습니다. 따라서 클라이언트 측 또는 서버 측 릴레이 환경을 사용할 수 있어야합니다. 도서관은 사용할 환경을 처리하는 방법을 알고 있지만 이러한 환경을 만드는 방법을 알려야합니다. 이를 위해 우리는 getClientEnvironment 와 createServerEnvironment 의 두 가지 기능을 정의합니다. 구별에 유의하십시오-클라이언트에서는 하나의 앱 만 있기 때문에 하나의 환경 만 생성되지만 서버에서는 캐시가 요청간에 공유되지 않도록 렌더 당 환경을 생성해야합니다.

먼저 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 ) ;
  } ,
} ) ;