JavaScript kodo formatavimo tikslas programuojant
Kuriant interneto svetaines ir taikomąsias programas, JavaScript kodas dažnai tampa sudėtingas ir sunkiai skaitomas. Kodo sutvarkymas (angl. beautification) yra procesas, kurio metu struktūrizuojamas neorganizuotas, suspaustas arba užmaskuotas kodas. Šio proceso metu kode iš naujo nustatomos įtraukos, pridedami tinkami tarpai ir suformuojamos naujos eilutės, kad programuotojai galėtų lengviau suprasti programos veikimo logiką.
Tvarkingas kodas yra būtinas atliekant kodo peržiūras, ieškant klaidų ar analizuojant trečiųjų šalių skriptus. Kai kodas yra aiškiai suformatuotas, programuotojams daug lengviau pastebėti sintaksės netikslumus, logines klaidas ir palaikyti bendrą projekto struktūrą.
JavaScript kodo suglaudinimas ir jo nauda svetainių našumui
Prieš pateikiant JavaScript failus į gamybinę aplinką (angl. production), juos rekomenduojama suglaudinti (angl. minification). Glaudinimo metu iš kodo pašalinami visi vykdymui nebūtini simboliai: tarpai, tabuliacijos žymės, naujų eilučių simboliai ir komentarai. Taip pat pašalinamas nenaudojamas, nepasiekiamas kodas (angl. dead code).
Šis procesas tiesiogiai prisideda prie svetainės krovimosi greičio optimizavimo. Mažesnis failo dydis užtikrina, kad vartotojo naršyklė greičiau atsisiųs reikiamus skriptus, o tai ypač aktualu mobiliojo ryšio naudotojams ir esant lėtam interneto ryšiui.
Kodo dydžio ir skaitomumo santykis
Programavimo procese nuolat susiduriama su kompromisu tarp kodo skaitomumo ir jo dydžio. Kurti ir prižiūrėti programą patogiausia tada, kai kodas yra išsamus, su aiškiais kintamųjų pavadinimais ir komentarais. Tačiau vartotojo naršyklei šie elementai nėra reikalingi – ji vienodai sėkmingai vykdo tiek tvarkingai suformatuotą, tiek visiškai suspaustą kodą.
Skirtumas tarp kodo sutvarkymo ir visiško jo atkūrimo (angl. unminifying) yra tas, kad joks įrankis negali sugrąžinti prarastų komentarų ar originalių kintamųjų pavadinimų, jei jie buvo pašalinti glaudinimo metu. Sutvarkymas tik sugrąžina vizualią struktūrą (įtraukas ir eilutes), kad kodą vėl būtų įmanoma perskaityti ir analizuoti.
Kintamųjų pavadinimų keitimas ir licencijų išsaugojimas
Glaudinant kodą, didelę įtaką galutiniam failo dydžiui turi vietinių kintamųjų pavadinimų tvarkymas. Įrankis siūlo dvi parinktis:
- Sutrumpinti: ši parinktis pakeičia vietinių kintamųjų pavadinimus į vieną raidę. Tai leidžia pasiekti mažiausią įmanomą failo dydį.
- Išsaugoti: ši parinktis palieka originalius kintamųjų pavadinimus nepakeistus. Failas lieka šiek tiek didesnis, tačiau jį lengviau derinti (angl. debug) ir suprasti.
Svarbu pažymėti, kad glaudinimo metu įrankis automatiškai išsaugo specialius licencijų blokus /*! … */. Tai užtikrina, kad autorinių teisių informacija ir naudojamos licencijos išliks kode net ir po visiško jo suspaudimo.
Įrankio naudojimas ir techniniai apribojimai
Norėdami apdoroti kodą, tiesiog įklijuokite arba įrašykite jį į įvesties lauką. Įrankis palaiko įvestį iki 3 000 000 simbolių. Pasirinkę norimus nustatymus, galite spausti „Sutvarkyti“ arba „Suglaudinti“.
Apdorotas kodas pateikiamas specialiame tik skaitymui skirtame redaktoriuje, kurį galima nukopijuoti arba atsisiųsti kaip failą. Šalia rezultato pateikiami šie statistiniai rodikliai:
- Eilutės: išvesties kodo eilučių skaičius.
- Simboliai: bendras simbolių skaičius išvestyje.
- Dydis: galutinio kodo dydis UTF-8 baitais.
Jei įvestis yra tuščia, įrankis lieka parengties būsenoje. Paspaudus mygtuką „Išvalyti“, pašalinama tiek įvestis, tiek išvestis bei išvalomas išsaugotas juodraštis. Sėkmingai suglaudinus kodą, sistema parodo pranešimą su procentiniu dydžio sumažėjimu, pavyzdžiui, „Suglaudinta – {pct}% mažesnis failas.“.
Apdorojimo metu gali kilti šios klaidos:
- Jei failas viršija leistiną dydį, rodoma klaida: „Šis failas yra per didelis apdorojimui. Bandykite su mažesniu failu.“.
- Jei procesas trunka ilgiau nei 20 sekundžių, darbas sustabdomas ir pateikiama klaida: „Apdorojimas užtruko per ilgai ir buvo sustabdytas – bandykite su mažesniu failu.“.
- Jei kode yra sintaksės klaidų, dėl kurių apdorojimas neįmanomas, rodomas pranešimas: „Nepavyko apdoroti šio JavaScript kodo.“.
- Jei po glaudinimo nelieka jokio veikiančio kodo, sistema informuoja: „Po suglaudinimo nieko neliko – įvesties kode nebuvo jokio vykdomo kodo.“.
Privatumas ir duomenų apdorojimas
Naudojantis šiuo įrankiu, jūsų įvestas JavaScript kodas yra formatuojamas ir glaudinamas tiesiog jūsų interneto naršyklėje. Jokie jūsų įvesti duomenys ar kodo fragmentai nėra siunčiami į „BroBroGo“ serverius, todėl apdorojimo procesas vyksta lokaliai jūsų įrenginyje.
Dažniausiai užduodami klausimai (DUK)
Kuo skiriasi kodo sutvarkymas (beautify) ir suglaudinimas (minify)?
Sutvarkymo („Beautify“) funkcija iš naujo nustato įtraukas ir tarpus kode, kad jį būtų lengva skaityti ir analizuoti – tai greičiausias būdas suprasti suglaudintą ar užmaskuotą (obfuskuotą) failą. Suglaudinimas („Minify“) daro priešingai: pašalina tarpus, komentarus ir nenaudojamą kodą, kad failas būtų atsisiunčiamas greičiau. Tvarkykite skaitymui, glaudinkite gamybiniam naudojimui.
Ar galima suglaudintą kodą paversti pradiniu?
Ji atkuria įtraukas ir eilučių lūžius, kad logika vėl būtų suprantama, tačiau negali sugrąžinti originalių kintamųjų pavadinimų ar komentarų – suglaudinimo metu jie prarandami visam laikui, todėl joks įrankis negali jų atkurti. Jūs gausite tą patį kodą, tik išdėstytą aiškiai.
Ką daro kintamųjų pavadinimų parinktys „Shorten“ ir „Keep“?
Abi parinktys pašalina tarpus, komentarus bei nepasiekiamą kodą ir nei viena nekeičia jūsų skripto veikimo. Sutrumpinimo parinktis („Shorten“) taip pat pervadina vietinius kintamuosius į vieną raidę, kad failas būtų kuo mažesnis – būtent tokį pateiktumėte gamybiniam naudojimui. Išsaugojimo parinktis („Keep“) palieka jūsų kintamųjų pavadinimus nepakeistus, todėl rezultatas yra šiek tiek didesnis, bet vis tiek skaitomas ir lengvai derinamas (debug).
Ar glaudinimo metu pašalinamos autorinės teisės ir licencijos?
Įprasti komentarai glaudinimo metu yra pašalinami, tačiau įrankis automatiškai išsaugo specialius /*! … */ formato komentarus, kuriuose dažniausiai pateikiama informacija apie licencijas ir autorines teises.