Liigu sisu juurde

Serveeri WordPress staatilise HTML-ina

Enamik turundus- või dokumentatsioonisaidi lehti on kõigile anonüümsetele külastajatele ühesugused. WordPress käivitub siiski iga päringuga, laadib kõik pluginad, käivitab teema ja renderdab plokid. Lehe vahemälu pluginast võib abi olla, kuid see lisab veel ühe muutuja oma reeglitega, mis määravad, mida võib turvaliselt salvestada.

Blockstudio sisaldab valikulist staatilist eeltöötlust. See salvestab anonüümsetele kasutajatele täielikud HTML-dokumendid oma vahemälu kataloogi ja teie loal teenindab neid WordPress käivitamise eel advanced-cache.php lisandmoodulist. Kõik seadistatakse failis blockstudio.json.

See juhend lülitab funktsiooni sammhaaval sisse, näitab, kuidas kontrollida, mida vahemällu salvestatakse, selgitab üht reeglit, mis kaitseb sisseloginud külastajaid, ning lõpeb CDN seadistusega, mis salvestab vahemällu ainult selle, mille lähteallikas märgib vahemällukõlblikuks.

Kuidas päringut teenindatakse

Kui eeltöötlus on lubatud, lõpeb sobiv päring ühel kolmest viisist:

  1. Varajane vahemälutabamus. Lisandmoodul leiab marsruutide kaardilt salvestatud dokumendi ja edastab selle enne, kui WordPress laaditakse. Vastuses on X-Blockstudio-Static-Prerender: HIT-EARLY.
  2. Vahemälutabamus. WordPress käivitub ning punktis template_redirect leiab Blockstudio värske salvestatud dokumendi ja saadab selle malli renderdamise asemel. Vastuses on X-Blockstudio-Static-Prerender: HIT.
  3. Vahemälumöödalask. WordPress renderdab lehe tavapäraselt. Kui külastaja on anonüümne ja tulemuseks on täielik HTML-dokument olekuga 200, salvestab Blockstudio selle järgmise päringu jaoks.

Sobimatud päringud ei puuduta vahemälu üldse.

1. samm: lubage profiil ja vahemälu

Alustage jõudlusprofiilist ja eeltöötlusest, jättes varajase teenindamise välja:

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

Mida iga osa teeb:

  • profile: "speed" lülitab sisse tootmise esilehe vaikeväärtused: eemaldatakse päise müra, oEmbedi tuvastus, XML-RPC ja üldised tuumiku esilehe varad ning sama päritoluga lingid eellaaditakse kasutaja kavatsuse korral. Tuumiku esilehe varade eemaldamist tuleks esimesena testida, sest neist sõltuv leht võib nähtavalt katki minna. Alammaatriksis määratud väärtused kirjutavad profiili üle.
  • staticPrerender.enabled registreerib käitusaja. Kui see on false, ei kirjuta funktsioon faile ega registreeri päringukonkse.
  • ttl määrab salvestatud dokumendi maksimaalse vanuse sekundites (vaikimisi 86400).
  • dynamicPaths loetleb teeprefiksid, mida tuleb alati reaalajas renderdada.
  • warm ajastab taustal soojendi, mis renderdab aegunud avalikud URL-id iga interval sekundi järel uuesti.

Rida $schema hõlmab kõiki võtmeid, nii et skeemituge pakkuv redaktor JSON märgib vea, näiteks "ttl": 0 (miinimum on 1).

2. samm: tehke kindlaks, millised päringud sobivad

Blockstudio salvestab sisu vahemällu ettevaatlikult. Järgmised päringud mööduvad vahemälust alati:

  • kõik päringud peale GET
  • kõik URL-id, millel on päringustring
  • wp-admin, wp-json, wp-login.php, xmlrpc.php, Ajax ja cron
  • vood, otsing ja eelvaate teed
  • päringud, mille päises saadetakse X-WP-Nonce
  • teed asukohas dynamicPaths
  • külastajad, kellel on küpsis wordpress_logged_in_*, wp-postpass_* või comment_author_email_*, välja arvatud juhul, kui serveLoggedIn on lubatud

Dünaamiliste teede vastavust kontrollitakse teepiiride järgi. Ülaltoodud seadistuse korral:

Päring Vahemälust mööda
/pricing/ ei
/account/orders/ jah
/accounting/ ei
/checkout jah
/pricing/?utm_source=x jah
/blog/feed/ jah

Salvestamise poolel hoitakse ainult täielikke dokumente: vastus peab algama <!doctype html või <html-ga, selle olek peab olema 200 ning see ei tohi sisaldada loobumismärget. Mall, mida ei tohi kunagi salvestada, saab selle märgi väljastada lehe mis tahes kohas:

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

Vealehti ei salvestata kunagi, seega ei saa kujundatud 404-i kunagi eduka vastusena uuesti esitada.

3. samm: kontrollige vahemälutabamusi

Külastage privaatses aknas mõnda lehte ja küsige seejärel Blockstudio-ilt, mis sinna salvestatud on:

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

Dokumentide salvestamisel kasvavad files ja bytes, queue näitab soojendi ootel töid ning diagnostics sisaldab iga ulatuse tabamuste, möödalaskude, ehituste ja tõrgete loendureid. Ühe lehe kontrollimiseks küsige seda anonüümse külastajana kaks korda ja otsige päist:

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

Teises vastuses on X-Blockstudio-Static-Prerender: HIT. Kasutage ülaltoodud GET-i: curl -I saadab HEAD-päringu, mis möödub alati vahemälust.

4. samm: teenindage enne WordPress käivitumist

Kui vahemälutabamused toimivad õigesti, määrake "earlyServe": true. Seejärel haldab Blockstudio kolme väikest olekuosa: wp-content/advanced-cache.php lisandmoodulit, jagatud wp-content/blockstudio-static-prerender-map.php marsruutide kaarti ja faili wp-config.php lisatavat WP_CACHE deklaratsiooni. Need paigaldatakse järgmisel halduspäringul.

Mõned reeglid aitavad tagada turvalisuse jagatud hostimises ja mitmiksaidis:

  • Blockstudio ei kirjuta üle lisandmoodulit, kaarti ega rida WP_CACHE-s, mida see ise ei halda. Kui advanced-cache.php kuulub juba mõnele teisele vahemäluprogrammile, jääb varajane esitamine välja.
  • Kui WP_CACHE on juba määratletud väärtusega true, jäetakse wp-config.php puutumata. Kui hostis pole wp-config.php kirjutatav, määra see ise.
  • Enne esitamist kontrollivad nii lisandmoodul kui ka PHP tee, kas dokumendi lingitud sisuräsiga Tailwind laaditabel on endiselt olemas. Kui seda pole, suunatakse päring WordPress-i, et lehte ei esitataks laadimistabelita.
  • Multisaidi kirjed jagavad üht kaarti, kuid on hosti, kodutee ja saidi ID järgi eraldatud.
  • Päised, mille nimed on loetletud jaotises replayHeaders (vaikimisi Link), salvestatakse iga dokumendiga ja saadetakse uuesti iga päringu korral, nii et lehe koos header()-ga saadetud Link päis säilib ka varajase esitamise korral. Küpsise- ja vahemälupäiseid ei esitata kunagi uuesti.

Varajased päringud sisaldavad X-Blockstudio-Static-Prerender: HIT-EARLY. earlyServe või enabled väljalülitamine eemaldab Blockstudio hallatava oleku ühe korra ning wp bs teardown eemaldab selle sõnaselgelt nende Composer paigalduste puhul, millel deaktiveerimiskonks puudub.

Sisseloginud külastajad ja identne märgistus

Vaikimisi renderdatakse sisseloginud külastajatele alati leht reaalajas. Seade "serveLoggedIn": true võimaldab neil kasutada ka olemasolevat salvestatud dokumenti, nii et sait on toimetajatele ja klientidele sama kiire kui anonüümsetele külastajatele.

Isikupärastatud vastused ei loo kunagi vahemälukirjeid: sisseloginud kasutaja möödalaske korral renderdatakse leht reaalajas ja tulemust ei salvestata. Selle tagajärge on lihtne mitte märgata. Kui serveLoggedIn on sisse lülitatud, saab sisseloginud külastaja anonüümse dokumendi alati, kui see olemas on, ja isikupärastatud reaalajas renderduse ainult siis, kui seda pole. Praegusest kasutajast sõltuv malliharund käivitub ainult möödalaske korral, nii et sama leht muutub külastuste vahel ja isikupärastatud haru jääb vahemällu salvestatud marsruutidel sisuliselt kasutamata.

Sellest tuleneb järgmine reegel: igal marsruudil väljaspool dynamicPaths peab sisseloginud kasutaja märgistus olema baidi täpsusega identne anonüümse kasutaja märgistusega. See tähendab, et staatilistel marsruutidel renderduvates mallides ei tohi olla harusid, mis sõltuvad väärtustest is_user_logged_in() või 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; ?>

Probleemile on kaks lihtsat lahendust. Viige marsruut asukohta dynamicPaths, kui kogu leht on isiklik, näiteks konto töölaud. Või jätke leht staatiliseks ja renderdage isiklik osa dünaamilise plokisaarena, mis lisab salvestatud HTML-i vahemälusõbraliku kohatäitja ning hangib tegeliku fragmendi külastaja enda päringuga:

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

Juhendis Isikupärastatud fragmendid vahemällu salvestatud lehtedel ehitatakse see plokk.

Allkirja või graafi kehtetuks muutmine

invalidate määrab, millal salvestatud dokumendid aeguvad.

Aspekt signature (vaikimisi) graph
Kes vahemälu täidab anonüümsed möödalasked ja soojendaja koostamisetapp ja anonüümsed möödalasked
Mis kirjed aeguma paneb TTL, postituste salvestamine, saiditaseme muudatused uus koostamine, TTL on ülempiir
Taustal töötav soojendaja saadaval väljas
Sobib tavalistele saitidele juurutuskonveieriga saitidele

Režiim signature ei vaja tööriistu. Postituse salvestamine tühjendab avalehe ja selle postituse püsilingi vahemälu või soojendab selle uuesti; saiditaseme muudatused, näiteks teema vahetamine, uuendavad vahemälu identiteedi.

Režiim graph on mõeldud deterministlikeks juurutusteks. Koostamisel arvutatakse plaan käsuga Static_Prerender_Runtime::build_plan(), renderdatakse ainult mõjutatud URL-id, salvestatakse iga tulemus ja aktiveeritakse valmis komplekt atomaarse toiminguga Static_Prerender_Early_Serve::install_artifact_entry(). Kui mõne viidatud dokumendi valideerimine ebaõnnestub, jääb eelmine komplekt aktiivseks. Kaardistatud marsruute serveeritakse aktiveeritud artefaktist, kuni järgmine koostamine selle asendab, seega jõuab wp-adminis muudetud sisu neile marsruutidele järgmise juurutusega. Režiimis on URL-põhine soojendaja välja lülitatud, sest artefaktid koostatakse ja aktiveeritakse ühe tervikuna. Tüüpiline tootmiskeskkonna ülesehitus on järgmine:

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

30-päevane ttl seab ainult ülempiiri sellele, kui vana serveeritav dokument võib olla. Värskuse tagab graafi uuesti koostav juurutus. Koostamise API, tükeldamist ja sisemist renderdustransporti käsitletakse Staatilise eelpäranduse viitedokumendis.

CDN paigutamine esiküljele

Eelpärandus näitab juba, milliseid vastuseid võib turvaliselt jagada: just neid, millel on päis HIT. Laske päritoluserveril see teisendada vahemälupäiseks ja laske CDN-l päritoluserveri seadeid järgida. Kui PHP-FPM-i ees on nginx:

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

Regulaaravaldis vastab nii HIT-ile kui ka HIT-EARLY-le. Kõigi teiste vastuste korral on muutuja tühi ja nginx ei lisa tühja väärtusega päist. Seega ei saa möödalasked, dünaamilised teed ega sisseloginud kasutajate renderdused päritoluserverilt jagatud vahemälu säilitusaega.

CDN-i poolel:

  • Salvestage vahemällu HTML ainult siis, kui päritoluserver saadab vahemälu säilitusaja. Keelake vastuste vaikeväärtusena kasutatav serva TTL, kui seda pole määratud.
  • Jätke servavahemälu vahele samade küpsiste puhul, mida Blockstudio käsitleb isiklikena (wordpress_logged_in_, wp-postpass_, comment_author_email_), ning teie dynamicPaths, wp-admin ja wp-json puhul.
  • Tühjendage CDN pärast iga juurutust, mis muudab lehti, malle või varasid. Päritoluserveri vahemälu uueneb ise; servavahemälu ei tea, et peaks seda tegema.

Kui kasutate Tailwind-i koos "output": "link"-ga, sisaldab laaditabel URL sisuräsi, nii et seda teed saab serveerida pika kehtivusajaga muutumatu vahemälupäisega.

Hoolduskäsud

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

warm lisab vananenud avalikud URL-id järjekorda ja renderdab igal käivitamisel kuni warm.concurrency neist, väljastades kokkuvõtte JSON. purge eemaldab praeguse saidi salvestatud dokumendid ja järjekorra. teardown eemaldab cron sündmused ja selle paigalduse hallatava varase serveerimise oleku, jättes konfiguratsioonifailid puutumata.

Juurutage selles järjekorras: esmalt profiil, seejärel eelpärandus nii, et earlyServe on välja lülitatud, ja lõpuks varajane serveerimine, kui status ja päised on õiged. Iga kihi saab eraldi tagasi pöörata, taastades selle algse väärtuse.

Järgmised sammud