Gå til indhold

Statisk prerendering

Statisk prerendering er en valgfri anonym HTML-cache. Et cachebart svar skal være et komplet HTML-dokument og kan fravælges med <!-- blockstudio:no-cache -->. Blockstudio omgår som standard ikke-GET-anmodninger, forespørgselsstrenge, WordPress-administration, REST, Ajax, cron, feeds, søgeresultater under søgestien på webstedets rodsti (såsom /search/term/), forhåndsvisnings- og canvasheadere, anmodninger med nonce, erklærede dynamiske stier, adgangskode-/kommentarcookies og anmodninger fra indloggede brugere. En side, hvis sti kun indeholder et search– eller preview-segment længere nede, såsom /docs/blocks/preview/, caches som enhver anden side.

JSON
{
  "performance": {
    "staticPrerender": {
      "enabled": true,
      "ttl": 3600,
      "invalidate": "graph",
      "earlyServe": true,
      "serveLoggedIn": false,
      "dynamicPaths": ["/account", "/checkout"],
      "replayHeaders": ["Link"],
      "warm": {
        "enabled": true,
        "interval": 900,
        "concurrency": 4,
        "transport": "http"
      }
    }
  }
}

Indloggede brugere kan kun bruge et eksisterende cache-hit, når serveLoggedIn er sand; personaliserede svar opretter aldrig cacheposter. Dynamiske stier bruger sti-grænser, så /account matcher /account/orders, men ikke /accounting.

Når funktionen er deaktiveret, skriver den ingen filer, installerer ingen drop-in og registrerer ingen anmodnings- eller administrationshooks. earlyServe: false registrerer heller ikke noget Early Serve-admin-callback, og warm.enabled: false registrerer hverken et cron-callback eller en tidsplan. Deaktivering af en af funktionerne fjerner tidligere tilknyttet tilstand én gang; efterfølgende anmodninger udfører ingen kontrol af filsystemet eller oprydning af cron.

Deaktivering pr. miljø

Alle værdier ovenfor kan også angives med et indstillingsfilter. Blockstudio starter før det aktive tema, fra et plugin eller fra temaets autoload Composer, så den genindlæser sine runtimeindstillinger, når temaet er indlæst, og beslutter, hvilke statiske prerender-hooks der skal bruges ved after_setup_theme. Et filter tilføjet af et plugin eller i temaets functions.php træder derfor i kraft:

PHP
add_filter('blockstudio/settings/performance/staticPrerender/enabled', function ($enabled) {
    return 'local' === wp_get_environment_type() ? false : $enabled;
});

Deaktivering af funktionen på denne måde fungerer som deaktivering i blockstudio.json: der registreres ingen anmodnings-, indholds-, administrations- eller cron-hooks, og en side, der tidligere blev serveret tidligt, får sin Early Serve-post fjernet én gang. Et filter, der tilføjes senere, for eksempel på init, ændrer ikke, hvilke hooks der registreres.

Signatur- og graftilstande

signature-tilstand udfylder et identitetsnøglebaseret svar ved et normalt anonymt cache-miss. Det er praktisk for almindelige WordPress-websteder og roteres efter ændringer på webstedsniveau.

graph-tilstand er til deterministiske build-/deploy-integrationer. Kald Static_Prerender_Runtime::build_plan() med de aktive kilde-URL’er, render kun affectedUrls, og registrer derefter hvert resultat med persist_built_response() eller persist_skipped_response(). Planen sammenligner delte filer og de præcise afhængighedshashes for hver side. Slettede URL’er og urefererede HTML fjernes af garbage_collect().

PHP
use Blockstudio\Static_Prerender_Runtime;

$plan = Static_Prerender_Runtime::build_plan($sourceUrls);

foreach ($plan['affectedUrls'] as $url) {
    $result = render_with_dependencies($url);

    Static_Prerender_Runtime::persist_built_response(
        $url,
        $result['html'],
        $result['files'],
        $result['virtualHashes']
    );
}

$targets = array_keys($plan['live']);
Static_Prerender_Runtime::garbage_collect($targets);

Valgfrie argumenter for målhost og rodsti omskriver ruter til en udrulning uden at bruge den første sides sti som webstedets rod. Batchværktøjer kan bruge Static_Prerender_Batch_Renderer::render() og stabile N/TOTAL-fragmenter; Static_Prerender_Batch_Renderer::parse_shard() og select_shard() understøtter fragmentindstillingen, så en kalder kan beregne samme opdeling som rendereren. Under et build angiver Static_Prerender_Batch_Renderer::is_rendering(), om den aktuelle anmodning er en batchrendering i stedet for en besøgende, så en skabelon kan springe arbejde over, der ikke bør køre under et build. En internal-transport leveres af det generiske filter blockstudio/static_prerender/render_internal; den valgfrie reserve HTTP bruger den normale warm-header.

Hvad graftilstand registrerer

Med standardtransporten HTTP sender Static_Prerender_Batch_Renderer::render() hver warm-anmodning et signeret token, og anmodningen rapporterer de filer, den læste: skabelonen WordPress indlæste, skabelonen, skabelonfilerne og aktivfilerne for hver renderet Blockstudio-blok, filer tilføjet via blockstudio/render/dependencies samt, for en synkroniseret side, dens definitions-, skabelon-, indholds- og layoutfiler. Rapporten skrives til webstedets cachemappe, som rendereren og webserveren allerede deler for det renderede HTML. Ved næste build hasher build_plan() disse filer igen og markerer kun de ruter, hvis filer er ændret, sammen med nye ruter, ruter der er forbi deres ttl samt alle ruter, når en delt fil ændres (blockstudio.json, theme.json, style.css, functions.php, header.php, footer.php, alt under inc/, parts/ og templates/ samt kilderne til Blockstudios medfølgende UI-aktiver). Den delte signatur hasher kilder, aldrig kompileret output, så _dist-filerne, som et builds første rendering kompilerer, ændrer den ikke: artifact_entry() udleder build-id’et fra den samme signatur, som build_plan() så før rendering.

Indhold, der kun findes i databasen, er ikke en fil og registreres ikke: indlæg redigeret i administrationen, indstillinger, genererede rækker eller priser. Et build, der skal medtage sådanne ændringer, sender $force til build_plan() eller renderer selv de berørte URL’er. Transporten internal registrerer de afhængigheder, som dens filter returnerer.

Tidlig servering og atomisk udrulning

Når earlyServe er aktiveret, ejer Blockstudio en lille wp-content/blockstudio-static-prerender-map.php, en advanced-cache.php-drop-in og én præcis WP_CACHE-deklaration. Drop-in-filen læser et rutekort pr. websted og streamer et kvalificeret cache-hit før WordPress, plugins eller temaet starter.

Blockstudio overskriver aldrig et fremmed kort, en drop-in eller en WP_CACHE-deklaration. Grafartefakter validerer hver refereret HTML-fil, før kortet udskiftes; den tidligere graf forbliver aktiv, hvis valideringen mislykkes. Multisite-poster deler kortet, men er adskilt efter vært, rodsti og websteds-id. Deaktivering af funktionen eller afaktivering af Blockstudio fjerner kun posten for det aktuelle websted og fjerner delte artefakter, når den sidste tilknyttede post er væk.

Udrulningsværktøjer kan aktivere en fuldt renderet graf atomisk:

PHP
$entry = Static_Prerender_Runtime::artifact_entry($targetUrls);

Blockstudio\Static_Prerender_Early_Serve::install_artifact_entry(
    $entry,
    Static_Prerender_Runtime::cache_root_path()
);

Konfigurationen er fortsat autoritativ. install_artifact_entry() returnerer false, medmindre både enabled og earlyServe er sande, så en udrulning aldrig kan installere et kort, en drop-in og en WP_CACHE-deklaration, som den næste admin-anmodning fjerner igen.

install_artifact_entry() bevarer postens build_id, så en udrulning kan sammenligne den med den post, installed_map_entries() returnerer bagefter. Kortet er en PHP-fil, der læses med include, og hver skrivning fjerner den fra opcode-cachen, så læsningen ser den nye post i samme proces, også når opcache.enable_cli er slået til.

Installation af en artefakt flytter dens dokumenter ind i et dedikeret artefaktområde, som aldrig berøres af oprydning efter opbevaringsperioden, og filer, kortet henviser til, er beskyttet mod sletning, uanset hvor de ligger. Dermed kan live rendertrafik ikke forælde kortlagte ruter ud af tidlig servering. En rutenøgle er ikke fuldt indholdsadresseret, så en ny rendering kan ændre et dokument uden at ændre dets nøgle; installationen sammenligner bytes og erstatter atomisk et artefaktdokument, hvis det afviger, lader identiske dokumenter være urørte og bevarer et artefaktdokument, hvis dets lagrede kopi er forsvundet. Static_Prerender_Early_Serve::last_promotion() rapporterer, hvor mange ruter der blev fremmet, erstattet, sprunget over eller bevaret ved den seneste installation, så en udrulning kan logge det.

Et lagret dokument fastlåser de buildaktiver, det linker til via URL, og disse filer har deres egen opbevaringstid, så den ene kan overleve den anden. Før servering kontrollerer både PHP-cachen og drop-in-filen, at et linket indholds-hashet Tailwind-stylesheet stadig findes på disken. Et dokument, hvis stylesheet mangler, sendes til WordPress i stedet for at blive serveret uden styling; dermed publiceres stylesheetet og dokumentet sammen igen. Samme kontrol køres, før et svar lagres, så et dokument, der ikke kunne serveres, aldrig skrives.

En anmodning, hvis Accept-header indeholder text/markdown, omgår både PHP-lageret og drop-in-filen, fordi lagrede dokumenter er HTML, og en side kan besvare anmodningen med sin kilde Markdown. Serverede dokumenter sender derfor Vary: Accept. Opdatering af Blockstudio omskriver en ældre drop-in ved næste kortskrivning.

Kortlagte grafruter bruger altid den aktiverede artefakt. Hvis en sikker anonym rute ikke findes i kortet, men WordPress siden har renderet og gemt den, falder Early Serve tilbage til runtime-lageret med identitetsnøgle, før WordPress startes. Det understøtter genererede ruter eller ruter i den lange ende uden for en bevidst afgrænset udrulningsgraf. Reserven bruger den aktiverede grafidentitet og de samme regler for vært, normalisering af sti, TTL, cookie, header, forespørgselsstreng, dynamisk sti og omgåelse af feeds som kortlagte ruter, og den finder kun dokumenter, der er gemt af runtime, som aldrig omfatter søgeresultater.

Svarheadere

Et gemt dokument afspilles igen uden den anmodning, der genererede det, så en header, som et tema eller plugin sender med header(), ville mangle ved hvert hit. Blockstudio gemmer de headere, der er angivet i replayHeaders, sammen med hvert dokument og sender dem igen fra både PHP-cachen og drop-in-komponenten til tidlig levering. Standardindstillingen, ["Link"], omfatter headere som en alternativ Markdown (rel="alternate"; type="text/markdown"), rel="describedby" eller rel="canonical". Navne sammenlignes uden hensyn til store og små bogstaver, og indstillingsfilteret ændrer listen på samme måde som enhver anden værdi:

PHP
add_filter('blockstudio/settings/performance/staticPrerender/replayHeaders', function (array $headers): array {
    $headers[] = 'X-Robots-Tag';

    return $headers;
});

Sæt replayHeaders til [] for at deaktivere genafsendelse af headere. En eksplicit liste erstatter standardlisten, så medtag Link, når du tilføjer andre headernavne, hvis du stadig vil genafspille linkheadere.

Headere indsamles i den proces, der genererer siden: fra headers_list(), når et live-cachemiss gemmes, og fra selve warm-anmodningen, når et build eller warmeren genererer over HTTP, så en header, som webserveren selv tilføjer og føjer til hvert serveret dokument, aldrig gemmes. Kun når en HTTP-generering ikke skriver nogen rapport, bruges headerne fra dens svar. internal-transporten returnerer dem som headers i sit resultat, og persist_built_response() tager dem som sit sidste argument, enten som linjer i Name: value-format eller som et map fra navn til værdi.

De skrives til <key>.headers.json ved siden af dokumentet, følger det gennem promovering af artefakter, garbage collection og oprydning efter opbevaringsperioden og fjernes, når en ny generering ikke sender nogen. Cookie-, cache- og transportheadere gemmes eller genafspilles aldrig, heller ikke når de er angivet: Set-Cookie, Cache-Control, Expires, Pragma, Age, ETag, Last-Modified, Vary, Content-Type, Content-Length, Content-Encoding, Transfer-Encoding, Location, Status, Date samt hop-by-hop- og godkendelsesheadere. Et serveret dokument angiver sine egne Content-Type og Vary.

Gemte headere kontrolleres igen mod listen, når de sendes. PHP-cachen læser den aktuelle indstilling; drop-in-komponenten læser kopien i webstedets map-post, som opdateres ved næste installation af et artefakt eller synkronisering af mappet. Dokumenter, der blev gemt før en opgradering, har ingen headerfil og serveres præcis som før, indtil de genereres igen.

Opvarmning, vedligeholdelse og overvågning

Opvarmningskøen er holdbar, URL-samlet, single-flight og gendanner krav med timeout. Indholds- og webstedsændringer gennemtvinger et erstatningsjob, selv når den aktuelle signatur er uændret; intervalkørsler sætter kun forældet arbejde i kø. Hver kørsel, planlagt eller via wp bs prerender warm, renderer op til warm.concurrency job. Tilstanden graph slår opvarmning pr. URL fra, fordi grafartefakter bygges og aktiveres som én enhed.

Shell
wp bs prerender warm
wp bs prerender status
wp bs prerender purge
wp bs prerender map status
wp bs prerender map prune --dry-run

status rapporterer den aktive identitet, filer, bytes, grafposter, køtilstand, rapporten om Early Serve-kortet samt tællere for hits/misses/builds/fejl pr. område.

Early Serve-kortet deles af alle websteder i en installation. map status (og Static_Prerender_Early_Serve::map_report()) viser poster, som tidlig servering ikke længere kan bruge: orphaned-poster, hvis websted ikke længere findes, og dead-poster, hvis mappe er væk, samt antallet af missing-ruterdokumenter i de resterende poster. map prune (Static_Prerender_Early_Serve::prune_map()) fjerner forældreløse og døde poster under kortlåsen og rapporterer årsagen for hver; --dry-run rapporterer kun. Fjernes den sidste post, fjernes kortet, drop-in-filen og WP_CACHE-deklarationen. Sletning af et websted fra et multisite-netværk fjerner straks dets poster, og cacherensning indsamler aldrig navneområdet, som en aktiveret artefakt serveres fra, så poster bliver kun ugyldige, når deres filer fjernes på anden vis.

Følg individuelle svarresultater med blockstudio/static_prerender/outcome og alle delte cacheresultater med blockstudio/cache/outcome.

Afinstallation

Installationer uden et plugin-deaktiveringshook, såsom Composer-medfølgende opsætninger, kan fjerne alt, hvad funktionen ejer, med én kommando:

Shell
wp bs teardown

Den fjerner de cron-hændelser og den statiske prerendertilstand, som installationen ejer: kortposten for det aktuelle websted samt den delte drop-in og WP_CACHE-deklarationen, når den sidste tilknyttede post er væk. Konfigurationsfilerne efterlades urørte, så funktionen kan aktiveres igen uden problemer.

Brug i produktion

En fornuftig rækkefølge for indførelsen:

  1. Sæt performance.profile til speed, og kontrollér derefter head-output, feeds og eventuelle plugins, der afhænger af oEmbed eller XML-RPC.
  2. Generér assets/media.json, flyt skabeloner til bs_media_image(), og slå derefter performance.media.lazy til.
  3. Aktivér performance.staticPrerender med earlyServe slået fra, verificér hits med wp bs prerender status, og slå derefter earlyServe til.

Tilbagerulning sker pr. funktion: Når staticPrerender.enabled sættes til false, fjernes Blockstudio-ejet Early Serve-tilstand og opvarmningsplaner én gang, hvorefter prerender-runtime forbliver uregistreret. Når performance.profile sættes tilbage til compat, fortrydes profilen. Hvert valg lader de øvrige lag være intakte.

Ydeevne

Profilerne, profileren og renderteknikkerne bag dem.

Caching

Den ene cachemappe, som alle genererede artefakter ligger i.