Skocz do treści

Już wkrótce odpalamy zapisy na drugą edycję next13masters.pl. Zapisz się na listę oczekujących!

Po co TypeScript?

Jakiś czas temu na Facebookowej grupie JS News: After Hours zadałem pytanie dotyczące szczegółów użycia języka TypeScript razem z node.js. Wiele osób w swoich komentarzach wyrażało jednak wątpliwość względem zastosowania TypeScriptu na serwerze w ogóle, a ponieważ liczba komentarzy była niemała, odniosłem się tam do nich w całkiem długiej odpowiedzi. Teraz postanowiłem zamienić tę odpowiedź we wpis na blogu.

Ten artykuł jest częścią 1 z 4 w serii TypeScript.

Zdjęcie Michał Miszczyszyn
JavaScript10 komentarzy

Po co TypeScript?

Zacznijmy od tego, że oryginalne pytanie było, moim zdaniem, nieprawidłowo postawione. Powinno brzmieć ono raczej „a po co TypeScript w ogóle?”, bo podobną rolę pełni on zarówno we front-endzie, jak i na serwerze. Guru architektury aplikacji twierdzą zresztą, że dzisiaj nie ma już podziału w projektowaniu aplikacji na front-end i backend. Oczywiście rozwiązywane problemy są różne, jednak podejście i wykorzystywane wzorce – bardzo podobne. Dlaczego więc używane narzędzia miałyby się różnić? A więc: Po co TypeScript?

Statyczne typowanie

Odpowiedź na to pytanie może być długa, bo i powodów jest wiele. Na pewno warto zauważyć, że posiadanie informacji o typach zawsze jest lepsze niż ich brak. Kompilator sprawdzający poprawność typowania automatycznie eliminuje całą gamę potencjalnych błędów w kodzie. Mówi o tym świetna książka "Types and Programming Languages”1. Może się wydawać, że literatura z dziedziny IT wydana tak dawno (2002 r.) jest już nieaktualna, jednak wiedza w niej zawarta jest bardzo uniwersalna i uważam, że warto się zaznajomić z opisywanymi tam konceptami. W zasadzie wystarczy przeczytać tylko pierwszy rozdział (Introduction), który wprowadza do teorii typów i opisuje korzyści wynikające ze stosowania statycznego typowania. Pozostała część książki to bardziej formalny i matematyczny opis. Teoria typów to rozbudowany temat i nie posiadam nawet cząstki wiedzy z tej dziedziny, ale pewien jestem jednego: „Nigdy nie spojrzałem na kod i nie pomyślałem: »chciałbym mieć teraz mniej informacji o typach«”. Ciekawe spojrzenie na ten problem przedstawił Elben Shira w swoim wpisie The End of Dynamic Languages. Wiele osób swoje negatywne nastawienie do statycznego typowania wynosi z języków, które wcale nie są najlepszymi do tego przykładami, np. C++ czy Java. Raz, że nie pokazują one najlepszej strony statycznego typowania (np. inferencji typów), a dwa, że w swoim zapisie są wręcz odstraszająco precyzyjne, formalne i przez to zbyt rozwlekłe. TypeScript jest inny. TS jest nadzbiorem JavaScriptu. Oznacza to, że każdy poprawny kod JS jest również poprawnym kodem TS. Do tego w TypeScript’cie powszechnie stosowana jest inferencja typów. Co to oznacza w praktyce? Weźmy przykładowy kod.
function fn(b:boolean) {  
    if (b === true) {
        return 1;
    } else {
        return 2;
    }
}
Już na pierwszy rzut oka widać, że ta funkcja zawsze zwraca liczbę, prawda? TypeScript również to wie i dlatego niepotrzebna jest tutaj dodatkowa adnotacja opisująca, że ta funkcja zwraca typ number. TypeScript kompiluje kod i wnioskuje (inferuje2?), że funkcja fn zwraca number, bo jest to oczywiste. Dzięki temu kod jest bardziej czytelny oraz zwięzły i niepotrzebne są bardzo formalne i długie deklaracje. Nadal zyskuje się ekspresywność JavaScriptu jednocześnie dodając statyczne typowanie.

Pewność i niepewność

Gdyby statyczne i dynamiczne typowanie chcieć opisać dwoma innymi słowami to za pewne byłyby to „pewność” i „niepewność”. Weźmy prosty przykład: W jaki sposób najprościej dowiedzieć się co zawiera dany obiekt w JavaScripcie? Jeśli jest to obiekt pochodzący z biblioteki to można spróbować zajrzeć do dokumentacji, jednak w tych często zdarzają się pomyłki lub niejasności i tak naprawdę jedynym definitywnym sposobem na przekonanie się o zawartości obiektu jest wypisanie go w konsoli i podejrzenie. Jako programista JavaScript jestem w zasadzie do tego przyzwyczajony. Stąd właśnie słowo „niepewność” – dopóki tego nie zweryfikuję, to nie wiem co znajduje się w obiekcie, jest on czarną skrzynką, nie jestem pewien z czym pracuję, dopóki rzeczywiście nie uruchomię kodu.

W jaki sposób najprościej dowiedzieć się co zawiera dany obiekt w TypScript’cie? W tym przypadku w zasadzie to pytanie nie ma sensu. Od początku doskonale wiem z czym pracuję, od początku znam typ wszystkiego i wszystkiemu nadaję jakiś typ. Jeśli biorę jakiś obiekt to jest on albo opisany interfejsem, albo jest instancją klasy, która ma gdzieś swoją definicję. Co ważne, niczego nie muszę szukać ani się domyślać, bo wszystko jest wiadome. Zauważyłem też, że znacznie mniej czasu spędzam na zaglądaniu do dokumentacji odkąd mam informacje o typach – bo wszystko jest pewne.

IDE

Oprócz sprawdzania poprawności typów jest też kwestia współpracy z edytorami tekstu. Większość programistów używa zintegrowanych środowisk programistycznych posiadających ogromne możliwości statycznej analizy kodu. Jednak nawet narzędzia stworzone przez najbardziej łebskich ekspertów od analizy kodu zawodzą – w szczególności gdy w kodzie pojawia się niekonsekwencja lub jakaś wątpliwość. Tutaj wyłania się następna przewaga TypeScriptu nad dynamicznie typowanym JavaScriptem – możliwość wnioskowania na temat kodu przez edytor jest nieporównywalnie większa i po prostu łatwiejsza gdy używa się TS. Wiele razy spotkałem się z sytuacją, w której podpowiedzi edytora w JavaScripcie były dwuznaczne. Wystarczyło odpowiednio nazwać zmienną, aby edytor poczuł się zagubiony i np. podpowiadał metody, które nigdy nie miały prawa się tam znaleźć. Niejednokrotnie też zawiodły mnie narzędzia do automatycznej refaktoryzacji kodu napisanego w JavaScripcie np. zmieniając nazwy nie tych funkcji, co trzeba. W TypeScript’cie takie sytuacje się nie wydarzą, bo edytor ma pewność co gdzie się znajduje i co do czego należy. Dzięki temu praca jest prostsza i szybsza, a podpowiedzi edytora nader bardziej przydatne.

A wracając do serwera…

Wracając do głównego tematu wykorzystania TS razem z node.js. Gdy pisze się zarówno backend jak i front-end w TypeScript'cie, możliwe jest współdzielenie części plików pomiędzy nimi. Zapewnia to, oprócz zalet płynących z ponownego użycia tego samego kodu, spójność posiadanych informacji na temat typów. I Nie chodzi mi absolutnie o „izomorfizm” w rozumieniu aplikacji internetowych napisanych w JS, które współdzielą kod pomiędzy front-end i back-end i dzięki temu mogą np. wykonać renderowanie zarówno w przeglądarce, jak i na serwerze bez duplikowania kodu. Nie. Chodzi mi coś zupełnie innego.

Weźmy prosty przykład: jeśli budujesz REST API w node.js to wiesz jaka będzie odpowiedź z danego endpointa. Wiesz i umawiasz się z kimś, kto tworzy front-end, że ona taka będzie. Być może zawierasz tę informację w dokumentacji. Ale jeśli coś zmienia się w implementacji, to musisz zaktualizować dokumentację, poinformować front-endowców o zmianach i zadbać o to, aby w projekcie ponownie była spójność. Może być to kłopotliwe, w szczególności gdy projekt jest złożony. Zupełnie inaczej wygląda ta sama sytuacja jeśli JavaScript zastąpi się TypeScriptem: informację o tym co zwraca dany endpoint można zapisać w osobnym pliku jako Interface i ten plik współdzielić pomiędzy front-endem i back-endem. Kompilator zadba o to, żeby odpowiedź z serwera rzeczywiście pasowała do danego interfejsu, na front-endzie będzie 100% pewność co do pól znajdujących się w obiekcie przychodzącym z serwera, a w przypadku zmian po jednej ze stron komunikacja nadal będzie na pewno spójna, bo w innym wypadku kompilacja kodu się nie powiedzie. Proste? Oczywiście. I wykorzystywane przez bardziej dojrzałe technologie (JSF, czy Data Cotract w WCF) od dawna.

Jest jedno „ale”

Jeśli cały nasz kod jest napisany w TypeScript’cie to omyłki w typach tutaj nie będzie (chyba że używa się typu <any>, czego zresztą serdecznie nie polecam). Jednak realnym problemem może być fakt, że informacje o typach zwracanych np. przez zewnętrzne biblioteki napisane w JS są zawarte w zewnętrznych plikach deklaracji .d.ts. Zdarza się, że pliki te nie są aktualizowane tak często jak same biblioteki i przez to mogą pojawiać się między nimi rozbieżności. Zdarza się też, że niektóre biblioteki nie posiadają plików deklaracji wcale, szczególnie dotyczy to projektów mniej popularnych. Teoretycznie ten problem można by rozwiązać pisząc wszystkie biblioteki w TypeScript’cie, ale to chyba temat na inny wpis… Na szczęście deklaracje typów są Open Source i każdy może je edytować. Większość deklaracji znajduje się w DefinitelyTyped, ale w przyszłości zostaną one przeniesione do Typings registry. Ten drugi na szczęście jest kompatybilny wstecz i pozwala również na wyszukiwanie i instalację plików z tego pierwszego. Edytowanie deklaracji jest dość łatwe i przyjemne. Sam zresztą modyfikowałem pliki d.ts dla AngularJS, bo deklaracje znajdujące się w repozytorium nie zostały zaktualizowane wraz z wyjście nowej wersji tego frameworka. Zajęło to dłuższą chwilę, ale korzyści z posiadania pełnej informacji o typach są nieocenione.

Wnioski?

Bez wątpienia użycie TS eliminuje całą gamę przypadkowych bugów wynikających z niepewności odnośnie typów danych. Dzięki temu programiści mogą skupić się na rzeczach istotnych takich jak złożoność logiki biznesowej aplikacji, a nie rozpraszać się przypadkowo popełniamymi błędami, których można uniknąć stosując odpowiednio ścisłe typowanie. Dodatkowo możliwość zawarcia pewnych „kontraktów” na dane przychodzące z API jest nieocenioną pomocą pozwalającą wyeliminować brak spójności pomiędzy rzeczywistą odpowiedzią serwera, a formatem danych oczekiwanym przez front-end. Sama zaś składnia TypeScriptu nie odstaje w zasadzie w ogóle łatwością ekspresji od błyszczącego w tym zakresie JS-a, pomimo dodania pełnej informacji o typach. Ja to doceniam, mnie się podoba, zostałem całkowicie kupiony. Mam nadzieję, że kogoś jeszcze tym wpisem przekonam.
  1. Benjamin C. Pierce - "Types and Programming Languages", The MIT Press
  2. wg. Słownika Języka Polskiego słowo „inferować” to archaizm, natomiast „inferencja” już nie jest archaizmem. Ot, ciekawostka.

👉  Znalazłeś/aś błąd?  👈Edytuj ten wpis na GitHubie!

Autor