Pāriet uz saturu

Personalizēti fragmenti kešotās lapās

Lapa, kas tiek rādīta no statiskās kešatmiņas, visiem ir vienāda. Tādam nolūkam ir kešošana, un tā ir arī problēma: galvenei jāsaka “Sveiki, Ada” pierakstījušamies klientam, bet groza ikonai jārāda trīs preces. Ja veidne mainās atkarībā no pašreizējā lietotāja, kešatmiņā vai nu tiek saglabāts viena apmeklētāja sveiciens visiem, vai arī no kešošanas jāizslēdz visa lapa.

Blockstudio dinamiskās salas nodala šīs divas vajadzības. Kešotajā HTML ir kešatmiņai drošs vietturis. Pēc lapas ielādes neliela izpildvide apmeklētāja paša pieprasījumā pieprasa WordPress personalizēto fragmentu un ievieto to vietturī. Lapa paliek kešojama, bet dinamisks ir tikai fragments.

Šajā ceļvedī tiek izveidotas divas salas — sveiciens un preču skaits grozā — un izskaidrots, kas ir kešotajā lapā, kā izskatās fragmenta pieprasījums un kā galapunkts nosaka apmeklētāja identitāti. Tas papildina ceļvedi Serving WordPress as Static HTML.

Kā darbojas dinamiska sala

  1. Bloks renderē vietturi marķiera elementā. Marķierī ir bloka nosaukums, atļauto atribūtu saraksts un servera ģenerēts paraksts.
  2. Tā kā renderētajā lapā ir marķieris, Blockstudio ievieto salu izpildvidi. Lapās bez salām netiek piegādāta salu JavaScript.
  3. Izpildvide apkopo gatavos marķierus un nosūta vienu apvienotu POST uz /wp-json/blockstudio/v1/island/render.
  4. Galapunkts pārbauda katru parakstu, renderē bloku apmeklētāja pieprasījuma kontekstā un atgriež fragmentus.
  5. Izpildvide aizvieto katru vietturi un izsūta notikumus.

Bloku redaktorā bloks tiek renderēts parasti, bez viettura.

1. darbība: sveiciena bloks

Izveidojiet bloku ar trim failiem:

Kods
blocks/
└── greeting/
    ├── block.json
    ├── placeholder.php
    └── index.php
JSON
{
  "apiVersion": 3,
  "name": "acme/greeting",
  "title": "Greeting",
  "category": "widgets",
  "icon": "admin-users",
  "description": "Account link that greets signed-in visitors.",
  "blockstudio": {
    "island": {
      "mode": "dynamic",
      "tag": "span",
      "attributes": ["guestLabel"],
      "cache": {
        "ttl": 300,
        "per": "user"
      }
    },
    "attributes": [
      { "id": "guestLabel", "type": "text", "label": "Guest label", "default": "Sign in" }
    ]
  }
}

mode: "dynamic" nodrošina, ka šī ir sala ar fragmenta pieprasījumu. tag iestata marķiera elementu, lai salu varētu ievietot navigācijas joslā teksta rindiņā. attributes ir atļauto bloka atribūtu saraksts, kas tiek nosūtīti fragmenta pieprasījumā; viss, kas nav sarakstā, netiek ne nosūtīts, ne parakstīts. cache sīkāk aplūkots tālāk.

Kešotajā lapā ir vietturis. Tam jābūt drošam ikvienam apmeklētājam, tāpēc tajā nav lietotāja datu. Saite “Konts” der visiem:

PHP
<a href="<?php echo esc_url( home_url( '/account/' ) ); ?>">Account</a>

Galvenā veidne renderē īsto fragmentu:

PHP
<?php
$user = wp_get_current_user();
?>
<?php if ( $user->exists() ) : ?>
  <a href="<?php echo esc_url( home_url( '/account/' ) ); ?>">
    <?php echo esc_html( sprintf( 'Hi, %s', $user->display_name ) ); ?>
  </a>
<?php else : ?>
  <a href="<?php echo esc_url( wp_login_url() ); ?>">
    <?php echo esc_html( $a['guestLabel'] ); ?>
  </a>
<?php endif; ?>

Šeit ir pieļaujams mainīt saturu atkarībā no pašreizējā lietotāja: šī veidne darbojas tikai fragmenta pieprasījumam, nekad kešotajai lapai.

Ievietojiet to vietā, kur tiek renderēta galvene:

PHP
<?php echo bs_block( array( 'name' => 'acme/greeting' ) ); ?>

Der arī bloku tagi: <bs:acme-greeting /> vai <block name="acme/greeting" />.

2. darbība: kas ir kešotajā lapā

Renderējot serverī, bloks izveido tikai marķieri un vietturi:

HTML
<span data-bs-island="acme/greeting" data-bs-island-mode="dynamic" data-bs-island-phase="placeholder" data-bs-island-props="{&quot;guestLabel&quot;:&quot;Sign in&quot;}" data-bs-island-signature="a7311ba9f6abf3c993edfdd7d49d2fa23bfa068f715b96637c35ef30de8b2043" data-bs-island-loading="eager"><!--blockstudio/acme/greeting--><a href="https://example.com/account/">Account</a>
</span>

Renderējiet to vienreiz kā anonīms apmeklētājs un vienreiz kā pierakstījies lietotājs. Abas virknes būs identiskas baitu līmenī. Tieši šāda īpašība ir nepieciešama statiskai iepriekšējai renderēšanai ar ieslēgtu serveLoggedIn: neatkarīgi no tā, kurš ierosina renderēšanu, saglabātais dokuments ir vienāds, un tajā nevar nonākt nekas personisks.

3. darbība: fragmenta pieprasījums

Izpildvide nosūta katru gatavo salu vienā pieprasījumā:

JSON
{
    "islands": [
        {
            "clientId": "a1",
            "name": "acme/greeting",
            "attributes": {
                "guestLabel": "Sign in"
            },
            "signature": "a7311ba9f6abf3c993edfdd7d49d2fa23bfa068f715b96637c35ef30de8b2043"
        }
    ]
}

Atbilde tiek indeksēta pēc clientId. Pierakstījies apmeklētājs saņem:

JSON
{
    "a1": "<!--blockstudio/acme/greeting-->  <a href=\"https://example.com/account/\">\n    Hi, Ada  </a>\n"
}

Neveiksmīgi pārbaudīts ieraksts atgriež kļūdas kodu, nevis HTML, un neizraisa pārējās pakešdarbības kļūmi. Otrajā ierakstā tika mainīts guestLabel bez atbilstoša paraksta, bet trešajā bija norādīts bloks, kas nav dinamiska sala:

JSON
{
    "a1": "<!--blockstudio/acme/greeting-->  <a href=\"https://example.com/wp-login.php\">\n    Sign in  </a>\n",
    "a2": {
        "error": "blockstudio_island_invalid_signature"
    },
    "a3": {
        "error": "blockstudio_island_not_allowed"
    }
}

Katra atbilde satur Cache-Control: no-store, no-cache, must-revalidate, max-age=0, Pragma: no-cache un X-Robots-Tag: noindex. Galapunkts atrodas zem /wp-json, ko statiskā iepriekšējā renderēšana vienmēr apiet, tāpēc ne sākotnējā servera kešatmiņa, ne CDN, kas ievēro sākotnējā servera galvenes, nesaglabās fragmentu.

Apmeklētāja identitāte

Izpildvide nosūta pieprasījumu ar credentials: 'same-origin', tāpēc pārlūkprogramma iekļauj WordPress pieteikšanās sīkdatni. WordPress REST API parasti ignorē autentifikāciju ar sīkdatni, ja nav nonce, bet nonce nevar atrasties kešotā lapā. Salu galapunkts to apstrādā pats: tā paša domēna pārlūkprogrammas pieprasījumam tas pārbauda logged_in sīkdatni un pirms renderēšanas atjauno lietotāja sesiju.

Tā paša domēna izcelsmi nosaka pēc Sec-Fetch-Site galvenes un, ja tā ir norādīta, salīdzina Origin galveni ar home_url(). Pieprasījums no citas izcelsmes, kuram gadījies pievienot sīkdatni, tiek renderēts anonīmi, tāpēc pieprasījums no citas vietnes nekad nerenderē apmeklētāja personalizēto fragmentu. Praksē:

Pieprasījums Tiek renderēts kā
Tā paša domēna fetch pieprasījums ar derīgu pieteikšanās sīkdatni pierakstījies lietotājs
Starpdomēnu pieprasījums ar to pašu sīkdatni anonīms apmeklētājs
Nav sīkdatnes anonīms apmeklētājs

Kura lapa tā ir?

Pievienojiet "context": true pie blockstudio.island, ja fragmentam nepieciešama tā lapas identitāte. Marķieris pievieno vaicātās lapas ziņas ID un ziņas tipu līdzās atribūtiem. Fragmentā $block['postId'], $block['postType'], get_the_ID() un get_queried_object_id() attiecas uz šo lapu. Query Loop ietvaros tas joprojām nozīmē ārēji vaicāto lapu, nevis cikla elementu.

Lapas konteksts ir ieslēdzams pēc izvēles un ir arī fragmentu kešatmiņas atslēgas daļa. Galapunkts vēlreiz pārbauda piekļuvi, arī kešotiem fragmentiem, tāpēc parakstīts marķieris neatklāj lapu, kas kopš tā laika kļuvusi privāta vai aizsargāta ar paroli. Skatiet Lapas konteksts, lai uzzinātu par konfigurāciju un drošību. Patvaļīgi URL vai vaicājuma parametri netiek atkārtoti izmantoti.

4. darbība: groza skaits, kas tiek atsvaidzināts automātiski

Otrā sala demonstrē otru viettura stilu un divas izpildvides opcijas. Atsevišķa viettura faila vietā veidne pārbauda $isIslandPlaceholder:

JSON
{
  "apiVersion": 3,
  "name": "acme/cart-count",
  "title": "Cart Count",
  "category": "widgets",
  "icon": "cart",
  "description": "Number of items in the visitor's cart.",
  "blockstudio": {
    "island": {
      "mode": "dynamic",
      "loading": "visible",
      "event": "acme:cart-updated"
    },
    "attributes": []
  }
}
PHP
<?php
$count = (int) apply_filters( 'acme/cart_count', 0 );
?>
<?php if ( $isIslandPlaceholder ) : ?>
  <a href="/cart/" class="cart-count">Cart</a>
<?php else : ?>
  <a href="/cart/" class="cart-count">
    Cart <span class="cart-count__badge"><?php echo esc_html( (string) $count ); ?></span>
  </a>
<?php endif; ?>

Visos veidņu valodu veidos ir pieejami tie paši karodziņi: isIsland, isIslandPlaceholder, isIslandFragment un islandPhase ("normal", "hydrate", "placeholder" vai "fragment"). Šeit skaits tiek iegūts no acme/cart_count filtra, ko aizpilda jūsu komercijas kods. Ja tas atgriež 3, galapunkts atgriež:

JSON
{"c1":"<!--blockstudio/acme/cart-count-->  <a href=\"/cart/\" class=\"cart-count\">\n    Cart <span class=\"cart-count__badge\">3</span>\n  </a>\n"}

loading: "visible" atliek pieprasījumu, līdz marķieris nonāk redzamajā apgabalā, izmantojot IntersectionObserver. Redzamās salas, kas parādās vienlaikus, joprojām tiek apvienotas vienā pieprasījumā. event norāda loga notikumu, kas atkārtoti ielādē salu, tāpēc pēc grozam pievienošanas izsaukuma jūsu skriptam tikai jāpaziņo par to:

JavaScript
window.dispatchEvent(new Event('acme:cart-updated'));

Reaģēšana priekšgala kodā

Notikumi izplatās no marķiera, tāpēc viens klausītājs uz document aptver katru salu. event.detail.name satur bloka nosaukumu:

JavaScript
document.addEventListener('blockstudio:island:rendered', (event) => {
  if (event.detail.name !== 'acme/cart-count') return;
  event.target.querySelector('.cart-count__badge')?.classList.add('is-fresh');
});

document.addEventListener('blockstudio:island:error', (event) => {
  console.warn('Island failed', event.detail.name, event.detail.error);
});

Pēc nomaiņas izpildvide izsauc blockstudio:island:rendered un pēc tam blockstudio:island:hydrate. Ja rodas kļūme, vietturis paliek vietā un tiek izsaukts blockstudio:island:error. Hidratētās salas ("island": "hydrate") pieprasījumu pilnībā izlaiž: to pilnais HTML jau ir lapā, un tās saņem tikai notikumu hydrate, kas ir piemērots kešatmiņai drošiem interaktīviem blokiem, piemēram, cilnēm.

Fragmentu kešošana

Pēc noklusējuma fragmenti tiek renderēti katrā pieprasījumā. Iepriekš minētais sveiciens izmanto īslaicīgu kešatmiņu:

JSON
{
  "cache": {
    "ttl": 300,
    "per": "user"
  }
}

per: "user" maina kešoto fragmentu atkarībā no WordPress lietotāja ID, un anonīmi pieprasījumi tajā nekad netiek kešoti, tāpēc divi anonīmi apmeklētāji nevar koplietot ierakstu, kas paredzēts konkrētam lietotājam. per: "global" koplieto vienu fragmentu blokam ar vienādiem atribūtiem, kas ir piemērots aktuālam, bet nepersonalizētam saturam, piemēram, krājumu līmenim. ttl pēc noklusējuma ir 60 sekundes, un cache: true ir globāla kešatmiņa uz 60 sekundēm.

Drošības modelis

Galapunkts ir publisks, taču tas nav vispārīgs bloku renderētājs. Tas renderē ierakstu tikai tad, ja ir izpildīti visi šie nosacījumi:

  • bloks ir reģistrēts, dinamisks, un tam island.mode ir iestatīts uz dynamic
  • paraksts atbilst bloka nosaukumam un atribūtiem, kas paliek pēc filtra: tikai atslēgām, kas ir gan bloka shēmā, gan salas atļauto vērtību sarakstā

Paraksts ir HMAC-SHA256, kas izveidots no normalizēta bloka nosaukuma un atribūtiem, izmantojot apkalpojošās vietnes auth sāls vērtību. Paraksti tiek izveidoti renderēšanas laikā šajā vietnē un nekad netiek iekļauti motīvā. No tā izriet divas sekas. Stenda vidē renderētam dokumentam ir stenda vides paraksti, tāpēc dokumentus renderējiet vietnē, kas tos apkalpo. Turklāt, mainot WordPress sāls vērtības, tiek anulēti visi paraksti saglabātajos dokumentos, tāpēc pēc sāls vērtības maiņas notīriet statiskās priekšrenderēšanas rezultātus.

Vienā pieprasījumā var iekļaut līdz 50 salām; ja to ir vairāk, tiek atgriezts HTTP 413. Ierobežojumu var mainīt ar blockstudio/islands/max_per_request. Paraksta āķi (blockstudio/islands/signature_payload, blockstudio/islands/signature, blockstudio/islands/verify_signature) ir pieejami vidēm, kurām nepieciešama cita shēma.

Kad salu nevajadzētu izmantot

Fragmenti nav iekļauti sākotnējā HTML, tāpēc rāpuļprogrammas tos neredz. Saturu, kas ir svarīgs SEO, iekļaujiet parastajā renderējumā. Dinamiskās salas izmantojiet saturam, kas var tikt ielādēts pēc lapas ietvara: konta saitēm, groza stāvoklim, ieteikumiem un vadīklām, kuru izmantošanai nepieciešamas atļaujas. Ja visa lapa ir personalizēta, piemēram, konta informācijas panelis, tā ceļu norādiet dynamicPaths un lapu renderējiet reāllaikā.

Nākamās darbības