relay nextjs

ريفير كري هو توظيف! هل أنت مهتم بالعمل على طليعة الواجهة الأمامية؟
تواصل مع [email protected] لمزيد من المعلومات.

تتابع + التالي

الوثائق | مناقشة | أحدث الإصدارات

relay-nextjs هي أفضل طريقة لاستخدام Relay و Next.js في نفس المشروع! وهو يدعم الترحيل التدريجي ، وهو جاهز للتشويق ، ويتم تشغيله من قبل الشركات الكبرى.

ملخص

relay-nextjs يلف مكونات الصفحة ، واستعلام GRAPHQL ، وبعض طرق المساعد لربط البيانات تلقائيًا باستخدام الترحيل. عند التحميل الأولي ، يتم إنشاء بيئة ترحيل ، يتم جلب البيانات من جانب الخادم ، ويتم تقديم الصفحة ، ويتم تسلسل الحالة الناتجة كعلامة نصية. عند التمهيد في العميل ، يتم إنشاء بيئة ترحيل جديدة والاستعلام المسبق باستخدام تلك الحالة المسلسل. يتم جلب البيانات باستخدام بيئة التتابع من جانب العميل على التنقل اللاحق.

ملاحظة: لا يدعم relay-nextjs جهاز توجيه تطبيق NextJS 13 في الوقت الحالي.

• انظر Github issue #89 لمزيد من المعلومات.

ابدء

التثبيت باستخدام NPM أو مدير الحزمة المفضل لديك:

$ npm install relay-nextjs

يجب تكوين relay-nextjs في _app لاعتراض وتوجيه المعالجة بشكل صحيح.

إعداد بيئة الترحيل

للحصول على معلومات أساسية حول بيئة التتابع ، يرجى الاطلاع على مستندات الترحيل.

تم تصميم 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 ,
  } ) ;
}

ملاحظة في بيئة خادم المثال التي نقوم بتنفيذها ضد مخطط محلي ولكن قد تجلبها من واجهة برمجة تطبيقات عن بُعد أيضًا.

تكوين _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 ) ;
  } ,
} ) ;