Pri pobegu se zlahka zmotimo, ker je več različnih služb od daleč videti podobnih. Imate besedilo, besedilo vsebuje posebne znake in drug sistem ga mora prejeti, ne da bi ga napačno razumel. Napaka je domneva, da ena vrsta pobega deluje povsod.
Kodiranje URL-jev, ubežanje HTML in ubežanje JSON rešujejo različne težave. Presledek v nizu poizvedbe ni enaka težava kot znak < v upodobljenem HTML-ju ali narekovaj v nizu JSON. Orodje Case / Slug / Escape pomaga tako, da ohranja te izhode blizu skupaj, vendar je koristno vedeti, kateri izhod pripada cilju, ki ga pripravljate.
Kodiranje URL-jev je za URL-je in vrednosti poizvedbe
Uporabite kodiranje URL-jev, ko gre besedilo v komponento URL-ja, zlasti poizvedbeni parameter ali vrednost, ki lahko vsebuje presledke, ločila ali znake, ki niso varni za pot.
Recimo, da mora povezava za podporo vključevati iskalni izraz, kot je pricing & billing. Če to besedno zvezo prilepite neposredno v URL, lahko spremenite razlago URL-ja, ker ima & že pomen znotraj poizvedbenega niza. Kodiranje URL spremeni besedilo v obliko, ki lahko potuje znotraj URL-ja, ne da bi vas zamenjala sintaksa URL-ja.
To se razlikuje od ustvarjanja slug. slug običajno spremeni naslov v berljiv segment poti, kot je pricing-and-billing. Kodiranje URL bolj neposredno ohranja izvirno vrednost za transport.
Ubežanje HTML je za besedilo, ki bo upodobljeno v HTML
Uporabite ubežnike HTML, ko mora biti besedilo prikazano kot besedilo znotraj konteksta HTML, ne pa postati oznaka.
Če primer kode vključuje <button> in želite, da bralci vidijo te znake, brskalnik potrebuje ubežne znake. V nasprotnem primeru jih lahko razlaga kot dejanski element. Ubežanje HTML je namenjeno preprečevanju branja besedila kot sintakse HTML na mestih, kjer bi morala vsebina ostati vidno besedilo.
To je pomembno pri dokumentaciji, poljih CMS, dnevnikih sprememb in kopiji izdelka. Še posebej je pomembno, če izvirno besedilo vključuje primere oznak, izrezke ali uporabniško ustvarjene vrednosti, ki ne smejo postati del strukture strani.
Ubežanje JSON je za vrednosti nizov znotraj JSON
Uporabite uhajanje JSON, ko mora biti besedilo varno znotraj niza JSON.
Narekovaj je v običajni prozi neškodljiv, toda znotraj niza JSON lahko zgodaj zapre niz. Nova vrstica lahko potrebuje tudi predstavitev, ki ohranja JSON veljaven. Pri ubežanju JSON gre za ohranjanje vrednosti, medtem ko je okoliški JSON razčlenljiv.
To se pogosto pojavi, ko ekipe izmenjujejo primere API-jev, izrezke konfiguracije, koristne podatke analitike ali vzorčne podatke. Če je naslednji korak širše čiščenje strukturiranih podatkov, združite ta članek s Kako formatirati JSON pred skupno rabo primera API-ja in JSON/YAML/TOML Converter.
Izberite pobeg glede na cilj
Najenostavnejše pravilo je najprej cilj.
| Destinacija | Uporaba | zakaj |
|---|---|---|
| Vrednost poizvedbe URL ali komponenta URL | URL kodiranje | Preprečuje razlago besedila kot sintakso URL-ja |
| Vidno besedilo znotraj HTML | Ubežanje HTML | Preprečuje, da bi posebni znaki postali oznaka |
| Vrednost niza znotraj JSON | JSON uhaja | Omogoča razčlenjevanje narekovajev, poševnic in prelomov vrstic |
| Javni članek ali naslov poti | Slug generacija | Ustvari berljivo besedilo poti, namesto da bi ohranil vsak znak |
Converty pomaga, ker lahko enkrat prilepite in primerjate rezultate, ne da bi za vsak primer odprli ločen kodirnik. To ohranja delo sorazmerno. Ne gradite plinovoda; pripravljate eno besedilno vrednost za mesto, kamor mora iti.
Odprite orodje Case / Slug / Escape, ko se morate odločiti, ali naj bo naslednji izhod slug, URL-kodirana vrednost, besedilo, varno za HTML, ali niz, varen za JSON.
