Escaping je lako pogrešno upotrijebiti jer nekoliko različitih poslova iz daljine izgleda slično. Imate tekst, tekst sadrži posebne znakove, a drugi sistem ga treba primiti bez pogrešnog tumačenja. Greška je pretpostaviti da jedna vrsta escapinga radi svugdje.
URL enkodiranje, HTML escape i JSON escape rješavaju različite probleme. Razmak u query stringu nije isti problem kao znak < u renderovanom HTML-u ili navodnik unutar JSON stringa. Alat Case / Slug / Escape pomaže tako što te izlaze drži blizu, ali korisni dio je znati koji izlaz pripada odredištu koje pripremate.
URL enkodiranje je za URL-ove i query vrijednosti
Koristite URL enkodiranje kada tekst ide u URL komponentu, posebno u query parametar ili vrijednost koja može sadržavati razmake, interpunkciju ili znakove koji nisu sigurni za putanju.
Recimo da support link treba uključiti pojam pretrage kao pricing & billing. Direktno lijepljenje te fraze u URL može promijeniti način na koji se URL tumači jer & već ima značenje u query stringu. URL enkodiranje pretvara tekst u oblik koji može putovati kroz URL bez miješanja sa URL sintaksom.
To nije isto što i kreiranje sluga. Slug obično pretvara naslov u čitljiv segment putanje kao pricing-and-billing. URL enkodiranje direktnije čuva izvornu vrijednost za transport.
HTML escape je za tekst koji će se renderovati u HTML-u
Koristite HTML escape kada tekst treba da se pojavi kao tekst u HTML kontekstu, a ne da postane markup.
Ako primjer koda uključuje <button> i želite da čitaoci vide te znakove, browser treba escaped znakove. U suprotnom ih može protumačiti kao stvarni element. HTML escape sprečava da se tekst čita kao HTML sintaksa na mjestima gdje sadržaj treba ostati vidljiv tekst.
To je važno u dokumentaciji, CMS poljima, changelogovima i product copyju. Posebno je relevantno kada izvorni tekst uključuje primjere markupa, snippete ili korisnički generisane vrijednosti koje ne trebaju postati dio strukture stranice.
JSON escape je za string vrijednosti unutar JSON-a
Koristite JSON escape kada tekst treba sigurno stajati unutar JSON stringa.
Navodnik je bezopasan u običnoj prozi, ali u JSON stringu može prerano zatvoriti string. Novi red također može trebati reprezentaciju koja JSON drži validnim. JSON escape čuva vrijednost dok okolni JSON ostaje parseable.
To se često pojavljuje kada timovi dijele API primjere, config snippete, analytics payloade ili sample data. Ako je sljedeći korak šire čišćenje strukturiranih podataka, uparite ovaj članak s Kako formatirati JSON prije dijeljenja API primjera i JSON / YAML / TOML konverterom.
Birajte escaping prema odredištu
Najjednostavnije pravilo je: prvo odredište.
| Odredište | Koristite | Zašto |
|---|---|---|
| URL query vrijednost ili URL komponenta | URL enkodiranje | Sprečava da se tekst tumači kao URL sintaksa |
| Vidljiv tekst unutar HTML-a | HTML escape | Sprečava da posebni znakovi postanu markup |
| String vrijednost unutar JSON-a | JSON escape | Drži navodnike, slash znakove i prelome redova parseable |
| Javni naslov članka ili rute | Generisanje sluga | Kreira čitljiv tekst putanje umjesto čuvanja svakog znaka |
Converty pomaže jer možete zalijepiti jednom i uporediti izlaze bez otvaranja posebnog enkodera za svaki slučaj. Posao ostaje proporcionalan. Ne gradite pipeline; pripremate jednu tekstualnu vrijednost za mjesto na koje treba ići.
Otvorite alat Case / Slug / Escape kada trebate odlučiti da li sljedeći izlaz treba biti slug, URL-enkodirana vrijednost, HTML-safe tekst ili JSON-safe string.
