Organizowanie pakietów w module

Pakiet grupuje powiązane pliki Kotlina pod nazwą rozdzielaną kropkami. Dobrze zaprojektowane pakiety ułatwiają poruszanie się po rozrastającym się wspólnym module. 📁

Każdy plik zaczyna się od wiersza package. Powinien on odzwierciedlać ścieżkę folderu, aby struktura była przewidywalna dla wszystkich.

Preferuj grupowanie według funkcji zamiast grupowania według typu. Pakiet koszyka może zawierać razem jego model, logikę i funkcje pomocnicze.

Przejrzysty podział to domain dla czystych modeli i reguł oraz data dla komunikacji sieciowej i przechowywania danych. Granica pomaga każdej części zachować konkretną odpowiedzialność.

Zaczynaj pakiety od nazwy reverse-domain, takiej jak com.acme.shared. Dzięki temu Twój kod nie będzie kolidował z pakietami bibliotek.

Zachowaj zgodność drzewa folderów z nazwami pakietów. Gdy oba elementy są zgodne, każdy może znaleźć klasę na podstawie jej pełnej nazwy.

Umieść udostępniane typy w jednym oczywistym publicznym pakiecie, na przykład com.acme.shared.api. Wywołujący będą wtedy wiedzieć, gdzie szukać.

Trzymaj funkcje pomocnicze w wewnętrznym pakiecie, takim jak .impl lub .util. Sama nazwa od razu sygnalizuje, że wywołujący nie powinni tam zaglądać.

Unikaj niekończącego się zagnieżdżania. Płytkie drzewo z kilkoma jasnymi pakietami łatwiej przejrzeć niż dziesięć poziomów małych folderów.

Używaj tego samego układu pakietów w commonMain, androidMain i iosMain. Zgodne ścieżki ułatwiają znajdowanie par expect i actual.

Przeczytaj listę pakietów od góry do dołu. Same nazwy powinny wyjaśniać, co robi moduł i gdzie znajduje się każda odpowiedzialność.

Grupuj według funkcji lub warstwy, dopasuj foldery do pakietów, zachowaj płytką strukturę i ukryj elementy wewnętrzne. Przejrzyste drzewo skaluje się wraz z rozwojem modułu. 🎉