Hutool: pouzdan alatni paket koji čini Javu slađom

Chenmo Wang Er2571 reči9 minuta

Jedan drug iz čitalačke grupe je uzdahnuo: „Ova open-source biblioteka Hutool je neverovatna, sadrži u osnovi svaku alatku koja bi vam mogla zatrebati.“ Iskreno, i ja u svakodnevnom radu često koristim Hutool, zaista može da nam pojednostavi svaki red koda, da Javi podari eleganciju funkcionalnih jezika i učini Java jezik „slatkim“.

Autor Hutool-a kaže na zvaničnom sajtu da je Hutool složenica Hu+tool (kao da i nije morao da nam kaže, i sami bismo pogodili), „Hu“ je posveta njegovoj „bivšoj“ kompaniji, „tool“ znači alat, a zvučna asocijacija je zanimljiva — na kineskom zvuči kao „hutu“ (zatupljen), što simbolizuje težnju ka tome da se na sve stvari gleda „ošamućenim okom, bez brige o gubitku ni dobitku“ (open-source biblioteka koja se uzdigla na filozofski nivo, autor je zaista moćan).

Pogledao sam jedan opis člana razvojnog tima — autor Java bekend alatke voli frontend, voli digitalne uređaje i voli lepe žene, hmm, zaista „retko je biti zatupljen“ (uz osmeh).

Dosta priče, ajmo u praksu!

01. Uvođenje Hutool-a

Za Maven projekat dovoljno je dodati sledeću zavisnost u pom.xml fajl.

<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-all</artifactId>
    <version>5.4.3</version>
</dependency>

Dizajnerska ideja Hutool-a je da svede na minimum ponavljajuće definicije i da util paket u projektu ostane što manji. Dobar točak u velikoj meri može da izbegne „kopiraj-nalepi“, čime se nama programerima štedi vreme za obmotavanje javnih klasa i javnih alatnih metoda u projektu. Istovremeno, zrela open-source biblioteka u najvećoj meri izbegava bagove koji potiču od nepotpog obmotavanja.

Kao što autor kaže na zvaničnom sajtu:

Ranije smo otvarali pretraživač -> tražili „Java MD5 enkripcija“ -> otvarali neki blog -> kopirali-nalepili -> doterivali da bude upotrebljivije
Sa Hutool-om, uvezemo Hutool -> direktno SecureUtil.md5()

Hutool ne da je obmotao samo niskouporavne fajlove, tokove, enkripciju/dekripciju, prekodiranje, regularne izraze, niti i XML iz JDK-a, već pruža i sledeće komponente:

Ima ih mnogo i veoma su sveobuhvatni, zbog toga ću izabrati samo neke koje mi se sviđaju da predstavim (potajno ti kažem, jednostavno želim da se olakšam).

02. Konverzija tipova

Konverzija tipova je u Java razvoju veoma česta, posebno pri dohvatanju parametara iz HttpRequest-a — frontend prosledi ceo broj, ali na bekendu prvo dobijamo string, pa moramo da pozovemo parseXXX() metodu za konverziju, uz dodatak provere na null, prilično je zamorno.

Hutool-ova klasa Convert može da pojednostavi ovu operaciju — pretvara bilo koji mogući tip u zadati tip, dok drugi parametar defaultValue može da vrati podrazumevanu vrednost kada konverzija ne uspe.

String param = "10";
int paramInt = Convert.toInt(param);
int paramIntDefault = Convert.toInt(param, 0);

Pretvaranje stringa u datum:

String dateStr = "2020-09-29";
Date date = Convert.toDate(dateStr);

Pretvaranje stringa u Unicode:

String unicodeStr = "Chenmo Wang Er";
String unicode = Convert.strToUnicode(unicodeStr);

03. Datum i vreme

Date i Calendar koje donosi JDK nisu baš zgodni, Hutool-ov DateUtil je mnogo ugodniji za korišćenje!

Dohvatanje trenutnog datuma:

Date date = DateUtil.date();

DateUtil.date() zapravo vraća DateTime, koji nasleđuje Date objekat i prepisuje toString() metodu, vraćajući string u formatu yyyy-MM-dd HH:mm:ss.

Zanima li neke od vas u koje vreme pišem ovaj članak, evo ispisa za sve vas:

System.out.println(date);// 2020-09-29 04:28:02

String u datum:

String dateStr = "2020-09-29";
Date date = DateUtil.parse(dateStr);

DateUtil.parse() automatski prepoznaje neke uobičajene formate, na primer:

yyyy-MM-dd HH:mm:ss
yyyy-MM-dd
HH:mm:ss
yyyy-MM-dd HH:mm
yyyy-MM-dd HH:mm:ss.SSS

Takođe prepoznaje one sa kineskim znakovima:

godina-mesec-dan-čas-minut-sekunda

Formatiranje razlike u vremenu:

String dateStr1 = "2020-09-29 22:33:23";
Date date1 = DateUtil.parse(dateStr1);

String dateStr2 = "2020-10-01 23:34:27";
Date date2 = DateUtil.parse(dateStr2);

long betweenDay = DateUtil.between(date1, date2, DateUnit.MS);

// izlaz: 2 dana 1 čas 1 minut 4 sekunde
String formatBetween = DateUtil.formatBetween(betweenDay, BetweenFormater.Level.SECOND);

Zodijak i kineski horoskop:

// Strelac
String zodiac = DateUtil.getZodiac(Month.DECEMBER.getValue(), 10);
// Zmija
String chineseZodiac = DateUtil.getChineseZodiac(1989);

04. IO tokovi

IO operacije obuhvataju čitanje i pisanje, primena uglavnom obuhvata mrežne i fajl operacije, izvorna Java biblioteka razlikuje tokove znakova i tokove bajtova, a tokova bajtova InputStream i OutputStream ima jako puno vrsta, korišćenje im ide na nerve.

Hutool je obmotao alatku za operacije nad tokovima IoUtil, alatku za čitanje i pisanje fajlova FileUtil, alatku za određivanje tipa fajla FileTypeUtil i tako dalje.

BufferedInputStream in = FileUtil.getInputStream("hutool/origin.txt");
BufferedOutputStream out = FileUtil.getOutputStream("hutool/to.txt");
long copySize = IoUtil.copy(in, out, IoUtil.DEFAULT_BUFFER_SIZE);

U IO operacijama, operacije nad fajlovima su relativno složene, ali se često koriste, gotovo svaki projekt ima alatku koja se zove FileUtil ili FileUtils. Hutool-ova klasa FileUtil sadrži sledeće kategorije operacija:

Operacije nad fajlovima: uključuju kreiranje, brisanje, kopiranje, premeštanje i preimenovanje fajlova i direktorijuma
Provere fajlova: provera da li su fajl ili direktorijum neprazni, da li je direktorijum, da li je fajl itd.
Apsolutne putanje: pretvaranje fajlova iz ClassPath u apsolutne putanje
Imena fajlova: dohvatanje glavnog imena i ekstenzije
Operacije čitanja: uključuju getReader, readXXX
Operacije pisanja: uključuju getWriter, writeXXX

Da uzgred kažem ponešto i o classpath-u.

U stvarnom kodiranju, često nam treba da iz nekih fajlova pročitamo određene podatke, kao što su konfiguracioni fajlovi, tekstualni fajlovi, slike i sl., gde se ti fajlovi obično nalaze?

Stavljaju se u resources direktorijum iz strukture projekta, a nakon kompilacije projekta pojavljuju se u classes direktorijumu. Odgovarajući direktorijum na disku prikazan je na sledećoj slici:

Kada želimo da čitamo fajlove, ne preporučujem korišćenje apsolutnih putanja, jer ako se operativni sistem razlikuje, razlikuje se i separator putanje. Najbolje je koristiti relativne putanje.

Pretpostavimo da je u src/resources stavljen fajl origin.txt, parametar putanje fajla izgleda ovako:

FileUtil.getInputStream("origin.txt")

Ako je fajl u src/resources/hutool direktorijumu, parametar putanje se menja u:

FileUtil.getInputStream("hutool/origin.txt")

05. Alatka za stringove

Hutool-ova alatka za stringove StrUtil je slična sa StringUtils iz Apache Commons Lang paketa, autor smatra da je prednost u tome što je Str kraće od String, mada se ja ne bih složio. Ipak, prilično mi se dopada jedna metoda u njoj:

String template = "{} je programer koji ćuti ali je zanimljiv; ako ti se sviđaju njegovi članci, pretraži {}";
String str = StrUtil.format(template, "Chenmo Wang Er", "Chenmo Wang Er");
// Chenmo Wang Er je programer koji ćuti ali je zanimljiv; ako ti se sviđaju njegovi članci, pretraži Chenmo Wang Er

06. Alatka za refleksiju

Mehanizam refleksije može da učini Javu fleksibilnijom, pa u nekim situacijama refleksija može da postigne dvostruki rezultat sa polovinom truda. Hutool-ova alatka za refleksiju ReflectUtil obuhvata:

Dohvatanje konstruktora
Dohvatanje polja
Dohvatanje vrednosti polja
Dohvatanje metoda
Izvršavanje metoda (metode instance i statičke metode)

package com.itwanger.hutool.reflect;

import cn.hutool.core.util.ReflectUtil;

import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.Method;

public class ReflectDemo {
    private int id;

    public ReflectDemo() {
        System.out.println("konstruktor");
    }

    public void print() {
        System.out.println("Ja sam Chenmo Wang Er");
    }

    public static void main(String[] args) throws IllegalAccessException {
        // izgradnja objekta
        ReflectDemo reflectDemo = ReflectUtil.newInstance(ReflectDemo.class);

        // dohvatanje konstruktora
        Constructor[] constructors = ReflectUtil.getConstructors(ReflectDemo.class);
        for (Constructor constructor : constructors) {
            System.out.println(constructor.getName());
        }

        // dohvatanje polja
        Field field = ReflectUtil.getField(ReflectDemo.class, "id");
        field.setInt(reflectDemo, 10);
        // dohvatanje vrednosti polja
        System.out.println(ReflectUtil.getFieldValue(reflectDemo, field));

        // dohvatanje svih metoda
        Method[] methods = ReflectUtil.getMethods(ReflectDemo.class);
        for (Method m : methods) {
            System.out.println(m.getName());
        }

        // dohvatanje zadatog metoda
        Method method = ReflectUtil.getMethod(ReflectDemo.class, "print");
        System.out.println(method.getName());

        // izvršavanje metoda
        ReflectUtil.invoke(reflectDemo, "print");
    }
}

07. Alatka za kompresiju

U Javi, pakovanje i kompresovanje fajlova i direktorijuma je prilično zamoran posao, Hutool-ov ZipUtil optimizuje java.util.zip paket tako da jednom metodom možete da rešite i kompresiju i dekompresiju, automatski obrađuje pitanja fajlova i direktorijuma, tako da korisnik više ne mora da proverava, što znatno pojednostavljuje složenost kompresije i dekompresije.

ZipUtil.zip("hutool", "hutool.zip");
File unzip = ZipUtil.unzip("hutool.zip", "hutoolzip");

08. Alatka za identifikacione dokumente

Hutool-ov IdcardUtil se može koristiti za proveru identifikacionih dokumenata, podržava kineske lične karte od 15 i 18 cifara za kopno, kao i 10-cifrene karte za Hongkong, Makao i Tajvan.

String ID_18 = "321083197812162119";
String ID_15 = "150102880730303";

boolean valid = IdcardUtil.isValidCard(ID_18);
boolean valid15 = IdcardUtil.isValidCard(ID_15);

09. Proširenje HashMap-e

HashMap u Javi je strogo tipiziran, dok Hutool-ov Dict nema tako stroge zahteve za tip ključa.

Dict dict = Dict.create()
        .set("age", 18)
        .set("name", "Chenmo Wang Er")
        .set("birthday", DateTime.now());

int age = dict.getInt("age");
String name = dict.getStr("name");

10. Ispis na konzolu

Tokom lokalnog kodiranja, često nam treba System.out za ispis rezultata, ali neki složeni objekti ne podržavaju direktni ispis, na primer nizovi — moramo da pozovemo Arrays.toString. Hutool-ova klasa Console pozajmljuje console.log() iz JavaScript-a, čineći ispis veoma zgodnim.

public class ConsoleDemo {
    public static void main(String[] args) {
        // ispis stringa
        Console.log("Chenmo Wang Er, jedan zanimljiv programer");

        // ispis po šablonu
        Console.log("Luoyang je drevna prestonica {} dinastija",13);

        int [] ints = {1,2,3,4};
        // ispis niza
        Console.log(ints);
    }
}

11. Validator polja

Prilikom Web razvoja, bekend obično mora da proveri podatke prosleđene iz forme. Hutool-ov Validator može da sprovede mnogo korisnih uslovnih provera:

da li je imejl
da li je IPv4 ili IPv6
da li je telefonski broj
itd.

Validator.isEmail("Chenmo Wang Er");
Validator.isMobile("itwanger.com");

12. Mapa sa dvosmernom pretragom

Guava pruža posebnu Map strukturu koja se zove BiMap, koja ostvaruje dvosmernu pretragu — možemo naći vrednost po ključu, a i ključ po vrednosti, Hutool takođe pruža ovakvu Map strukturu.

BiMap<String, String> biMap = new BiMap<>(new HashMap<>());
biMap.put("wanger", "Chenmo Wang Er");
biMap.put("wangsan", "Chenmo Wang San");

// get value by key
biMap.get("wanger");
biMap.get("wangsan");

// get key by value
biMap.getKey("Chenmo Wang Er");
biMap.getKey("Chenmo Wang San");

U stvarnom razvojnom radu, ja više volim Guava-in BiMap nego Hutool-ov. Pominjem ga ovde uglavnom zato što sam otkrio jednu grešku u Hutool-ovoj onlajn dokumentaciji i podneo issue (odavde se može videti moje savesno srce i moje bistre, svetle oči).

13. Alatka za slike

Hutool-ov ImgUtil može da vrši operacije skaliranja, sečenja, pretvaranja u crno-belo, dodavanja vodenog žiga itd. nad slikama.

Skaliranje slike:

ImgUtil.scale(
        FileUtil.file("hutool/wangsan.jpg"),
        FileUtil.file("hutool/wangsan_small.jpg"),
        0.5f
);

Sečenje slike:

ImgUtil.cut(
        FileUtil.file("hutool/wangsan.jpg"),
        FileUtil.file("hutool/wangsan_cut.jpg"),
        new Rectangle(200, 200, 100, 100)
);

Dodavanje vodenog žiga:

ImgUtil.pressText(//
        FileUtil.file("hutool/wangsan.jpg"),
        FileUtil.file("hutool/wangsan_logo.jpg"),
        "Chenmo Wang Er", Color.WHITE,
        new Font("SimHei", Font.BOLD, 100),
        0,
        0,
        0.8f
);

Iskoristimo priliku da svi uživamo u Ergovom zgodnom liku.

14. Konfiguracioni fajl

Kao što je svima poznato, Properties konfiguracioni fajl koji se široko koristi u Javi ima jednu veliku zamerku: ne podržava kineske znakove. Pri svakom korišćenju, ako želimo da uskladištimo kineske znakove, moramo se osloniti na odgovarajući IDE dodatak da ih pretvori u Unicode simbole, a takvi neljudski simboli se iz komandne linije uopšte ne daju pročitati.

Zato je nastao Hutool-ov Setting. Setting pored toga što je kompatibilan sa Properties formatom fajla, pruža i neke posebne funkcije, koje uključuju:

Podrška za različita kodiranja
Podrška za promenljive
Podrška za grupisanje

Prvo napravimo konfiguracioni fajl example.setting, sa sledećim sadržajem:

name=Chenmo Wang Er
age=18

Zatim da čitamo i ažuriramo konfiguracioni fajl:

public class SettingDemo {
    private final static String SETTING = "hutool/example.setting";
    public static void main(String[] args) {
        // inicijalizacija Setting
        Setting setting = new Setting(SETTING);

        // čitanje
        setting.getStr("name", "Chenmo Wang Er");

        // automatsko učitavanje pri promeni fajla
        setting.autoLoad(true);

        // dodavanje para ključ-vrednost iz koda
        setting.set("birthday", "2020-09-29");
        setting.store(SETTING);
    }
}

15. Fabrika logova

Hutool-ova fabrika logova LogFactory kompatibilna je sa svim većim loger frejmvorcima, i veoma je jednostavna za korišćenje.

public class LogDemo {
    private static final Log log = LogFactory.get();

    public static void main(String[] args) {
        log.debug("retko je biti zatupljen");
    }
}

Prvo preko LogFactory.get() automatski prepoznajemo uvezeni loger frejmvork, čime se kreira odgovarajući Log objekat (fasada) za taj frejmvork, a zatim pozivamo debug(), info() i druge metode da bismo ispisali logove.

Ako ne želite da kreirate Log objekat, možete koristiti StaticLog — kako ime kaže, to je loger klasa koja pruža statičke metode.

StaticLog.info("Sjajno {}.", "članci Chenmo Wang Er-a");

16. Alatka za keširanje

CacheUtil je Hutool-ova alatka za brzo kreiranje keša, može da kreira različite keš objekte:

FIFOCache: prvi ušao-prvi izašao, elementi se neprestano dodaju u keš dok se keš ne napuni, a kada je pun, čiste se istekli objekti, a ako je i nakon čišćenja i dalje pun, briše se onaj koji je prvi ušao.

Cache<String, String> fifoCache = CacheUtil.newFIFOCache(3);
fifoCache.put("key1", "Chenmo Wang Yi");
fifoCache.put("key2", "Chenmo Wang Er");
fifoCache.put("key3", "Chenmo Wang San");
fifoCache.put("key4", "Chenmo Wang Si");

// veličina je 3, tako da se nakon dodavanja key4 briše key1
String value1 = fifoCache.get("key1");

LFUCache, najređe korišćen — na osnovu broja korišćenja se ocenjuje da li objekat ostaje u kešu; kada se keš napuni, čiste se istekli objekti, a ako je i nakon čišćenja i dalje pun, briše se najređe pristupani objekat i ostalim objektima se od broja pristupanja oduzima ovaj najmanji broj, kako bi novi objekat nakon ulaska mogao pošteno da broji.

Cache<String, String> lfuCache = CacheUtil.newLFUCache(3);

lfuCache.put("key1", "Chenmo Wang Yi");
// broj korišćenja +1
lfuCache.get("key1");
lfuCache.put("key2", "Chenmo Wang Er");
lfuCache.put("key3", "Chenmo Wang San");
lfuCache.put("key4", "Chenmo Wang Si");

// pošto keš ima kapacitet samo 3, kada se doda 4. element, najređe korišćeni će biti uklonjeni (2 i 3 su uklonjeni)
String value2 = lfuCache.get("key2");
String value3 = lfuCache.get("key3");

LRUCache, najdavnije nekorišćeni — na osnovu vremena korišćenja se ocenjuje da li objekat ostaje u kešu; kada se objektu pristupi, stavlja se u keš, a kada se keš napuni, biće uklonjen onaj objekat koji najdavnije nije korišćen.

Cache<String, String> lruCache = CacheUtil.newLRUCache(3);

lruCache.put("key1", "Chenmo Wang Yi");
lruCache.put("key2", "Chenmo Wang Er");
lruCache.put("key3", "Chenmo Wang San");
// vreme korišćenja je svežije
lruCache.get("key1");
lruCache.put("key4", "Chenmo Wang Si");

// pošto keš ima kapacitet samo 3, kada se doda 4. element, najdavnije korišćeni će biti uklonjen (2)
String value2 = lruCache.get("key2");
System.out.println(value2);

17. Enkripcija i dekripcija

Enkripcija se deli na tri vrste:

Simetrična enkripcija (symmetric), na primer: AES, DES itd.
Asimetrična enkripcija (asymmetric), na primer: RSA, DSA itd.
Enkripcija sažetka (digest), na primer: MD5, SHA-1, SHA-256, HMAC itd.

Hutool je obmotao sva tri slučaja:

Simetrična enkripcija SymmetricCrypto
Asimetrična enkripcija AsymmetricCrypto
Enkripcija sažetka Digester

Alatka za brzu enkripciju SecureUtil ima sledeće metode:

Simetrična enkripcija

SecureUtil.aes
SecureUtil.des

Asimetrična enkripcija

SecureUtil.rsa
SecureUtil.dsa

Enkripcija sažetka

SecureUtil.md5
SecureUtil.sha1
SecureUtil.hmac
SecureUtil.hmacMd5
SecureUtil.hmacSha1

Samo jednostavan primer kao referenca:

public class SecureUtilDemo {
    static AES aes = SecureUtil.aes();
    public static void main(String[] args) {
        String encry = aes.encryptHex("Chenmo Wang Er");
        System.out.println(encry);
        String oo = aes.decryptStr(encry);
        System.out.println(oo);
    }
}

18. Druge biblioteke

Hutool ima još mnogo biblioteka, posebno dalja obmotavanja biblioteka trećih strana, kao što su alatka za imejl MailUtil, alatka za QR kodove QrCodeUtil, Emoji alatka EmojiUtil — drugovi mogu pogledati Hutool-ovu zvaničnu dokumentaciju: https://www.hutool.cn/

Adresa izvornog koda projekta: https://github.com/looly/hutool