Põgenemisel on lihtne eksida, sest mitu erinevat tööd näevad eemalt sarnased. Teil on tekst, tekst sisaldab erimärke ja mõni teine süsteem peab selle vastu võtma, ilma et sellest valesti aru saaks. Viga on eeldada, et üks põgenemine töötab igal pool.
URL-i kodeering, HTML-i vältimine ja JSON-i vältimine lahendavad erinevaid probleeme. Tühik päringustringis ei ole sama probleem, mis renderdatud HTML-i märk < või JSON-stringi sees olev jutumärk. Tööriist Case / Slug / Escape aitab hoida neid väljundeid lähestikku, kuid kasulik osa on teada, milline väljund kuulub teie ettevalmistatavasse sihtkohta.
URL-i kodeering on mõeldud URL-ide ja päringuväärtuste jaoks
Kasutage URL-i kodeeringut, kui tekst läheb URL-i komponenti, eriti päringuparameetrit või väärtust, mis võib sisaldada tühikuid, kirjavahemärke või tee jaoks mitteohutuid märke.
Oletame, et tugilink peab sisaldama otsinguterminit, näiteks pricing & billing. Selle fraasi kleepimine otse URL-i võib muuta URL-i tõlgendamist, kuna &-l on päringustringis juba tähendus. URL-i kodeerimine muudab teksti vormiks, mis võib URL-is liikuda, ilma et peaks URL-i süntaksis segadusse minema.
See erineb slug loomisest. slug muudab pealkirja tavaliselt loetavaks teelõiguks, näiteks pricing-and-billing. URL-i kodeering säilitab algse väärtuse transpordi jaoks otsesemalt.
HTML-i paokood on teksti jaoks, mis renderdatakse HTML-is
Kasutage HTML-i vältimist, kui tekst peab ilmuma tekstina HTML-i kontekstis, mitte muutuma märgistuseks.
Kui koodinäide sisaldab <button> ja soovite, et lugejad näeksid neid märke, vajab brauser tähemärke paomärki. Vastasel juhul võib see tõlgendada neid tegeliku elemendina. HTML-i põgenemise eesmärk on takistada teksti lugemist HTML-i süntaksina kohtades, kus sisu peaks jääma nähtavaks tekstiks.
See on oluline dokumentatsiooni, CMS-i väljade, muudatuste logide ja tootekoopia puhul. See on eriti asjakohane, kui lähtetekst sisaldab näiteid märgistusest, katkenditest või kasutaja loodud väärtustest, mis ei tohiks lehe struktuuri osaks saada.
JSON-i põgenemine on mõeldud JSON-i stringiväärtuste jaoks
Kasutage JSON-i vältimist, kui tekst peab jääma turvaliselt JSON-stringi.
Jutumärk on tavaproosas kahjutu, kuid JSON-stringi sees võib see stringi varakult sulgeda. Reavahetus võib vajada ka esitust, mis hoiab JSON-i kehtivana. JSON-i põgenemine tähendab väärtuse säilitamist, jättes samal ajal ümbritseva JSON-i sõelutavaks.
See ilmub sageli siis, kui meeskonnad jagavad API näiteid, konfiguratsioonijuppe, analüüsi kasulikke andmeid või näidisandmeid. Kui järgmine samm on laiem struktureeritud andmete puhastamine, siduge see artikkel artikliga Kuidas vormindada JSON-i enne API näite jagamist ja JSON-/YAML-/TOML-konverteriga.
Valige põgenemine sihtkoha põhjal
Lihtsaim reegel on sihtkoht kõigepealt.
| Sihtkoht | Kasuta | Miks |
|---|---|---|
| URL-i päringu väärtus või URL-i komponent | URL-i kodeering | Hoiab ära teksti tõlgendamise URL-i süntaksina |
| Nähtav tekst HTML-is | HTML põgenemine | Hoiab ära erimärkide muutumise märgistusteks |
| Stringi väärtus JSON-is | JSON põgeneb | Hoiab jutumärgid, kaldkriipsud ja reavahetused sõelutavad |
| Avalik artikkel või marsruudi pealkiri | Slug põlvkond | Loob loetava teeteksti, mitte ei säilita iga tähemärki |
Teisendamine aitab, sest saate ühe korra kleepida ja väljundeid võrrelda ilma iga juhtumi jaoks eraldi kodeerijat avamata. See hoiab töö proportsionaalsena. Te ei ehita torujuhet; valmistate ette ühe tekstiväärtuse selle koha jaoks, kuhu see minema peab.
Avage tööriist Case / Slug / Escape, kui peate otsustama, kas järgmine väljund peaks olema slug, URL-i kodeeringuga väärtus, HTML-i turvaline tekst või JSON-turvaline string.
