Formázd, validáld és minifikáld a JSON-t közvetlenül a böngésződben
A JSON, azaz JavaScript Object Notation a modern web közös nyelve. Szinte minden REST API, amit meghívsz, ezt adja vissza, a legtöbb konfigurációs fájl is erre épül, és a szolgáltatások, illetve a frontendek között áramló adatok jelentős része JSON formátumban van szerializálva. Nem véletlenül ilyen népszerű: a formátum egyszerű, nyelvfüggetlen, és pontosan illeszkedik azokhoz az objektumokhoz, tömbökhöz, karakterláncokhoz és számokhoz, amelyekben a programozók amúgy is gondolkodnak. Ennek a tömörségnek azonban van egy hátulütője. Amint egy szerver egyetlen sorba zsúfolt, több száz beágyazott kulcsot tartalmazó választ küld, az a struktúra, ami a JSON-t vonzóvá teszi, egy áttekinthetetlen karaktertömegbe vész.
A speedor.net JSON formázó ezt a struktúrát adja vissza. Illeszd be az adatot, és az eszköz azonnal formázza, validálja és minifikálja a JSON-t, teljes egészében a böngésződ lapján belül. Semmi nem kerül fel szerverre, ami különösen fontos, ha az általad vizsgált adat egy tokeneket, ügyféladatokat vagy belső azonosítókat tartalmazó API-válasz.
Miért teszi újra olvashatóvá a behúzás a JSON-t
A formázás, más néven szépítés vagy pretty-printelés, a tömör vagy minifikált JSON-t sortörésekkel és következetes behúzással látja el. Az információ változatlan marad, csak a szóközök módosulnak. Ez a fehér tér mégis az, ami lehetővé teszi, hogy a szemed kövesse a beágyazási mélységet, észrevedd, hol ér véget egy objektum és hol kezdődik a következő, és megkülönböztesd a háromelemű tömböt a háromszázelemtől. Amikor éjjel kettőkor egy integrációt debuggolsz, az olvasható fa és a megszakítás nélküli karakterlánc közti különbség dönti el, hogy megtalálod-e a hibát, vagy elsiklasz felette.
Egy jó formázó a kulcsok sorrendjét és a pontos értékeket is érintetlenül hagyja, így amit olvasol, az valóban az, amit az API elküldött. Nem egy újrarendezett közelítést látsz, hanem ugyanazokat a byte-okat, csak úgy elrendezve, hogy egy ember is olyan könnyen értelmezze, mint egy gép.
Validálás és a leggyakoribb hibák
A szépítés csak a munka fele. Mielőtt a JSON egyáltalán formázható lenne, érvényesnek kell lennie, és a formátum szigorú szabályai sokkal több hibát fognak ki, mint amire az emberek számítanak. Egy validátor feldolgozza a beírt szöveget, és pontosan megmondja, hol törik meg, jellemzően sorra és pozícióra mutatva, hogy ne kelljen vakon keresgélned. Az alábbi néhány hiba adja a hibás JSON-ok túlnyomó többségét:
- Záró vessző. A JSON tiltja a vesszőt egy objektum vagy tömb utolsó eleme után. A JavaScript ezt megtűri, éppen ezért szokásból sokan beillesztik.
- Egyszeres idézőjel. A karakterláncoknak és kulcsoknak dupla idézőjelet kell használniuk. Ha egy objektum-literált egyenesen a forráskódból emelsz ki, gyakran egyszeres idézőjelek maradnak benne, és a parser elutasítja.
- Idézőjel nélküli kulcsok. Minden kulcsnak idézőjelbe tett karakterláncnak kell lennie. A puszta kulcsok, amelyek egy JavaScript objektumban jól működnek, érvénytelen JSON-t eredményeznek.
- Hiányzó vagy nem illeszkedő zárójelek. Egy le nem zárt
{vagy[, vagy egy elárvult záró zárójel, az egész dokumentumot kisiklatja. A formázó megmutatja, hol borul fel az egyensúly. - Megjegyzések és undefined értékek. A JSON-ban nincsenek megjegyzések és nincs
undefined; csaknull, logikai értékek, számok, karakterláncok, tömbök és objektumok engedélyezettek.
Futtass át egy gyanús adatot előbb a validátoron, és ezek a problémák másodpercek alatt felszínre kerülnek, nem pedig egy zavaros, sikertelen deployok sorozata után.
Minifikálás a kisebb adatméretért
Az ellentétes művelet éppen olyan hasznos. A minifikálás eltávolít minden opcionális szóközt, és a JSON-t a lehető legszűkebb, egysoros formára húzza össze. Pontosan erre van szükség, amikor az adat hálózaton utazik vagy egy konfigurációs értékbe kerül, mert a kisebb adatméret kevesebb sávszélességet és gyorsabb átvitelt jelent. Gyakori munkafolyamat, hogy a választ tanulmányozás közben szépen formázod, kijavítod, ami hibás, majd az eredményt minifikálod, mielőtt commitolnád vagy egy környezeti változóba illesztenéd. Egyetlen eszköz kezeli ennek a ciklusnak mindkét végét.
A helyi feldolgozás megőrzi az érzékeny adatok bizalmasságát
Mivel minden lépés a saját böngésződben, JavaScriptben fut, a beillesztett JSON soha nem hagyja el a gépedet. Ez nem csupán marketingfogás, hanem gyakorlati garancia. Bátran beilleszthetsz egy nyers API-választ, amely bearer tokeneket tartalmaz, egy felhasználói adatexportot, vagy egy belső szolgáltatás konfigurációját, anélkül hogy attól kellene tartanod, hogy egy harmadik féltől származó szerver naplózza azt. Zárd be a lapot, és az adat eltűnik. Mindenki számára, aki adatkezelési szabályok alatt dolgozik, a kizárólag helyi feldolgozás egy egész kockázati kategóriát szüntet meg.
Ha a JSON-od már tiszta, érdemes tovább is lépned. Fedezd fel a többi fejlesztői eszközünket, alakíts át egy struktúrát a JSON to YAML eszközzel, vagy fejts vissza egy beágyazott értéket a Base64 segítségével. Minden eszközünk ugyanazt az elvet követi: gyors, ingyenes, és teljes egészében a böngésződben fut le.
Gyakran ismételt kérdések
Felkerül a JSON-om egy szerverre?
Nem. A formázó teljes egészében a böngésződben fut JavaScript segítségével. Az adataid soha nem kerülnek elküldésre, így nyugodtan beillesztheted az érzékeny API-válaszokat vagy konfigurációs fájlokat.
Mi a különbség a formázás és a minifikálás között?
A formázás behúzást és sortöréseket ad hozzá, hogy a JSON olvasható legyen. A minifikálás eltávolít minden opcionális szóközt, hogy az adat a lehető legkisebb méretű legyen. Az adat maga mindkét formában azonos.
Miért nem validálódik a JSON-om?
A leggyakoribb okok a záró vesszők, az egyszeres idézőjel a dupla helyett, az idézőjel nélküli kulcsok, a megjegyzések, valamint a hiányzó vagy nem illeszkedő zárójelek. A validátor megmutatja, melyik sorban van a probléma.
Használhatok egyszeres idézőjelet a JSON-ban?
Nem. A JSON specifikáció dupla idézőjelet ír elő minden karakterlánchoz és kulcshoz. Az egyszeres idézőjel a JavaScriptben érvényes, de a JSON-ban nem, ami gyakori hibaforrás.
Megváltoztatja az eszköz az adataimat formázás közben?
Nem. A formázás csak szóközöket ad hozzá vagy távolít el. A kulcsok, az értékek és azok sorrendje pontosan olyan marad, amilyen volt, így amit olvasol, az valóban az, amit az API küldött.
Van méretkorlát?
Mivel a feldolgozás helyben történik, a gyakorlati korlátot inkább az eszközöd és a böngésződ szabja meg, nem egy szerveroldali plafon. A tipikus API-válaszok és konfigurációs fájlok azonnal formázódnak.