Ugrás a tartalomhoz

A WordPress kiszolgálása statikus HTML-ként

Egy marketing- vagy dokumentációs webhely legtöbb oldala minden névtelen látogató számára azonos. A WordPress mégis minden kérésnél elindul, betölt minden bővítményt, futtatja a témát, és megjeleníti a blokkokat. Egy oldalgyorsítótárazó bővítmény segíthet, de újabb mozgó alkatrész, saját szabályokkal arról, mi tárolható biztonságosan.

A Blockstudio igény szerint bekapcsolható statikus előzetes renderelést kínál. A teljes, névtelen HTML dokumentumokat saját gyorsítótárkönyvtárában tárolja, és engedélyezés esetén egy advanced-cache.php drop-inből szolgálja ki őket, még a WordPress elindulása előtt. Minden beállítás a blockstudio.json fájlban történik.

Ez az útmutató lépésről lépésre bekapcsolja a funkciót, bemutatja, hogyan ellenőrizheti, mi kerül és mi nem kerül gyorsítótárba, elmagyarázza az egyetlen szabályt, amely védi a bejelentkezett látogatókat, végül pedig ismertet egy CDN beállítást, amely csak az eredetkiszolgáló által gyorsítótárazhatónak jelölt tartalmat tárolja.

A kérések kiszolgálása

Az előzetes renderelés bekapcsolásával egy jogosult kérés háromféleképpen zárulhat:

  1. Korai találat. A drop-in megtalál egy tárolt dokumentumot az útvonaltérképben, és még a WordPress betöltése előtt továbbítja. A válasz tartalmazza a X-Blockstudio-Static-Prerender: HIT-EARLY értéket.
  2. Találat. Elindul a WordPress, majd a template_redirect ponton a Blockstudio talál egy friss tárolt dokumentumot, és a sablon renderelése helyett azt küldi el. A válasz tartalmazza a X-Blockstudio-Static-Prerender: HIT értéket.
  3. Nincs találat. A WordPress a szokásos módon jeleníti meg az oldalt. Ha a látogató névtelen, az eredmény pedig egy teljes HTML dokumentum 200 állapotkóddal, a Blockstudio eltárolja a következő kéréshez.

A nem jogosult kérések egyáltalán nem érintik a gyorsítótárat.

1. lépés: A profil és a gyorsítótár bekapcsolása

Kezdje a teljesítményprofillal és az előzetes rendereléssel, a korai kiszolgálás kikapcsolása mellett:

JSON
{
  "$schema": "https://blockstudio.dev/schema/blockstudio",
  "performance": {
    "profile": "speed",
    "staticPrerender": {
      "enabled": true,
      "ttl": 86400,
      "earlyServe": false,
      "dynamicPaths": ["/account", "/checkout", "/login"],
      "warm": {
        "enabled": true,
        "interval": 900,
        "concurrency": 4
      }
    }
  }
}

Az egyes beállítások funkciója:

  • A profile: "speed" bekapcsolja az éles webhelyek előoldali alapbeállításait: eltávolítja a felesleges head-elemeket, az oEmbed-felfedezést, a XML-RPC elemet és az általános core-előoldali eszközöket, a webhelyen belüli hivatkozásokat pedig felhasználói szándék esetén előre betölti. Először az általános core-előoldali eszközök eltávolítását ellenőrizze, mert az ezektől függő oldalakon jól látható hibák jelentkeznek. Az egyedi értékek felülírják a profilt.
  • A staticPrerender.enabled regisztrálja a futtatókörnyezetet. Amíg false állapotban van, a funkció nem ír fájlokat és nem regisztrál kérési hookokat.
  • A ttl a tárolt dokumentum maximális kora másodpercben (alapértelmezés szerint 86400).
  • A dynamicPaths azokat az útvonal-előtagokat sorolja fel, amelyeket mindig élőben kell megjeleníteni.
  • A warm egy háttérben futó előmelegítőt ütemez, amely interval másodpercenként újrarendereli az elavult nyilvános URL-eket.

A $schema sor minden kulcsra kiterjed, így a JSON sématámogatását kínáló szerkesztő jelzi például az olyan hibát, mint a "ttl": 0 (a minimum 1).

2. lépés: A jogosult kérések meghatározása

A Blockstudio óvatosan választja ki a tárolandó tartalmat. Ezek a kérések mindig megkerülik a gyorsítótárat:

  • minden, ami nem GET
  • minden lekérdezési karakterláncot tartalmazó URL
  • wp-admin, wp-json, wp-login.php, xmlrpc.php, Ajax és cron
  • hírcsatornák, keresés és előnézeti útvonalak
  • X-WP-Nonce fejlécet küldő kérések
  • a dynamicPaths alatti útvonalak
  • wordpress_logged_in_*, wp-postpass_* vagy comment_author_email_* sütivel rendelkező látogatók, kivéve, ha be van kapcsolva a serveLoggedIn

A dinamikus útvonalak illesztése az útvonalhatárok szerint történik. A fenti beállítással:

Kérés Megkerüli
/pricing/ nem
/account/orders/ igen
/accounting/ nem
/checkout igen
/pricing/?utm_source=x igen
/blog/feed/ igen

Tároláskor csak teljes dokumentum marad meg: a válasznak <!doctype html vagy <html értékkel kell kezdődnie, 200 állapotkódúnak kell lennie, és nem tartalmazhatja a tárolást letiltó jelölőt. Ha egy sablont soha nem szabad eltárolni, a jelölőt bárhol kiírathatja az oldalon:

HTML
<!-- blockstudio:no-cache -->

Hibaoldalak soha nem kerülnek tárolásra, így egy témázott 404 soha nem jelenhet meg újra sikeres válaszként.

3. lépés: A találatok ellenőrzése

Nyisson meg néhány oldalt egy privát ablakban, majd kérdezze meg a Blockstudio eszköztől, mit tárol:

Shell
wp bs prerender status
JSON
{
    "enabled": true,
    "invalidate": "signature",
    "identity": "e6cdd3fcda14ad6ded85a763bd01a33b",
    "cacheRoot": ".../wp-content/blockstudio/cache/sites/.../static-prerender",
    "files": 0,
    "bytes": 0,
    "records": 0,
    "queue": {
        "pending": 0,
        "processing": 0,
        "done": 0,
        "unique": 0,
        "bytes": 0
    },
    ...
    "diagnostics": []
}

A dokumentumok tárolásával nő a files és a bytes értéke, a queue mutatja az előmelegítő hátralévő feladatait, a diagnostics pedig hatókörönként tartalmazza a találatok, a melléfogások, az összeállítások és a hibák számlálóit. Egyetlen oldal ellenőrzéséhez kérje le kétszer névtelen látogatóként, majd keresse a fejlécet:

Shell
curl -s -o /dev/null -D - https://example.com/pricing/ | grep -i x-blockstudio-static-prerender

A második válasz tartalmazza a X-Blockstudio-Static-Prerender: HIT értéket. Használjon az előzőek szerint egy GET elemet: a curl -I HEAD kérést küld, amely mindig megkerüli a gyorsítótárat.

4. lépés: Kiszolgálás a WordPress elindulása előtt

Ha a találatok megfelelőnek tűnnek, állítsa be a "earlyServe": true értéket. Ekkor a Blockstudio három kisebb állapotadatot kezel: egy wp-content/advanced-cache.php drop-int, egy megosztott wp-content/blockstudio-static-prerender-map.php útvonaltérképet és egy WP_CACHE deklarációt a wp-config.php fájlban. Ezek a következő adminisztrációs kéréskor települnek.

Néhány szabály biztonságossá teszi a megoldást megosztott tárhelyen és több webhelyes környezetben:

  • A Blockstudio soha nem ír felül olyan drop-int, térképet vagy WP_CACHE sort, amely nem az övé. Ha egy másik gyorsítótárazó bővítmény már birtokolja a advanced-cache.php elemet, a korai kiszolgálás kikapcsolva marad.
  • Ha a WP_CACHE már true értékre van definiálva, a wp-config.php érintetlen marad. Azokon a tárhelyeken, ahol a wp-config.php nem írható, definiálja saját maga.
  • Kiszolgálás előtt mind a drop-in, mind a PHP elérési út ellenőrzi, hogy a dokumentum által hivatkozott, tartalomhash-t tartalmazó Tailwind stíluslap továbbra is létezik-e. Ha nem, a kérés a WordPress felé irányul a formázás nélküli kiszolgálás helyett.
  • A Multisite bejegyzései egy térképen osztoznak, de a gazdagép, a kezdőútvonal és a webhelyazonosító alapján elkülönülnek.
  • A replayHeaders alatt megadott válaszfejléceket — alapértelmezés szerint Link — minden dokumentummal együtt tárolja, és minden találatnál ismét elküldi, így az oldal által a header() használatával küldött Link fejléc a korai kiszolgálás során is megmarad. A cookie- és gyorsítótárazási fejléceket soha nem küldi újra.

A korai találatok X-Blockstudio-Static-Prerender: HIT-EARLY-t hordoznak. A earlyServe vagy a enabled kikapcsolása egyszer eltávolítja az Blockstudio által birtokolt állapotot, az wp bs teardown pedig kifejezetten eltávolítja azt olyan Composer telepítéseknél, amelyeknek nincs deaktiválási hookjuk.

Bejelentkezett látogatók és azonos jelölés

Alapértelmezés szerint a bejelentkezett látogatók mindig élő renderelést kapnak. A "serveLoggedIn": true beállítás lehetővé teszi számukra egy már tárolt dokumentum használatát is, így a webhely a szerkesztők és az ügyfelek számára is ugyanolyan gyors, mint a névtelen látogatóknak.

A személyre szabott válaszok soha nem hoznak létre gyorsítótár-bejegyzéseket: bejelentkezett látogatóknál cache-miss esetén élő renderelés történik, tárolás nélkül. Ennek könnyű nem tulajdonítani jelentőséget. Ha a serveLoggedIn be van kapcsolva, a bejelentkezett látogató akkor kapja a névteleneknek szánt dokumentumot, ha az létezik, és csak akkor személyre szabott élő renderelést, ha nem. Az aktuális felhasználótól függő sablonágak csak cache-miss esetén jelennek meg, így ugyanaz az oldal látogatásonként megváltozik, a személyre szabott ág pedig gyakorlatilag soha nem fut a gyorsítótárazott útvonalakon.

A következő szabály érvényes: a dynamicPaths útvonalain kívül mindenhol a bejelentkezett felhasználók jelölésének bájtról bájtra meg kell egyeznie a névtelen felhasználókéval. Ez azt jelenti, hogy statikus útvonalakon renderelt sablonokban nem lehetnek is_user_logged_in() vagy wp_get_current_user() ágak:

PHP
<?php // Do not do this on a static route. ?>
<?php if ( is_user_logged_in() ) : ?>
  <a href="/account/">Hi, <?php echo esc_html( wp_get_current_user()->display_name ); ?></a>
<?php else : ?>
  <a href="/login/">Sign in</a>
<?php endif; ?>

Két egyszerű megoldás van. Helyezze az útvonalat a dynamicPaths alá, ha az egész oldal személyes, például egy fiók-irányítópult. Vagy hagyja statikusan az oldalt, és a személyes részt dinamikus blokk-szigetként jelenítse meg, amely a tárolt HTML fájlban gyorsítótár-biztos helyőrzőt ad, majd a látogató saját kérésében tölti le a valódi részletet:

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

A Gyorsítótárazott oldalakon megjelenő személyre szabott részletek útmutató bemutatja ennek a blokknak az elkészítését.

Aláírás vagy gráf érvénytelenítése

A invalidate határozza meg a tárolt dokumentumok lejáratát.

Szempont signature (alapértelmezett) graph
Ki tölti fel a gyorsítótárat névtelen cache-missek és az előmelegítő a build lépés, valamint a névtelen cache-missek
Mi járatja le a bejegyzéseket TTL, bejegyzések mentése, webhelyszintű változások új build, a TTL felső korlátként
Háttérbeli előmelegítő elérhető kikapcsolva
Mire alkalmas általános webhelyek telepítési folyamattal rendelkező webhelyek

A signature módhoz nincs szükség eszközökre. Egy bejegyzés mentése törli a gyorsítótárat vagy újramelegíti a főoldalt és az adott bejegyzés közvetlen hivatkozását, a webhelyszintű változások, például a sablonváltás pedig lecserélik a gyorsítótár-azonosítót.

A graph mód determinisztikus telepítésekhez való. A build a Static_Prerender_Runtime::build_plan() segítségével tervet számít, csak az érintett URL-eket rendereli, rögzíti az eredményeket, majd a kész készletet atomikusan aktiválja a Static_Prerender_Early_Serve::install_artifact_entry() segítségével. Ha valamely hivatkozott dokumentum ellenőrzése sikertelen, az előző készlet marad aktív. A hozzárendelt útvonalak a következő buildig az aktivált artefaktumból szolgálódnak ki, ezért a wp-adminban szerkesztett tartalom a következő telepítéssel jut el ezekre az útvonalakra. Ebben a módban a URL szerinti előmelegítő ki van kapcsolva, mert az artefaktumok egyetlen egységként épülnek fel és aktiválódnak. Egy tipikus éles környezet így néz ki:

JSON
{
  "performance": {
    "profile": "speed",
    "staticPrerender": {
      "enabled": true,
      "invalidate": "graph",
      "ttl": 2592000,
      "earlyServe": true,
      "serveLoggedIn": true,
      "dynamicPaths": [
        "/account",
        "/cart",
        "/checkout",
        "/login",
        "/reset-password"
      ]
    }
  }
}

A 30 napos ttl csak korlátozza, hogy a kiszolgált dokumentum mennyire lehet régi. A frissességet a gráfot újraépítő telepítés biztosítja. A build API, a sharding és a belső renderelési adatátvitel részleteit a Statikus előrenderelés referenciája ismerteti.

CDN elhelyezése az előtérben

Az előrenderelés már jelzi, mely válaszok oszthatók meg biztonságosan: pontosan azok, amelyek HIT fejlécet tartalmaznak. A forráskiszolgáló alakítsa ezt gyorsítótár-fejléccé, a CDN pedig kövesse a forráskiszolgálót. Ha az nginx a PHP-FPM előtt áll:

Nginx
map $upstream_http_x_blockstudio_static_prerender $edge_cache_control {
    "~^HIT"  "public, s-maxage=604800";
    default  "";
}

server {
    listen 80;
    server_name example.com;
    root /var/www/html;
    index index.php;

    location / {
        try_files $uri $uri/ /index.php?$args;
    }

    location ~ \.php$ {
        include fastcgi_params;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        fastcgi_pass unix:/run/php/php-fpm.sock;
        add_header Cache-Control $edge_cache_control;
    }
}

A reguláris kifejezés a HIT és a HIT-EARLY értékre is illeszkedik. Minden más válasznál a változó üres, az nginx pedig üres értékkel nem ad hozzá fejlécet, így a cache-missek, a dinamikus útvonalak és a bejelentkezett felhasználók renderelései nem kapnak megosztott gyorsítótár-élettartamot a forráskiszolgálón.

A CDN oldalán:

  • Csak akkor gyorsítótárazza a HTML tartalmát, ha a forráskiszolgáló gyorsítótár-élettartamot küld. Az enélküli válaszoknál tiltsa le az alapértelmezett edge TTL-t.
  • Kerülje meg az edge gyorsítótárat ugyanazoknál a sütiknél, amelyeket a Blockstudio személyesnek tekint (wordpress_logged_in_, wp-postpass_, comment_author_email_), valamint a saját dynamicPaths, wp-admin és wp-json esetében.
  • Minden olyan telepítés után ürítse a CDN gyorsítótárát, amely oldalakat, sablonokat vagy eszközöket módosít. A forráskiszolgáló gyorsítótára magától lecserélődik; az edge nem tudja, hogy ezt meg kellene tennie.

Ha a Tailwind szolgáltatást a "output": "link"-szel használja, a URL stíluslap fájlneve tartalomhash-t tartalmaz, ezért ez az útvonal hosszú élettartamú, változtathatatlan gyorsítótár-fejléccel szolgálható ki.

Karbantartási parancsok

Shell
wp bs prerender warm
wp bs prerender status
wp bs prerender purge
wp bs teardown

A warm sorba állítja az elavult nyilvános URL-eket, futásonként legfeljebb warm.concurrency darabot renderel közülük, és JSON összefoglalót ír ki. A purge eltávolítja az aktuális webhely tárolt dokumentumait és sorát. A teardown eltávolítja az cron eseményeit és a telepítés által birtokolt korai kiszolgálási állapotot, a konfigurációs fájlokat pedig érintetlenül hagyja.

A bevezetést ebben a sorrendben végezze: először a profilozás, majd az előrenderelés kikapcsolt earlyServe mellett, végül a korai kiszolgálás, amint a status és a fejlécek megfelelőnek tűnnek. Minden réteg külön visszaállítható az értékének visszaállításával.

Következő lépések