next plugin preval

plugin-preval ·

وظائف ASYNC قبل تقييم (لجلب البيانات) في وقت البناء واستيرادها مثل JSON

 // data.preval.js (or data.preval.ts)

// step 1: create a data.preval.js (or data.preval.ts) file
import preval from 'next-plugin-preval' ;

// step 2: write an async function that fetches your data
async function getData ( ) {
  const { title , body } = await /* your data fetching function */ ;
  return { title , body } ;
}

// step 3: export default and wrap with `preval()`
export default preval ( getData ( ) ) ; 

 // Component.js (or Component.ts)

// step 4: import the preval
import data from './data.preval' ;

// step 5: use the data. (it's there synchronously from the build step!)
const { title , body } = data ;

function Component ( ) {
  return (
    < >
      < h1 > { title } </ h1 >
      < p > { body } </ p >
    </ >
  ) ;
}

export default Component ; 

لماذا؟

الآلية الأساسية Next.js تنص على البيانات الثابتة هي getStaticProps - وهي ميزة رائعة وهي الأداة المناسبة للعديد من حالات الاستخدام. ومع ذلك ، هناك حالات استخدام أخرى للبيانات الثابتة التي لا تغطيها getStaticProps .

• البيانات على مستوى الموقع : إذا كان لديك بيانات ثابتة مطلوبة عبر العديد من الصفحات المختلفة ، فإن getStaticProps هي آلية محرجة إلى حد ما لأنه لكل صفحة جديدة ، سيتعين عليك إعادة إحضار نفس البيانات الثابتة. على سبيل المثال ، إذا كنت تستخدم getStaticProps لجلب المحتوى لرأسك ، فسيتم إعادة إحداث هذه البيانات في كل صفحة تغيير.
• البيانات الثابتة لطرق API : قد يكون من المفيد أن تجلب البيانات مسبقًا في طرق API لتسريع أوقات الاستجابة وإزالة العمل من قاعدة البيانات الخاصة بك. لا تعمل getStaticProps مع طرق API بينما تعمل next-plugin-preval .
• بيانات Defed و Code Dist : نظرًا لأن next-plugin-preval يتصرف مثل استيراد JSON ، يمكنك الاستفادة من حزم التحسينات لاستيراد الأصول الثابتة القياسية. ويشمل ذلك تقسيم الكود القياسي والتخلص.
• صفر وقت التشغيل : لا يتم إرسال الملفات السلبية إلى المتصفح ، فقط JSON المخرج.

انظر وصفات الأمثلة الملموسة.

تثبيت

ثَبَّتَ

 yarn add next-plugin-preval

أو

 npm i next-plugin-preval

أضف إلى Next.config.js

 // next.config.js
const createNextPluginPreval = require ( 'next-plugin-preval/config' ) ;
const withNextPluginPreval = createNextPluginPreval ( ) ;

module . exports = withNextPluginPreval ( /* optionally add a next.js config */ ) ; 

الاستخدام

قم بإنشاء ملف مع Extension .preval.ts أو .preval.js ثم تصدير وعد ملفوف في preval() .

 // my-data.preval.js
import preval from 'next-plugin-preval' ;

async function getData ( ) {
  return { hello : 'world' ; }
}

export default preval ( getData ( ) ) ;

ثم استيراد هذا الملف في أي مكان. يتم إرجاع نتيجة الوعد.

 // component.js (or any file)
import myData from './my-data.preval' ; // ? this is effectively like importing JSON

function Component ( ) {
  return (
    < div >
      < pre > { JSON . stringify ( myData , null , 2 ) } </ pre >
    </ div >
  ) ;
}

export default Component ;

عند استيراد ملف .preval ، يبدو الأمر كما لو كنت تستورد JSON. ستقوم next-plugin-preval بتشغيل وظيفتك أثناء الإنشاء ودخل JSON Blob كوحدة نمطية.

️ ملاحظات مهمة

يعمل هذا عبر محمل WebPack الذي يأخذ الكود الخاص بك ، ويقوم بتجميعه ، ويديره داخل Node.js.

• نظرًا لأن هذا هو التحسين على مستوى Bundler ، فلن يتم تحديثه باستخدام وضع معاينة Next.js ، أثناء SSR الديناميكي ، أو حتى ISR. بمجرد إنشاء هذه البيانات أثناء الإنشاء الأولي ، لا يمكن تغييرها. إنه مثل استيراد JSON. انظر هذا النمط للعمل حوله.
• نظرًا لأن هذا البرنامج المساعد يعمل مباشرة على الكود في node.js ، لا يتم تنفيذ الكود في سياق خادم Next.js النموذجي. هذا يعني أن بعض الحقن التالية. نحن نبذل قصارى جهدنا للسخرية من هذا السياق عبر require('next') . بالنسبة لمعظم استفسارات البيانات ، يجب أن يكون هذا كافيًا ، ومع ذلك ، يرجى فتح مشكلة إذا كان هناك شيء ما.

وصفات

البيانات على مستوى الموقع: رأس مشترك

 // header-data.preval.js
import preval from 'next-plugin-preval' ;

async function getHeaderData ( ) {
  const headerData = await /* your data fetching function */ ;

  return headerData ;
}

export default preval ( getHeaderData ( ) ) ; 

 // header.js
import headerData from './header-data.preval' ;
const { title } = headerData ;

function Header ( ) {
  return < header > { title } </ header > ;
}

export default Header ;

بيانات ثابتة لطرق واجهة برمجة التطبيقات: القوائم المسبقة مسبقًا

 // products.preval.js
import preval from 'next-plugin-preval' ;

async function getProducts ( ) {
  const products = await /* your data fetching function */ ;

  // create a hash-map for O(1) lookups
  return products . reduce ( ( productsById , product ) => {
    productsById [ product . id ] = product ;
    return productsById ;
  } , { } ) ;
}

export default preval ( getProducts ( ) ) ; 

 // /pages/api/products/[id].js
import productsById from '../products.preval.js' ;

const handler = ( req , res ) => {
  const { id } = req . params ;

  const product = productsById [ id ] ;

  if ( ! product ) {
    res . status ( 404 ) . end ( ) ;
    return ;
  }

  res . json ( product ) ;
} ;

export default handler ;

البيانات الثابتة التي تقسم الكود: تحميل بيانات غير حرجة

 // states.preval.js
import preval from 'next-plugin-preval' ;

async function getAvailableStates ( ) {
  const states = await /* your data fetching function */ ;
  return states ;
}

export default preval ( getAvailableStates ( ) ) ; 

 // state-picker.js
import { useState , useEffect } from 'react' ;

function StatePicker ( { value , onChange } ) {
  const [ states , setStates ] = useState ( [ ] ) ;

  useEffect ( ( ) => {
    // ES6 dynamic import
    import ( './states.preval' ) . then ( ( response ) => setStates ( response . default ) ) ;
  } , [ ] ) ;

  if ( ! states . length ) {
    return < div > Loading… </ div > ;
  }

  return (
    < select value = { value } onChange = { onChange } >
      { states . map ( ( { label , value } ) => (
        < option key = { value } value = { value } >
          { label }
        </ option >
      ) ) }
    </ select >
  ) ;
}

دعم وضع المعاينة

كما هو مذكور في الملاحظات ، لن تتغير نتيجة preval التالية preval بعد مغادرة البناء. ومع ذلك ، لا يزال بإمكانك عمل عمل معاينة إذا قمت باستخراج وظيفة جلب البيانات الخاصة بك والاتصال بها بشكل مشروط استنادًا إلى وضع المعاينة (عبر context.preview . إذا كان وضع المعاينة غير نشط ، فيمكنك الافتراضي إلى الملف السائد.

 // get-data.js

// 1. extract a data fetching function
async function getData ( ) {
  const data = await /* your data fetching function */ ;
  return data
} 

 // data.preval.js
import preval from 'next-plugin-preval' ;
import getData from './getData' ;

// 2. use that data fetching function in the preval
export default preval ( getData ( ) ) ; 

 // /pages/some-page.js
import data from './data.preval' ;
import getData from './get-data' ;

export async function getStaticProps ( context ) {
  // 3. conditionally call the data fetching function defaulting to the prevalled version
  const data = context . preview ? await getData ( ) : data ;
  
  return { props : { data } } ;
} 

المشاريع ذات الصلة

• next-data-hooks يخلق نمطًا لاستخدام getStaticProps كخطافات رد فعل. رائع لحالة البيانات على مستوى الموقع عند الحاجة إلى وضع المعاينة أو ISR.