Konwencje kodowania w Javie. Którymi podążać i dlaczego

Znajomość i przestrzeganie standardów branżowych i najlepszych praktyk jest bardzo ważne w każdej dziedzinie, a zwłaszcza w programowaniu ze złożoną i czasami chaotyczną mieszanką języków, narzędzi, podejść i technologii kodowania. Dlatego profesjonalny programista Java powinien być dobrze zaznajomiony z konwencjami kodowania Java, o czym będziemy dzisiaj mówić.

Co to są konwencje kodowania?

Konwencje kodowania to zestawy wytycznych dla każdego konkretnego języka programowania z zaleceniami dotyczącymi różnych aspektów tworzenia oprogramowania w tym języku, w tym stylu kodowania, najlepszych praktyk i metod. Konwencje kodowania mają być przestrzegane przez programistów, którzy kodują w tym języku, jako przewodniki jakości, aby zapewnić czytelność ich kodu i możliwość właściwej konserwacji oprogramowania przez inne osoby. Konwencje kodowania zwykle obejmują każdy istotny element tworzenia oprogramowania w tym języku programowania, w tym organizację plików, wcięcia, komentarze, deklaracje, instrukcje, białe znaki, konwencje nazewnictwa, praktyki programistyczne, zasady programowania, praktyczne zasady programowania, najlepsze praktyki architektoniczne i inne .

Jaki jest cel konwencji kodowania?

Istnieje wiele powodów, dla których konwencje kodowania odgrywają ważną rolę w tworzeniu oprogramowania.

• Utrzymanie jednolitego stylu kodu

Przestrzeganie konwencji kodowania umożliwia napisanie projektu oprogramowania w jednym, ujednoliconym stylu, co jest korzystne na kilka różnych sposobów, takich jak poniższe.

• Minimalizacja kosztów utrzymania oprogramowania

Jednym z najważniejszych jest ułatwienie utrzymania i wsparcia oprogramowania, ponieważ bardzo często pierwotni autorzy programu nie są tymi, którzy go wspierają. Jest to ważne, ponieważ 80% kosztów całego życia oprogramowania idzie na konserwację.

• Poprawa czytelności oprogramowania

Poprawa czytelności oprogramowania to kolejna ważna korzyść, która ma również wielorakie implikacje, takie jak uproszczenie wprowadzania nowych programistów do projektu oraz zwiększenie efektywności współpracy członków zespołu programistycznego.

• Przyspieszenie pracy

Wreszcie, posiadanie odpowiednio napisanego i ustrukturyzowanego kodu jest niezbędne, aby proces tworzenia oprogramowania przebiegał tak szybko, jak to możliwe.

Konwencje kodowania w Javie

Jeśli chodzi o Javę, istnieją dwie najbardziej popularne i dobrze znane konwencje kodowania: konwencje Java Code Conventions firmy Oracle i konwencja kodowania Java Style Guide firmy Google .

• Konwencja kodu Java firmy Oracle

Konwencja Oracle Code Convention jest uznawana za najważniejszą z kilku oczywistych powodów: Konwencja Oracle jest konwencją oficjalną, ponieważ Oracle jest właścicielem Javy, a także jedną z najstarszych (ostatnia wersja tego dokumentu została sporządzona 20 kwietnia 2007 r. 1999). Niektóre z ważnych części konwencji Java Code Convention firmy Oracle to zalecenie używania wielbłądziej wielkości liter podczas definiowania klas, metod lub zmiennych, rozpoczynania klas wielką literą i używania rzeczowników do ich nazywania, podczas gdy czasowniki w formie rozkazującej i rozpoczynające się z małej litery dla metod i tak dalej.

• Przewodnik po stylu Java firmy Google

Konwencje kodowania Java firmy Google są uważane za ważne ze względu na status Google jako uczącej się firmy internetowej i technologicznej z ogromnym doświadczeniem w tworzeniu wszelkiego rodzaju aplikacji Java. Innym ważnym powodem jest fakt, że konwencja kodu Java firmy Google została zaktualizowana 22 maja 2018 r., co czyni ją bardziej przydatną niż konwencja kodu firmy Oracle, zwłaszcza jeśli chodzi o opisywanie stosunkowo nowych funkcji Javy, które zostały wydane tylko jako część Java 8 w 2014 r., takie jak lambdy i strumienie. Oto jak autorzy Google's Java Style Guide opisują treść tej konwencji kodowania: „Ten dokument stanowi kompletną definicję standardów kodowania Google dla kodu źródłowego w Javie. Podobnie jak inne przewodniki po stylach programowania, omawiane zagadnienia obejmują nie tylko kwestie estetyczne formatowania, ale także inne rodzaje konwencji lub standardów kodowania. Jednak ten dokument koncentruje się przede wszystkim na sztywnych zasadach, których przestrzegamy powszechnie, i unika udzielania porad, które nie są wyraźnie wykonalne (czy to przez człowieka, czy przez narzędzie). „Przewodnik po stylach Google Java jest w większości dobrym źródłem informacji, ale w niektórych tematach jest trochę pobłażliwy. Z drugiej strony, jako programista Java musisz być przyzwyczajony między innymi do 4 miejsc na wcięcia kodu” – powiedział David Rios, architekt oprogramowania i doświadczony programista Java, w LinkedIn ale jest trochę pobłażliwy w niektórych tematach. Z drugiej strony, jako programista Java musisz być przyzwyczajony między innymi do 4 miejsc na wcięcia kodu” – powiedział David Rios, architekt oprogramowania i doświadczony programista Java, w LinkedIn ale jest trochę pobłażliwy w niektórych tematach. Z drugiej strony, jako programista Java musisz być przyzwyczajony między innymi do 4 miejsc na wcięcia kodu” – powiedział David Rios, architekt oprogramowania i doświadczony programista Java, w LinkedInpost z kilkoma proponowanymi adaptacjami do własnego przewodnika Google Java Style Guide.

Najczęściej używane standardy kodowania Java

Oto niektóre z najczęściej używanych standardów kodowania Java, które można znaleźć w wyżej wymienionych konwencjach kodowania Oracle i Google, a także w innych dokumentach tego rodzaju.

• Przestrzegaj właściwej konwencji nazewnictwa;
• Dodaj Komentarze;
• Identyfikator oznacza symboliczną nazwę odnoszącą się do nazw klas, pakietów, metod i zmiennych w programie Java;
• Nazwa zmiennej powinna być związana z jej przeznaczeniem;
• Nazwa metody powinna odnosić się do funkcjonalności metody;
• Metoda nie powinna zawierać więcej niż 50 wierszy;
• W tej samej lub innej klasie nie powinno być Duplikatu kodu;
• Deklaruj zmienne globalne tylko wtedy, gdy jest to konieczne do użycia w innych metodach;
• Sprawdź dwukrotnie tworzenie zmiennych statycznych w klasie;
• Unikaj bezpośredniego dostępu do zmiennych z innych klas, zamiast tego używaj metod pobierających i ustawiających;
• Cała logika biznesowa powinna być obsługiwana tylko w klasie usług;
• Cały kod związany z DB powinien znajdować się tylko w klasach DAO;
• Używaj getterów i setterów;
• Zadeklaruj zmienną instancji jako prywatną;
• Zachowaj minimalny zakres zmiennych;
• Przypisz znaczące nazwy do zmiennych;
• Unikaj wycieków pamięci, zwalniając połączenia z bazą danych po zakończeniu wykonywania zapytań;
• Staraj się korzystać z funkcji Wreszcie blokuj tak często, jak to możliwe;
• Użyj frameworka Executor do programowania wielowątkowego.