Minifikace JavaScriptu

Článek vyšel na serveru Zdroják.

Přiznám se, že cizí knihovny nepoužívám moc ochotně. Nejdřív strávím spoustu času hledáním té, která by mi vyhovovala. Pak často zjistím, že mi stejně něčím nevyhovuje. Když to opravím, pošlu změnu autorovi a on ji přijme, tak čekám na vydání nové verze. Když vyjde, tak musím otestovat, jestli se neporouchalo něco jiného. Cizí knihovny taky často mají závislosti (např. na Javě), které já vyžadovat nechci.

Často si proto radši něco spíchnu sám, protože s tím mám nakonec míň starostí, strávím tím míň času a dělám to, co mě baví mnohem víc, než hledat, zkoušet a domlouvat.

Když jsem hledal minifikátor JavaScriptu pro použití v Admineru, tak jsem se podíval na stávající řešení a vybral JSMin pro PHP. Ten mi v zásadě vyhovoval: neměl žádné závislosti, dělal skoro přesně to, co jsem chtěl, aktualizace probíhaly hladce. Navíc v podobný čas jako Adminer přešel ze SVN na Git, takže i provázání repozitářů bylo bez problémů.

Než…

Než se dobrá duše rozhodla Adminer zpřístupnit jako balík Debianu. JSMin má totiž celkem běžnou licenci, ale s nezvyklým dovětkem: “The Software shall be used for Good, not Evil.” A podle dogmatiků to není dost svobodné, protože chudáci zlořádi teď nemůžou využívat JSMin pro páchání zla. Dokonce by se projekty využívající JSMin neměly hostovat na Google Code.

Když by autor změnil slovo shall na should, tak by se všechno vyžehlilo, ten o tom ale nechce ani slyšet (a já se mu nedivím).

Takže jsem byl slušně požádán, jestli bych nemohl JSMin z Admineru vyhodit. A i když existují jiné kvalitní nástroje, především Google Closure Compiler, tak než to zase řešit, rozhodl jsem se jako obvykle, že si něco spíchnu sám.

JsShrink

Úlohu jsem vyřešil pomocí regulárního výrazu. Ten přeskakuje všechno, co má v JavaScriptu zvláštní význam (řetězce uzavřené do uvozovek nebo do apostrofů a regulární výrazy uzavřené do lomítek). Ze zbytku odstraňuje mezery a komentáře, případně je nahradí novým řádkem, pokud by došlo k nežádoucímu slepení, např. v kódu var a. Mimochodem nový řádek je mnohem důmyslnější než mezera, která se používá obvykle – zabírá shodně jeden bajt a nevytváří kilometr dlouhé řádky, takže se dá kód v nouzi i ladit a nepřekáží při prohledávání.

Nejsložitější jsou JavaScriptové regulární výrazy. Jejich oddělovač koliduje s operátorem dělení a se začátkem komentářů, takže je potřeba sledovat kontext, ve kterém se lomítko vyskytuje. Navíc ani neošetřené lomítko ještě regulární výraz nutně neukončuje: /[/]/ je platný regulární výraz.

<?php
/** Remove spaces and comments from JavaScript code
* @param string code with commands terminated by semicolon
* @return string shrinked code
* @link http://vrana.github.io/JsShrink/
* @author Jakub Vrana, http://www.vrana.cz/
* @copyright 2012 Jakub Vrana
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
* @license http://www.gnu.org/licenses/gpl-2.0.html GNU General Public License, version 2 (one or other)
*/
function jsShrink($input) {
    return preg_replace_callback('(
        (?:
            (^|[-+\([{}=,:;!%^&*|?~]|/(?![/*])|return|throw) # context before regexp
            (?:\s|//[^\n]*+\n|/\*(?:[^*]|\*(?!/))*+\*/)* # optional space
            (/(?![/*])(?:\\\\[^\n]|[^[\n/\\\\]|\[(?:\\\\[^\n]|[^]])++)+/) # regexp
            |(^
                |\'(?:\\\\.|[^\n\'\\\\])*\'
                |"(?:\\\\.|[^\n"\\\\])*"
                |([0-9A-Za-z_$]+)
                |([-+]+)
                |.
            )
        )(?:\s|//[^\n]*+\n|/\*(?:[^*]|\*(?!/))*+\*/)* # optional space
    )sx', 'jsShrinkCallback', "$input\n");
}

function jsShrinkCallback($match) {
    static $last = '';
    $match += array_fill(1, 5, null); // avoid E_NOTICE
    list(, $context, $regexp, $result, $word, $operator) = $match;
    if ($word != '') {
        $result = ($last == 'word' ? "\n" : ($last == 'return' ? " " : "")) . $result;
        $last = ($word == 'return' || $word == 'throw' || $word == 'break' ? 'return' : 'word');
    } elseif ($operator) {
        $result = ($last == $operator[0] ? "\n" : "") . $result;
        $last = $operator[0];
    } else {
        if ($regexp) {
            $result = $context . ($context == '/' ? "\n" : "") . $regexp;
        }
        $last = '';
    }
    return $result;
}
?>

Funkce vyžaduje příkazy ukončené středníkem, nespokojí se s jejich ukončením novým řádkem (to mimochodem nesplňují frameworky Dojo a Ext JS). Jinak by se měla vypořádat i s těmi největšími špeky. Např. JSMin nepodporuje platný výraz a++ + +2, zmiňuje to dokonce i v dokumentaci. Dojo ShrinkSafe si zase vyláme zuby na výrazu 8 / /.*/ / 2. Přijde vám výraz nesmyslný? Jistě, ale validní JavaScript to je. Navíc může vracet platný výsledek po následující definici:

RegExp.prototype.toString = function () {
	return 2;
};

ShrinkSafe si ostatně vyláme zuby i na zmíněném /[/]/ a a++ + +2 a chvalozpěv na domácí stránce o tom, jak je tento nástroj bezpečný, protože nepoužívá křehké regulární výrazy, mi přijde poněkud nemístný.

Implementace v JavaScriptu

Regulární výraz je tak jednoduchý (např. nepoužívá lookbehind aserce), že se dá převést i do JavaScriptu, takže si ho můžete vyzkoušet přímo ve svém prohlížeči.

Srovnání

O tom, proč JavaScript zkracovat, včetně popisu dostupných nástrojů vyšel dříve článek na Zdrojáku.

Z porovnávaných nástrojů vychází zdaleka nejlépe Google Closure Compiler. Dokáže správně zpracovat všechny vstupy a poskytuje velikostně nejlepší výsledky. Dokonce i ve whitespace only režimu si vede lépe než JsShrink, protože ve skutečnosti neodstraňuje jen bílé znaky, ale i zbytečné středníky, závorky a podobně.

JSMin a ShrinkSafe si se spoustou vstupů neporadily, jiné vstupy byly schopné dokonce i prodloužit (kvůli přidaným prázdným řádkám na začátek nebo konec souboru). Jedině u jQuery si ShrinkSafe vedl slušně, protože zkracuje i názvy proměnných. Po zagzipování se ale tato výhoda úplně ztratí a kód je opět větší než u JsShrink.

YUI Compressor si u jQuery díky agresivnější minimalizaci proměnných vede dobře, zákeřné vstupy ale zpracovat nedokáže.

Závěr

JsShrink se zaměřuje pouze na vypuštění mezer a komentářů, neprovádí zkrácení názvů proměnných, ani jiná kouzla. Dělá to ale svědomitě, snaží se nevyprodukovat jediný zbytečný bajt a zpracovat všechny platné vstupy. Používá se přes jednoduché API v PHP nebo JavaScriptu.

Jakub Vrána, Řešení problému, 12.3.2012, diskuse: 18 (nové: 0)

Diskuse

Diskuse je zrušena z důvodu spamu.

Navigace

PHP triky

• Archiv (704), English articles
• RSS, Atom, Atom diskusí
• O autorovi, o webu, Twitter

Kupte si mou knihu

Reklama

• Hledáte-li programátora nebo naopak sami programujete a nemáte do čeho píchnout, využijte služeb portálu nezávislých profesionálů Na volné noze.

Web běží na serveru

• Váš hosting

Články podle skupin

• Dobře míněné rady (111)
• Řešení problému (170)
• Výuka (100)
• Seznámení s oblastí (102)
• Ze zákulisí (69)
• Školení (31)
• Verze PHP (8)
• Osobní (46)
• Adminer (67)

Výběr článků

• Traverzování kolem stromu prakticky
• Vlastní pořadí řádků v tabulce
• Ukázka použití indexů
• Struktura stránek
• Unikátnost návštěvníka
• Vyhledávání v JavaScriptu
• Kontrola e-mailové adresy
• Vytvoření přátelského URL
• HTTP cachování
• Atomicita operací
• Vypnutí magic_quotes_gpc
• Ukládání souborů od uživatele
• Cross Site Scripting
• AJAX
• Přihlašování uživatelů
• MySQL 4.1 – kódování
• Vzájemné propojení souborů
• Diskuse s reakcemi
• Šablony
• HTTP metody GET a POST
• Escapování
• Ukládání hesel
• Využití unikátních klíčů v databázi
• Obrana proti SQL Injection

Nejnovější články

• Adminer 4.8.1
• Adminer 4.8.0
• Adminer 4.7.9
• Vypnutí chyby při přístupu k nedefinovanému prvku pole
• Users of Adminer 3.7.1 and older might have been hacked

Normy a manuály

• PHP
• MySQL
• HTTP
• Apache
• HTML, XHTML
• JavaScript

Další projekty

• Adminer
• NotORM
• JavaScript Syntax Highlighter
• php-initialized
• Čtyřka