Siirry sisältöön

WordPressn tarjoaminen staattisena HTMLnä

Useimmat markkinointi- tai dokumentaatiosivuston sivut ovat samoja kaikille kirjautumattomille kävijöille. WordPress käynnistyy silti, lataa jokaisen lisäosan, suorittaa teeman ja hahmontaa lohkot jokaisella pyynnöllä. Sivun välimuistilisäosa voi auttaa, mutta se tuo mukanaan yhden lisäosan ja omat sääntönsä turvallisesti tallennettavista tiedoista.

Blockstudio sisältää valinnaisen staattisen esihahmonnuksen. Se tallentaa täydelliset kirjautumattomien käyttäjien HTML-dokumentit omaan välimuistihakemistoonsa ja voi luvallasi tarjota ne advanced-cache.php-pudotusosan kautta ennen kuin WordPress käynnistyy. Kaikki määritetään tiedostossa blockstudio.json.

Tässä oppaassa otetaan ominaisuus vaiheittain käyttöön, näytetään, miten välimuistiin tallennetut ja tallentamattomat tiedot tarkistetaan, selitetään yksi sääntö, joka suojaa kirjautuneita kävijöitä, ja lopuksi määritetään CDN-asetukset niin, että välimuistiin tallennetaan vain sisällön alkuperäispalvelimen välimuistikelpoiseksi merkitsemät tiedot.

Pyynnön käsittely

Kun esihahmonnus on käytössä, kelvollinen pyyntö päätyy johonkin kolmesta tuloksesta:

  1. Varhainen osuma. Pudotusosa löytää tallennetun dokumentin reittikartasta ja välittää sen ennen kuin WordPress latautuu. Vastaus sisältää arvon X-Blockstudio-Static-Prerender: HIT-EARLY.
  2. Osuma. WordPress käynnistyy, ja kohdassa template_redirect Blockstudio löytää tuoreen tallennetun dokumentin ja lähettää sen mallipohjan hahmonnuksen sijaan. Vastaus sisältää arvon X-Blockstudio-Static-Prerender: HIT.
  3. Huti. WordPress hahmontaa sivun tavalliseen tapaan. Jos kävijä ei ole kirjautunut sisään ja tulos on täydellinen HTML-dokumentti, jonka tila on 200, Blockstudio tallentaa sen seuraavaa pyyntöä varten.

Kelpaamattomat pyynnöt eivät koske välimuistiin lainkaan.

Vaihe 1: Ota profiili ja välimuisti käyttöön

Aloita suorituskykyprofiililla ja esihahmonnuksella, mutta pidä varhainen tarjoilu poissa käytöstä:

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
      }
    }
  }
}

Osien tehtävät:

  • profile: "speed" ottaa käyttöön tuotannon käyttöliittymän oletukset: head-kohina, oEmbed-haku, XML-RPC ja yleiset ytimen käyttöliittymäresurssit poistetaan, ja saman alkuperän linkit esiladataan käyttäjän aikomuksen perusteella. Ytimen käyttöliittymäresurssien poistaminen kannattaa testata ensin, sillä niistä riippuvainen sivu rikkoutuu näkyvästi. Mikä tahansa alemman tason arvo ohittaa profiilin.
  • staticPrerender.enabled rekisteröi suorituksen aikaisen toiminnan. Kun sen arvo on false, ominaisuus ei kirjoita tiedostoja eikä rekisteröi pyyntökoukkuja.
  • ttl määrittää tallennetun dokumentin enimmäisiän sekunteina (oletus 86400).
  • dynamicPaths luettelee polkuetuliitteet, jotka on aina hahmonnettava reaaliaikaisesti.
  • warm ajoittaa taustalla toimivan lämmittäjän hahmontamaan vanhentuneet julkiset URL-osoitteet uudelleen interval sekunnin välein.

Rivi $schema kattaa kaikki avaimet, joten JSON-skeematuki havaitsee virheet, kuten "ttl": 0 (vähimmäisarvo on 1).

Vaihe 2: Selvitä, mitkä pyynnöt kelpaavat

Blockstudio tallentaa tiedot varovaisesti. Seuraavat pyynnöt ohittavat aina välimuistin:

  • kaikki pyynnöt, jotka eivät ole tyyppiä GET
  • kaikki kyselymerkkijonon sisältävät URL-pyynnöt
  • wp-admin, wp-json, wp-login.php, xmlrpc.php, Ajax ja cron
  • syöte-, haku- ja esikatselupolut
  • pyynnöt, joissa lähetetään X-WP-Nonce-otsake
  • polut, jotka kuuluvat arvoon dynamicPaths
  • kävijät, joilla on wordpress_logged_in_*-, wp-postpass_*– tai comment_author_email_*-eväste, ellei serveLoggedIn ole käytössä

Dynaamiset polut täsmäävät polkurajojen mukaisesti. Yllä olevalla määrityksellä:

Pyyntö Ohitettu
/pricing/ ei
/account/orders/ kyllä
/accounting/ ei
/checkout kyllä
/pricing/?utm_source=x kyllä
/blog/feed/ kyllä

Tallennettavan sisällön on oltava täydellinen dokumentti: vastauksen on alettava muodolla <!doctype html tai <html, sen tilan on oltava 200 eikä se saa sisältää tallennuksesta kieltäytymisen merkkiä. Mallipohja, jota ei pidä koskaan tallentaa, voi tulostaa merkin mihin tahansa kohtaan sivua:

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

Virhesivuja ei koskaan tallenneta, joten teemoitettua 404-sivua ei voida koskaan näyttää onnistuneena sivuna.

Vaihe 3: Tarkista osumat

Käy muutamalla sivulla yksityisessä ikkunassa ja pyydä sitten Blockstudio näyttämään tallennettu sisältö:

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": []
}

files ja bytes kasvavat dokumenttien tallentuessa, queue näyttää lämmittäjän jonon ja diagnostics sisältää mittarikohtaiset osuma-, huti-, muodostus- ja virhelaskurit. Voit tarkistaa yksittäisen sivun pyytämällä sen kahdesti kirjautumattomana kävijänä ja etsimällä otsakkeen:

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

Toinen vastaus sisältää arvon X-Blockstudio-Static-Prerender: HIT. Käytä yllä kuvattua GET-arvoa: curl -I lähettää HEAD-pyynnön, joka ohittaa aina välimuistin.

Vaihe 4: Tarjoa ennen kuin WordPress käynnistyy

Kun osumat näyttävät oikeilta, määritä "earlyServe": true. Blockstudio hallitsee sen jälkeen kolmea pientä tilatietoa: wp-content/advanced-cache.php-pudotusosaa, jaettua wp-content/blockstudio-static-prerender-map.php-reittikarttaa sekä WP_CACHE-määritystä tiedostossa wp-config.php. Ne asennetaan seuraavan hallintapyynnön yhteydessä.

Muutama sääntö pitää tämän turvallisena jaetussa palvelinympäristössä ja multisite-asennuksessa:

  • Blockstudio ei koskaan korvaa drop-in-tiedostoa, karttaa tai WP_CACHE-riviä, joita se ei omista. Jos toinen välimuistilisäosa omistaa jo advanced-cache.php-kohteen, varhainen tarjoilu pysyy pois käytöstä.
  • Jos WP_CACHE on jo määritelty arvoksi true, wp-config.php jätetään ennalleen. Jos isäntäpalvelimella wp-config.php ei ole kirjoitettavissa, määritä se itse.
  • Ennen tarjoilua sekä drop-in että polku PHP tarkistavat, että dokumentin linkittämä sisältötiivisteinen Tailwind-tyylitiedosto on yhä olemassa. Jos se puuttuu, pyyntö ohjataan kohteeseen WordPress sen sijaan, että dokumentti tarjottaisiin ilman tyylejä.
  • Multisite-merkinnät jakavat yhden kartan, mutta ne eristetään isäntänimen, kotipolun ja sivuston tunnuksen perusteella.
  • replayHeaders-kohdassa nimetyt vastausotsakkeet, oletuksena Link, tallennetaan kunkin dokumentin yhteyteen ja lähetetään uudelleen jokaisella osumalla, joten sivun header()-yhteydessä lähettämä Link-otsake säilyy varhaisessa tarjoilussa. Eväste- ja välimuistiotsakkeita ei koskaan toisteta.

Varhaiset osumat sisältävät arvon X-Blockstudio-Static-Prerender: HIT-EARLY. Kun earlyServe tai enabled poistetaan käytöstä, niiden omistama tila Blockstudio poistetaan kerran, ja wp bs teardown poistaa sen erikseen asennuksissa Composer, joissa ei ole käytöstäpoistokoukkua.

Kirjautuneet kävijät ja identtinen merkkaus

Oletusarvoisesti kirjautuneet kävijät saavat aina reaaliajassa muodostetun sivun. Asetus "serveLoggedIn": true antaa heidän käyttää myös valmiiksi tallennettua asiakirjaa, jolloin sivusto on yhtä nopea toimittajille ja asiakkaille kuin kirjautumattomille kävijöille.

Personoiduista vastauksista ei koskaan luoda välimuistimerkintöjä: kirjautuneelle kävijälle välimuistin osuma tuottaa sivun reaaliajassa eikä sitä tallenneta. Tämän vaikutus jää helposti huomaamatta. Kun serveLoggedIn on käytössä, kirjautunut kävijä saa kirjautumattomille tarkoitetun asiakirjan aina, kun sellainen on olemassa, ja personoidun reaaliaikaisen sivun vain, jos sitä ei ole. Nykyiseen käyttäjään perustuvat mallipohjan haarat näkyvät vain välimuistin ohitustilanteissa, joten sama sivu muuttuu käyntien välillä ja personoitu haara jää käytännössä kuolleeksi välimuistitetuilla reiteillä.

Tästä seuraa sääntö: kaikilla reiteillä lukuun ottamatta kohdetta dynamicPaths kirjautuneiden käyttäjien merkkauksen on oltava tavutasolla identtinen kirjautumattomien merkkauksen kanssa. Tämä tarkoittaa, ettei staattisilla reiteillä renderöivissä mallipohjissa saa olla haaroja, jotka tarkistavat arvoja is_user_logged_in() tai wp_get_current_user():

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; ?>

Ratkaisuja on kaksi. Siirrä reitti kohteeseen dynamicPaths, jos koko sivu on henkilökohtainen, kuten tilin hallintapaneeli. Tai pidä sivu staattisena ja renderöi henkilökohtainen osa dynaamisena lohkosaarekkeena: tallennettu HTML sisältää välimuistiturvallisen paikkamerkin, ja todellinen katkelma noudetaan kävijän omassa pyynnössä:

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

Välimuistitetut sivut ja personoidut katkelmat-oppaassa rakennetaan kyseinen lohko.

Allekirjoituksen tai graafin mitätöinti

invalidate määrittää, miten tallennetut asiakirjat vanhenevat.

Ominaisuus signature (oletus) graph
Kuka täyttää välimuistin kirjautumattomien välimuistiohitukset ja lämmittäjä koontivaihe sekä kirjautumattomien välimuistiohitukset
Mikä vanhentaa merkinnät TTL, artikkelien tallennukset, sivustotason muutokset uusi koonti, TTL ylärajana
Taustalla toimiva lämmittäjä käytettävissä pois käytöstä
Sopii tavallisille sivustoille sivustoille, joilla on julkaisuketju

signature-tila ei vaadi työkaluja. Artikkelin tallennus tyhjentää etusivun ja artikkelin pysyvän linkin välimuistin tai lämmittää ne uudelleen, ja sivustotason muutokset, kuten teeman vaihtaminen, kierrättävät välimuistin tunnisteen.

graph-tila on tarkoitettu deterministisiin käyttöönottoihin. Koonti laskee suunnitelman käyttäen arvoa Static_Prerender_Runtime::build_plan(), renderöi vain vaikutuksen alaiset URL-osoitteet, tallentaa jokaisen tuloksen ja aktivoi valmiin kokonaisuuden atomisesti komennolla Static_Prerender_Early_Serve::install_artifact_entry(). Jos jonkin viitatun asiakirjan kelpoisuuden tarkistus epäonnistuu, edellinen kokonaisuus jää käyttöön. Kartoitettuja reittejä tarjotaan aktivoidusta artefaktista, kunnes seuraava koonti korvaa sen, joten wp-adminissa muokattu sisältö päivittyy näille reiteille seuraavassa käyttöönotossa. Tässä tilassa per-URL-lämmittäjä on pois käytöstä, koska artefaktit kootaan ja aktivoidaan yhtenä kokonaisuutena. Tyypillinen tuotantoratkaisu näyttää tältä:

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

30 päivän ttl rajaa vain sen, kuinka vanhaksi tarjottu asiakirja voi päästä. Ajantasaisuus tulee graafin uudelleen rakentavasta käyttöönotosta. Koonti API, ositus ja sisäinen renderöintisiirto käsitellään Staattisen esirenderöinnin viiteoppaassa.

CDN:n asettaminen eteen

Esirenderöinnistä näet jo, mitkä vastaukset voi jakaa: täsmälleen ne, joissa on HIT-otsake. Anna palvelimen muuntaa se välimuistiotsakkeeksi ja anna CDN:n seurata palvelimen määritystä. Kun nginx on PHP-FPM:n edessä:

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;
    }
}

Säännöllinen lauseke täsmää sekä arvoon HIT että arvoon HIT-EARLY. Kaikissa muissa vastauksissa muuttuja on tyhjä, eikä nginx lisää otsaketta, jonka arvo on tyhjä. Siksi välimuistihudit, dynaamiset polut ja kirjautuneiden käyttäjien sivut jäävät ilman jaetun välimuistin voimassaoloaikaa.

CDN-puolella:

  • Tallenna välimuistiin HTML vain, kun palvelin lähettää välimuistin voimassaoloajan. Poista oletusarvoinen reunapalvelimen TTL käytöstä vastauksilta, joilla sitä ei ole.
  • Ohita reunapalvelin samojen evästeiden kohdalla, joita Blockstudio käsittelee henkilökohtaisina (wordpress_logged_in_, wp-postpass_, comment_author_email_), sekä kohteiden dynamicPaths, wp-admin ja wp-json osalta.
  • Tyhjennä CDN jokaisen sivuja, mallipohjia tai resursseja muuttavan käyttöönoton jälkeen. Palvelimen välimuistin tunniste kiertyy itsestään; reunapalvelin ei tiedä, että sen pitäisi kiertyä.

Jos käytät Tailwind yhdessä arvon "output": "link" kanssa, tyylitiedosto URL sisältötiivistetään, joten sen polulle voi asettaa pitkäkestoisen muuttumattoman välimuistiotsakkeen.

Ylläpitokomennot

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

warm lisää vanhentuneet julkiset URL-osoitteet jonoon ja renderöi enintään warm.concurrency niistä yhdellä suorituskerralla. Se tulostaa yhteenvedon muodossa JSON. purge poistaa nykyisen sivuston tallennetut asiakirjat ja jonon. teardown poistaa kohteen cron tapahtumat sekä tämän asennuksen omistaman varhaisen tarjoilun tilan ja jättää määritystiedostot ennalleen.

Ota käyttöön tässä järjestyksessä: ensin profilointi, sitten esirenderöinti arvo earlyServe pois käytöstä ja lopuksi varhainen tarjoilu, kun status ja otsakkeet näyttävät oikeilta. Kunkin kerroksen voi palauttaa erikseen vaihtamalla sen arvon takaisin.

Seuraavat vaiheet