Pakeneminen on helppo erehtyä, koska useat erilaiset työt näyttävät kaukaa katsottuna samanlaisilta. Sinulla on tekstiä, teksti sisältää erikoismerkkejä ja toisen järjestelmän on vastaanotettava se ymmärtämättä sitä väärin. Virhe on olettaa, että yhdenlainen pakeneminen toimii kaikkialla.
URL-koodaus, HTML-koodinvaihto ja JSON-koodinvaihto ratkaisevat erilaisia ongelmia. Välilyönti kyselymerkkijonossa ei ole sama ongelma kuin <-merkki renderoidussa HTML-koodissa tai lainausmerkki JSON-merkkijonon sisällä. Case / Slug / Escape -työkalu auttaa pitämään tulosteet lähellä toisiaan, mutta hyödyllistä on tietää, mikä tuloste kuuluu valmistelemaasi kohteeseen.
URL-koodaus on tarkoitettu URL-osoitteille ja kyselyarvoille
Käytä URL-koodausta, kun tekstiä menee URL-komponenttiin, erityisesti kyselyparametriin tai arvoon, joka voi sisältää välilyöntejä, välimerkkejä tai poluille turvallisia merkkejä.
Oletetaan, että tukilinkin tulee sisältää hakutermi, kuten pricing & billing. Tämän lauseen liittäminen suoraan URL-osoitteeseen voi muuttaa URL-osoitteen tulkintaa, koska & on jo merkitys kyselymerkkijonossa. URL-koodaus muuttaa tekstin muodoksi, joka voi kulkea URL-osoitteen sisällä hämmentymättä URL-syntaksia.
Tämä eroaa slug:n luomisesta. slug muuttaa yleensä otsikon luettavaksi polkusegmentiksi, kuten pricing-and-billing. URL-koodaus säilyttää alkuperäisen arvon suoremmin kuljetusta varten.
HTML escaping on tekstille, joka renderöidään HTML:llä
Käytä HTML-pakomerkkiä, kun tekstin on näytettävä tekstinä HTML-kontekstin sisällä, ei merkintänä.
Jos koodiesimerkki sisältää <button> ja haluat lukijoiden näkevän kyseiset merkit, selain tarvitsee koodinvaihtomerkit. Muuten se voi tulkita ne todelliseksi elementiksi. HTML-pakotoiminnolla on kyse tekstin lukemisen estämisestä HTML-syntaksina paikoissa, joissa sisällön tulee pysyä näkyvänä tekstinä.
Sillä on merkitystä dokumentaatiossa, CMS-kentissä, muutoslokeissa ja tuotekopiossa. Se on erityisen olennaista, kun lähdeteksti sisältää esimerkkejä merkinnöistä, katkelmista tai käyttäjien luomista arvoista, joiden ei pitäisi olla osa sivurakennetta.
JSON-escaping on tarkoitettu JSON-merkkijonoarvoille
Käytä JSON-merkkiä, kun tekstin on oltava turvallisesti JSON-merkkijonon sisällä.
Lainausmerkki on vaaraton normaalissa proosassa, mutta JSON-merkkijonon sisällä se voi sulkea merkkijonon aikaisin. Rivinvaihto voi myös tarvita esityksen, joka pitää JSONin voimassa. JSON-pakotuksessa on kyse arvon säilyttämisestä samalla, kun ympäröivä JSON pysyy jäsennettävissä.
Tämä näkyy usein, kun tiimit jakavat API-esimerkkejä, määrityskatkelmia, analytiikan hyötykuormia tai näytetietoja. Jos seuraava vaihe on laajempi strukturoidun tiedon puhdistaminen, yhdistä tämä artikkeli artikkeliin Kuinka muotoilla JSON ennen sovellusliittymäesimerkin jakamista ja JSON-/YAML-/TOML-muuntimeen.
Valitse poistomerkki määränpään perusteella
Yksinkertaisin sääntö on kohde ensin.
| Kohde | Käyttää | Miksi |
|---|---|---|
| URL-kyselyn arvo tai URL-komponentti | URL-koodaus | Estää tekstiä tulkitsemasta URL-syntaksia |
| Näkyvää tekstiä HTML:n sisällä | HTML pakenee | Estää erikoismerkkejä tulemasta merkintöjä |
| Merkkijonoarvo JSON:n sisällä | JSON pakenee | Pitää lainausmerkit, kauttaviivat ja rivinvaihdot jäsennettävissä |
| Julkinen artikkeli tai reitin otsikko | Slug sukupolvi | Luo luettavaa polkutekstiä sen sijaan, että säilyttäisi jokaisen merkin |
Muuntaminen auttaa, koska voit liittää kerran ja verrata lähtöjä avaamatta erillistä kooderia kullekin tapaukselle. Tämä pitää työn oikeasuhteisena. Et rakenna putkistoa; olet valmistelemassa yhtä tekstiarvoa paikkaan, johon sen täytyy mennä.
Avaa Case / Slug / Escape -työkalu, kun haluat päättää, onko seuraavan tulosteen oltava slug, URL-koodattu arvo, HTML-turvallinen teksti vai JSON-suojattu merkkijono.
