Pāriet uz saturu

Statiskā iepriekšējā renderēšana

Statiskā iepriekšējā renderēšana ir pēc izvēles ieslēdzama anonīma HTML kešatmiņa. Kešojamai atbildei jābūt pilnam HTML dokumentam, un kešošanu var atspējot ar <!-- blockstudio:no-cache -->. Blockstudio izlaiž pieprasījumus, kas nav GET pieprasījumi, vaicājuma virknes, WordPress admin, REST, Ajax, cron, plūsmas, meklēšanas rezultātus zem vietnes sākumceļa meklēšanas bāzes (piemēram, /search/term/), priekšskatījuma un kanvas galvenes, pieprasījumus ar nonce, deklarētos dinamiskos ceļus, paroles un komentāru sīkdatnes, kā arī pēc noklusējuma pieteikušos lietotāju pieprasījumus. Lapa, kuras ceļā search vai preview segments ir tikai tālāk, piemēram, /docs/blocks/preview/, tiek kešota tāpat kā jebkura cita lapa.

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

Pieteikušies lietotāji var izmantot esošu kešatmiņas trāpījumu tikai tad, ja serveLoggedIn ir true; personalizētas atbildes nekad neveido kešatmiņas ierakstus. Dinamiskajiem ceļiem tiek izmantotas ceļa robežas, tāpēc /account atbilst /account/orders, bet ne /accounting.

Kamēr funkcija ir atspējota, tā neraksta failus, neinstalē drop-in failu un nereģistrē pieprasījumu vai admin āķus. earlyServe: false tāpat nereģistrē Early Serve administratora atzvanīšanas funkciju, un warm.enabled: false nereģistrē cron atzvanīšanas funkciju vai grafiku. Izslēdzot kādu no šīm funkcijām, tās iepriekš pārvaldītais stāvoklis tiek noņemts vienu reizi; turpmākajos pieprasījumos netiek veiktas failu sistēmas vai cron tīrīšanas pārbaudes.

Izslēgšana katrā vidē

Katru iepriekš norādīto vērtību var iestatīt arī ar iestatījumu filtru. Blockstudio tiek palaists pirms aktīvās tēmas, no spraudņa vai tēmas Composer autoload, tāpēc pēc tēmas ielādes tas no jauna nosaka izpildlaika iestatījumus un izlemj, vai reģistrēt statiskās iepriekšējās renderēšanas āķus after_setup_theme. Tāpēc filtrs, ko pievieno spraudnis vai tēmas functions.php, stājas spēkā:

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

Šādi izslēdzot funkciju, rezultāts ir tāds pats kā izslēdzot to ar blockstudio.json: netiek reģistrēti pieprasījumu, satura, administratora vai cron āķi, un vietnei, kas iepriekš tika apkalpota agrīni, tās Early Serve ieraksts tiek noņemts vienu reizi. Vēlāk pievienots filtrs, piemēram, pie init, nemaina to, kuri āķi ir reģistrēti.

Paraksta un grafu režīmi

signature režīms parastā anonīmā kešatmiņas kļūmes gadījumā aizpilda atbildi, kuras atslēga ir identitāte. Tas ir ērts parastām WordPress vietnēm un tiek atjaunots pēc izmaiņām vietnes līmenī.

graph režīms paredzēts determinētām būvēšanas un izvietošanas integrācijām. Izsauciet Static_Prerender_Runtime::build_plan() ar aktīvajiem avota URL, renderējiet tikai affectedUrls un pēc tam reģistrējiet katru rezultātu ar persist_built_response() vai persist_skipped_response(). Plāns salīdzina koplietotos failus un katras lapas precīzās atkarību jaucējvērtības. Dzēstie URL un neizmantotie HTML tiek noņemti ar 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);

Neobligātie mērķa resursdatora un sākumceļa argumenti pārraksta maršrutus izvietošanai, neizmantojot pirmās lapas ceļu kā vietnes sakni. Paketes rīki var izmantot Static_Prerender_Batch_Renderer::render() un stabilas N/TOTAL daļas; opciju daļām nodrošina Static_Prerender_Batch_Renderer::parse_shard() un select_shard(), lai izsaucējs varētu aprēķināt to pašu sadalījumu, ko izmantotu renderētājs. Būvēšanas laikā Static_Prerender_Batch_Renderer::is_rendering() norāda, vai pašreizējais pieprasījums ir paketes renderēšana, nevis apmeklētāja pieprasījums, tāpēc veidne var izlaist darbības, kuras nevajadzētu veikt būvēšanas laikā. internal transportu nodrošina vispārīgais blockstudio/static_prerender/render_internal filtrs; pēc izvēles HTTP atkāpšanās mehānisms izmanto parasto iesildīšanas galveni.

Ko izseko grafa režīms

Izmantojot noklusējuma HTTP transportu, Static_Prerender_Batch_Renderer::render() katram iesildīšanas pieprasījumam nosūta parakstītu tokenu, un pieprasījums ziņo par nolasītajiem failiem: ielādēto veidni WordPress, katra renderētā Blockstudio bloka veidni, veidņu failiem un resursu failiem, failiem, kas pievienoti ar blockstudio/render/dependencies, kā arī sinhronizētai lapai — tās definīcijas, veidnes, satura un izkārtojuma failiem. Ziņojums tiek ierakstīts vietnes kešatmiņas direktorijā, kas renderētājam un tīmekļa serverim jau ir kopīga ar renderētajiem HTML. Nākamajā būvēšanas reizē build_plan() vēlreiz aprēķina šo failu jaucējvērtības un atzīmē tikai tos maršrutus, kuru faili ir mainījušies, kā arī jaunos maršrutus, maršrutus, kuriem beidzies ttl, un visus maršrutus, ja mainās koplietots fails (blockstudio.json, theme.json, style.css, functions.php, header.php, footer.php, viss zem inc/, parts/ un templates/, kā arī Blockstudio komplektā iekļauto UI resursu avoti). Koplietotais paraksts veidojams no avotiem, nekad nevis no kompilētās izvades, tāpēc _dist faili, ko kompilē būvēšanas pirmā renderēšana, to nemaina: artifact_entry() iegūst būvējuma ID no tā paša paraksta, ko build_plan() noteica pirms renderēšanas.

Saturs, kas atrodas tikai datubāzē, nav fails un netiek izsekots: administrēšanas panelī rediģētas ziņas, opcijas, ģenerētas rindas vai cenas. Būvēšana, kurā jāiekļauj šādas izmaiņas, nodod $force funkcijai build_plan() vai arī pati renderē ietekmētos URL. internal transports reģistrē atkarības, ko atgriež tā filtrs.

Agrīna piegāde un atomāra izvietošana

Ja ir iespējots earlyServe, Blockstudio pārvalda nelielu wp-content/blockstudio-static-prerender-map.php, advanced-cache.php drop-in failu un vienu precīzu WP_CACHE deklarāciju. Drop-in nolasa katrai vietnei paredzētu maršrutu karti un straumē atbilstošu kešatmiņas trāpījumu, pirms tiek palaists WordPress, spraudņi vai tēma.

Blockstudio nekad nepārraksta cita īpašnieka karti, drop-in failu vai WP_CACHE deklarāciju. Grafa artefakti pirms kartes nomaiņas pārbauda katru norādīto HTML failu; ja pārbaude neizdodas, iepriekšējais grafs paliek aktīvs. Daudzvietņu ieraksti izmanto kopīgu karti, taču ir nodalīti pēc resursdatora, sākumceļa un vietnes ID. Atspējojot funkciju vai deaktivizējot Blockstudio, tiek noņemts tikai pašreizējās vietnes ieraksts, bet koplietotie artefakti — tikai pēc pēdējā pārvaldītā ieraksta dzēšanas.

Izvietošanas rīki var atomāri aktivizēt pilnībā renderētu grafu:

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

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

Konfigurācija paliek noteicošā. install_artifact_entry() atgriež false, ja vien gan enabled, gan earlyServe nav true, tāpēc izvietošana nekad nevar instalēt karti, drop-in failu un WP_CACHE deklarāciju, ko nākamais administratora pieprasījums atkal noņemtu.

install_artifact_entry() saglabā ieraksta build_id, lai izvietošana varētu to salīdzināt ar ierakstu, ko pēc tam atgriež installed_map_entries(). Karte ir PHP fails, kas tiek nolasīts ar include, un katra rakstīšanas darbība to izņem no opcode kešatmiņas, tāpēc tajā pašā procesā nolasot redzams jaunais ieraksts arī tad, ja ir ieslēgts opcache.enable_cli.

Instalējot artefaktu, tā dokumenti tiek pārvietoti uz īpašu artefaktu tvērumu, ko saglabāšanas tīrīšana nekad neaizskar; kartē norādītie faili ir pasargāti no izlikšanas neatkarīgi no to atrašanās vietas, tāpēc aktīva renderēšana nevar izņemt kartētos maršrutus no agrīnās piegādes. Maršruta atslēga nav pilnībā balstīta uz satura jaucējvērtību, tāpēc atkārtota renderēšana var mainīt dokumentu, nemainot tā atslēgu. Instalēšana salīdzina baitus un atomāri aizstāj atšķirīgu artefakta dokumentu, atstāj identiskus dokumentus neskartus un saglabā artefakta dokumentu, kura kopija krātuvē ir pazudusi. Static_Prerender_Early_Serve::last_promotion() ziņo, cik maršrutu pēdējā instalēšana pārvietoja, aizstāja, izlaida vai paturēja, lai izvietošana to varētu reģistrēt.

Saglabāts dokuments piesaista būvējuma resursus, uz kuriem tas norāda, ar URL; to saglabāšanas termiņi ir atsevišķi, tāpēc viens var saglabāties ilgāk par otru. Pirms piegādes gan PHP kešatmiņa, gan drop-in pārbauda, vai diskā joprojām pastāv saistītā satura jaucējvērtībā balstītā Tailwind stila lapa. Ja stila lapa ir pazudusi, dokuments tiek nodots WordPress, nevis piegādāts bez stila; tas atkārtoti publicē stila lapu un dokumentu kopā. Tāda pati pārbaude tiek veikta pirms atbildes saglabāšanas, tāpēc netiek ierakstīts dokuments, ko nevarētu piegādāt.

Pieprasījums, kura Accept galvenē ir text/markdown, apiet gan PHP krātuvi, gan drop-in, jo saglabātie dokumenti ir HTML un lapa uz šo pieprasījumu var atbildēt ar savu avota Markdown. Tāpēc piegādātie dokumenti sūta Vary: Accept. Atjauninot Blockstudio, nākamajā kartes rakstīšanas reizē tiek pārrakstīts vecāks drop-in fails.

Kartē ietvertie grafa maršruti vienmēr izmanto aktivizēto artefaktu. Ja droša anonīma maršruta kartē nav, bet WordPress to kopš tā laika ir renderējis un saglabājis, Early Serve pirms WordPress palaišanas izmanto rezerves identitātes atslēgāto izpildlaika krātuvi. Tas ļauj izmantot ģenerētus vai reti apmeklētus maršrutus, kas atrodas ārpus apzināti ierobežota izvietošanas grafa. Rezerves mehānisms izmanto aktivizētā grafa identitāti un tādus pašus resursdatora, ceļa normalizācijas, TTL, sīkdatņu, galveņu, vaicājuma virkņu, dinamisko ceļu un plūsmu apiešanas noteikumus kā kartētie maršruti; tajā atrodami tikai izpildlaikā saglabāti dokumenti, kuros nekad nav meklēšanas rezultātu.

Atbildes galvenes

Saglabāts dokuments tiek atkārtoti parādīts bez pieprasījuma, kura laikā tas tika renderēts, tāpēc trūktu galvenes, ko tēma vai spraudnis sūta ar header(), katrā trāpījumā. Blockstudio kopā ar katru dokumentu saglabā galvenes, kas norādītas replayHeaders, un nosūta tās atkārtoti gan no PHP kešatmiņas, gan no agrīnās apkalpošanas ielāpa. Noklusējuma vērtība ["Link"] aptver tādas galvenes kā alternatīvo Markdown (rel="alternate"; type="text/markdown"), rel="describedby" vai rel="canonical". Nosaukumi tiek salīdzināti, neņemot vērā reģistru, un iestatījumu filtrs maina sarakstu tāpat kā jebkuru citu vērtību:

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

    return $headers;
});

Iestatiet replayHeaders uz [], lai atspējotu galveņu atkārtotu nosūtīšanu. Skaidri norādīts saraksts aizstāj noklusējuma sarakstu, tāpēc, pievienojot citus galveņu nosaukumus, iekļaujiet Link, ja joprojām vēlaties atkārtoti nosūtīt saišu galvenes.

Galvenes tiek iegūtas procesā, kurā lapa tiek renderēta: no headers_list(), kad tiek saglabāts tiešsaistes kešatmiņas trāpījums, un no pašā uzsildīšanas pieprasījuma, kad būve vai kešatmiņas uzsildītājs renderē pāri HTTP. Tāpēc galvene, ko tīmekļa serveris pievieno pats un pievieno atkārtoti katram apkalpotajam dokumentam, nekad netiek saglabāta. Tikai tad, ja HTTP renderēšana neieraksta pārskatu, tiek izmantotas tās atbildes galvenes. Transporta slānis internal tās atgriež kā headers savā rezultātā, un persist_built_response() tās saņem kā pēdējo argumentu — kā Name: value rindas vai nosaukumu un vērtību karti.

Tās tiek ierakstītas failā <key>.headers.json blakus dokumentam, tiek pārvietotas tam līdzi artefaktu paaugstināšanas, atkritumu savākšanas un saglabāšanas termiņa tīrīšanas laikā un tiek noņemtas, ja atkārtotas renderēšanas laikā netiek nosūtīta neviena galvene. Sīkdatņu, kešatmiņas un transporta galvenes nekad netiek saglabātas vai nosūtītas atkārtoti, pat ja tās ir norādītas: Set-Cookie, Cache-Control, Expires, Pragma, Age, ETag, Last-Modified, Vary, Content-Type, Content-Length, Content-Encoding, Transfer-Encoding, Location, Status, Date, kā arī pārlēciena un autentifikācijas galvenes. Apkalpots dokuments iestata savas Content-Type un Vary.

Saglabātās galvenes pirms nosūtīšanas vēlreiz tiek pārbaudītas atbilstoši sarakstam. PHP kešatmiņa nolasa pašreizējo iestatījumu; ielāps nolasa kopiju vietnes kartes ierakstā, ko atjaunina nākamā artefakta instalēšana vai kartes sinhronizācija. Dokumentiem, kas saglabāti pirms atjaunināšanas, nav galveņu faila, un tie tiek apkalpoti kā iepriekš, līdz tiek renderēti atkārtoti.

Iesildīšana, uzturēšana un novērojamība

Iesildīšanas rinda ir noturīga, apvieno URL, apstrādā vienu uzdevumu vienlaikus un atjauno noilguma dēļ zaudētās pretenzijas. Satura un vietnes izmaiņas vienmēr izveido aizstājējdarbu, pat ja pašreizējais paraksts nav mainījies; intervāla pārbaudes pievieno tikai novecojušos darbus. Katrā reizē — pēc grafika vai ar wp bs prerender warm — tiek renderēti līdz warm.concurrency darbiem. graph režīmā tiek izslēgta katra URL iesildīšana, jo grafa artefakti tiek veidoti un aktivizēti kā viena vienība.

Apvalks
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 ziņo par aktīvo identitāti, failiem, baitiem, grafa ierakstiem, rindas stāvokli, agrīnās piegādes kartes pārskatu un trāpījumu, kļūmju, būvēšanas un kļūdu skaitītājiem katrā tvērumā.

Agrīnās piegādes karte ir kopīga visām instalācijas vietnēm. map status (un Static_Prerender_Early_Serve::map_report()) uzskaita ierakstus, ko agrīnai piegādei vairs nevar izmantot: orphaned ierakstus vietnēm, kas vairs nepastāv, un dead ierakstus, kuru direktorija ir pazudusi, kā arī atlikušo ierakstu missing maršruta dokumentu skaitu. map prune (Static_Prerender_Early_Serve::prune_map()) kartes bloķēšanas laikā noņem pamestos un nederīgos ierakstus un ziņo par katru, norādot iemeslu; --dry-run tikai ziņo. Noņemot pēdējo ierakstu, tiek noņemta karte, drop-in fails un WP_CACHE deklarācija. Dzēšot vietni no daudzvietņu tīkla, tās ieraksti tiek noņemti uzreiz, savukārt kešatmiņas tīrīšana neaizvāc nosaukumvietu, no kuras tiek piegādāts aktivizētais artefakts. Tāpēc ieraksti kļūst nederīgi tikai tad, ja to failus noņem citādi.

Apskatiet atsevišķu atbilžu iznākumus ar blockstudio/static_prerender/outcome, bet visus koplietotās kešatmiņas iznākumus — ar blockstudio/cache/outcome.

Noņemšana

Instalācijas, kurās nav spraudņa deaktivizēšanas āķa, piemēram, komplektā ar Composer iekļautas konfigurācijas, var noņemt visu funkcijas pārvaldīto ar vienu komandu:

Apvalks
wp bs teardown

Tas noņem funkcijas pārvaldītos cron notikumus un statiskās iepriekšējās renderēšanas stāvokli: pašreizējās vietnes kartes ierakstu, kā arī koplietoto drop-in failu un WP_CACHE deklarāciju pēc pēdējā pārvaldītā ieraksta dzēšanas. Konfigurācijas faili paliek neskarti, tāpēc funkciju var atkal ieslēgt bez sarežģījumiem.

Lietošana produkcijas vidē

Ieteicamā ieviešanas secība:

  1. Iestatiet performance.profile uz speed, pēc tam pārbaudiet galvenes izvadi, plūsmas un visus spraudņus, kas izmanto oEmbed vai XML-RPC.
  2. Ģenerējiet assets/media.json, pārvietojiet veidnes uz bs_media_image(), pēc tam ieslēdziet performance.media.lazy.
  3. Iespējojiet performance.staticPrerender, atstājot earlyServe izslēgtu, pārbaudiet trāpījumus ar wp bs prerender status, pēc tam ieslēdziet earlyServe.

Atsaukšana notiek katrai funkcijai atsevišķi: iestatot staticPrerender.enabled uz false, vienu reizi tiek noņemts Blockstudio pārvaldītais Early Serve stāvoklis un iesildīšanas grafiki, pēc tam iepriekšējās renderēšanas izpildlaika vide vairs netiek reģistrēta. Iestatot performance.profile atpakaļ uz compat, profils tiek atcelts. Pārējie slāņi katrā gadījumā paliek spēkā.

Veiktspēja

Profili, profilētājs un pamatā esošās renderēšanas metodes.

Kešošana

Vienīgais kešatmiņas direktorijs, kurā atrodas visi ģenerētie artefakti.