Witam wszystkich, społeczność JavaRush! Dzisiaj porozmawiamy o jakości kodu. Tak, tak, drodzy przyjaciele. Nikt nie jest doskonały. Każdy kiedyś dochodzi do wniosku, że kod mógłby być lepszy... Tylko co zrobić w takiej sytuacji? Przynajmniej zacznij badać ten problem. Skoro tu jesteś, to znaczy, że temat jest dla Ciebie interesujący, więc chodźmy. Dzisiaj opiszemy sposoby, dzięki którym możesz uczynić swój kod lepszym i czystszym. Abyś w przyszłości nie wstydził się swojego obecnego kodu!..)) Wszystkie te metody pomogą programiście stać się dobrym programistą.
1. Jeśli chcesz ulepszyć swój kod, przeczytaj kod kogoś innego
Jeśli chcesz radykalnie poprawić swoje umiejętności programowania, musisz... czytać kod napisany przez innych programistów. Można w to wierzyć, nie można w to wierzyć. Ale jeśli podejmiesz ryzyko, obiecuję, że otrzymasz nagrodę za poświęcony czas. Na przykład nie czytaj na Habré, jak działają HashMap, ArrayList, LinkedList i tak dalej, ale przeczytaj ich kod i sam to rozwiąż. Oto lista zajęć do przeczytania:
HashMap to najczęściej zadawane pytanie podczas rozmów kwalifikacyjnych. Możesz upiec kilka ptaków na jednym ogniu: poznaj kod i zdobądź niezbędną wiedzę.
ArrayList działa tak samo jak w przypadku HashMap. Nie ma tam rzeczy skomplikowanych, ale naprawdę warto przeczytać i zrozumieć.
String jest świetnym przykładem. Zrozum, dlaczego jest niezmienna.
AtomicInteger to fajna klasa: opisuje proces atomowego wykonywania operacji na obiektach Integer.
A potem - przynajmniej wszystkie zajęcia z rzędu...)
Jeżeli mówimy o czymś poważniejszym to oczywiście warto zapoznać się z kodem z Pivotala. Ci goście napisali najbardziej poszukiwany ekosystem w świecie Java. Zdecydowanie warto przeczytać ich kod. Dlatego radzę zacząć od Spring Core . Czytanie nieznanego kodu źródłowego jest wymagającą, ale bardzo satysfakcjonującą pracą.)
2. Postępuj zgodnie z Code Conventions – konwencjami dotyczącymi pisania kodu
Konwencje kodowania to zestaw wytycznych opracowanych przez zespoły programistów, które obejmują wytyczne dotyczące stylu i technik programowania dla każdego aspektu kodu napisanego w firmie lub konkretnym projekcie. Konwencje te są zazwyczaj specyficzne dla każdego języka programowania i obejmują organizację plików, wcięcia, komentarze, deklaracje, operatory, białe znaki, konwencje nazewnictwa, techniki i zasady programowania, reguły programowania, najlepsze praktyki architektoniczne itp. Główną zaletą niektórych standardów jest to, że kod wygląda tak samo i jest napisany w tym samym stylu. Dzięki temu jest on bardziej czytelny i pomaga programistom zrozumieć kod napisany przez innego programistę. Jeśli standardy kodowania będą przestrzegane i konsekwentnie stosowane w całym procesie programowania, łatwiej będzie utrzymać i rozszerzać kod, refaktoryzować go i rozwiązywać konflikty integracyjne w przyszłości. Konwencje kodowania są ważne dla programistów z wielu powodów:
40%-80% kosztów oprogramowania przeznacza się na jego utrzymanie;
prawie żadne oprogramowanie nie jest utrzymywane przez autora przez całe jego życie;
Konwencje kodu poprawiają czytelność oprogramowania, umożliwiając programistom szybsze zrozumienie nowego kodu.
Szczerze mówiąc, jestem wielkim fanem standardów kodowania. Moim zdaniem warto spędzać czas na dyskusjach i kłótniach na ich temat, ponieważ jest to cenne zajęcie, które pozwoli Ci zaoszczędzić czas i wysiłek w przyszłości. Konwencje Kodeksu należy często przeglądać. Reguły można tłumaczyć z „obowiązkowych” na „opcjonalne” i odwrotnie. Jeśli niektóre z nich nie działają prawidłowo, należy je przeprojektować lub usunąć z wytycznych.
3. Użyj Code Review – przegląd kodu przez innych
Przegląd kodu jest jednym z najpotężniejszych narzędzi do ulepszania kodu. Dlaczego? Ponieważ kod będzie sprawdzany przez tych specjalistów, którzy go nie napisali. A świeży wygląd jest bardzo przydatny. Często to właśnie Code Review pomaga zapobiec pisaniu naprawdę okropnego kodu. Wiem, że nie zawsze jest to możliwe, bo trzeba znaleźć inną osobę, która będzie chciała to zrobić. Nie oznacza to jednak, że nie warto korzystać z tego narzędzia. Wręcz przeciwnie: to powód, aby znaleźć podobnie myślących ludzi, dla których ważne jest także doskonalenie jakości kodu. Swoją drogą, kto zabrania Ci znaleźć je tutaj, na JavaRush? W miejscu, w którym każdy chce zostać programistą.
Zdecydowanie moją ulubioną metodą ulepszania kodu jest pisanie testów jednostkowych. Co więcej, im więcej ich napiszesz, tym lepiej. W programowaniu komputerowym testowanie jednostkowe to proces tworzenia oprogramowania, podczas którego najmniejsza testowalna część kodu źródłowego, zwana jednostką, jest testowana indywidualnie i niezależnie w celu sprawdzenia, czy działa zgodnie z oczekiwaniami. Pomoże to zidentyfikować błędy w algorytmach i/lub logice przed wydaniem kodu. Ponieważ testy jednostkowe wymagają odpowiedniej struktury kodu, oznacza to, że kod należy podzielić na mniejsze i bardziej ukierunkowane funkcje. Każda z nich odpowiada za pojedynczą operację na zbiorze danych, a nie duże funkcje wykonujące szereg różnych operacji.(Jak to mówią pozdrawiam z Zasady Pojedynczej Odpowiedzialności ...)Druga korzyść z napisania dobrze przetestowanego kodu polega na tym, że możesz zapobiec przyszłym awariom dzięki niewielkim zmianom w istniejącej funkcjonalności łamania kodu. Gdy wystąpi awaria, testy jednostkowe wykażą, że coś zostało zapisane niepoprawnie. Na pierwszy rzut oka spędzanie czasu na pisaniu testów jednostkowych w trakcie programowania wydaje się dodatkowym wydatkiem. Pozwoli to jednak zaoszczędzić czas w przyszłości, który trzeba będzie poświęcić na debugowanie. Powinien to być proces etapowy. Dlatego śmiało śpiewaj - pisz testy dla wszystkich metod i klas :D
5. Korzystaj z narzędzi poprawiających jakość kodu
Nie ma programisty, który nigdy nie popełnia błędów. Zazwyczaj kompilator wychwytuje problemy składniowe i arytmetyczne i generuje ślad stosu. Ale nadal mogą występować pewne problemy, których kompilator nie wychwytuje. Na przykład nieprawidłowo zaimplementowane wymagania, nieprawidłowe algorytmy, nieprawidłowa struktura kodu lub jakieś potencjalne problemy znane społeczności z doświadczenia. Jedynym sposobem na wyłapanie takich błędów jest poproszenie starszego programisty o sprawdzenie kodu. Takie podejście nie jest panaceum i niewiele zmienia. Każdy nowy programista w zespole powinien mieć dodatkową parę oczu obserwujących jego kod. Ale na szczęście istnieje wiele narzędzi, które mogą pomóc Ci kontrolować jakość kodu. W pracy nad różnymi projektami korzystałem z Checkstyle, PMD, FindBugs, SonarQube. Są też inni. Wszystkie są powszechnie używane do analizy jakości i generowania przydatnych raportów. Bardzo często raporty te publikowane są przez serwery ciągłej integracji takie jak Jenkins.
6. Napisz prosty i przejrzysty kod
Zawsze pisz prosty, przejrzysty i logiczny kod. Ludzie mają tendencję do pisania złożonego kodu, aby udowodnić, że potrafią to zrobić. Prosty, ale logiczny kod zawsze działa dobrze, powoduje mniej problemów i jest bardziej rozszerzalny. Dobry kod oznacza lepszą dokumentację. Jeśli zastanawiasz się nad dodaniem komentarza, zadaj sobie pytanie: „ Jak mogę ulepszyć kod, aby ten komentarz nie był potrzebny? „ ~Steve McConnell.
7. Przeczytaj dokumentację
Jednym z ważnych nawyków dobrych programistów jest czytanie dużej ilości dokumentacji. Niech to będą specyfikacje, JSR, dokumentacja API, samouczki itp. Czytanie dokumentacji pomaga zbudować mocny fundament, na którym najlepiej programujesz. I wreszcie, nie porównuj się z innymi. Porównywanie się z innymi doprowadzi jedynie do negatywnych uczuć i niezdrowej rywalizacji. Każdy ma swoje mocne i słabe strony. Dlatego ważne jest, aby je znać i pracować z nimi. Przeanalizuj siebie, wypisz swoje mocne strony i pracuj nad nimi. Programowanie to prawdziwa zabawa: ciesz się nią.
„Stała dla jednego człowieka jest zmienną dla innego.”
8. Obserwuj ciekawych blogerów
Na całym świecie tysiące entuzjastów pracuje nad tymi samymi technologiami i pisze o nich. Blogi są często tworzone przez samych programistów i większość z nich dzieli się osobistymi opiniami i doświadczeniami. Na blogach można zobaczyć różne spojrzenia na tę samą technologię. Na blogach można zobaczyć zarówno dobrą, jak i złą technologię. Przeczytaj przynajmniej artykuły na temat Habré JavaRush :D, w tym mój. Obserwuj dobre blogi i komentuj posty, dziel się swoją opinią.
9. Czytaj specjalistyczne książki
Nic nie zastąpi dobrej książki. Dobra książka nauczy podstawowych pojęć w znacznie prostszy sposób i zastosuje je do obiektów ze świata rzeczywistego. Ich autorzy sami są świetnymi programistami. Czytając książki, możesz uczyć się na doświadczeniach innych. Sugeruję przeczytanie „Java. Efektywne programowanie Joshua Bloch. W tej książce przedstawiono siedemdziesiąt osiem niezastąpionych praktycznych zasad programisty: działanie, najlepsze rozwiązania problemów programistycznych, z którymi spotykasz się każdego dnia. Zawiera najbardziej praktyczne i wiarygodne wytyczne, których możesz użyć do napisania skutecznych, dobrze zaprojektowanych programów. Jeśli dopiero zaczynasz przygodę z Javą i nie masz doświadczenia w programowaniu, być może zechcesz przeczytać książkę Sams Teach Yourself Java 2 w 24 godziny. A jeśli chodzi o pisanie czystego kodu, jest doskonała książka „Clean Code by Robert Martin”. Następnie pojawi się „poczucie piękna” w odniesieniu do kodu.
10. Kod! Kod! Kod!
Nie możesz zostać dobrym programistą po prostu ucząc się książki na pamięć. Łatwo jest mówić o koncepcjach teoretycznych. Ale ograniczeń językowych i opracowania najlepszych praktyk można nauczyć się tylko podczas pisania kodu. Dlatego, aby zostać dobrym programistą, trzeba napisać dużo kodu. Jeśli jesteś początkujący, zacznij od napisania programów do prostych problemów, takich jak ciąg Fibonacciego, palindrom, trójkąt Pascala itp., a następnie przejdź do większych problemów, takich jak drzewo wyszukiwania binarnego itp. Jeśli szukasz platformy internetowej do ćwiczenia programów w języku Java, spójrz na Coding Ground . Ponadto można skorzystać z kursu CS50 , którego tłumaczenie dostarczyło nam „wiesz kto” :D
Podsumujmy to
Ten, kto nic nie robi, nie popełnia błędów. Dlatego musimy uzbroić się w cierpliwość i niczym pracowity Japończyk doskonalimy swoje umiejętności kodowania. W tym celu nie zapomnij:
przeczytaj kod innej osoby;
przeprowadzić i poprosić o ponowne sprawdzenie kodu;
pisać testy jednostkowe;
używać narzędzi do ulepszania kodu;
pisać prosty i zrozumiały kod;
przeczytaj dokumentację tych, którzy byli w stanie;
Jeśli chcesz radykalnie poprawić swoje umiejętności programowania, musisz... czytać kod napisany przez innych programistów. Można w to wierzyć, nie można w to wierzyć. Ale jeśli podejmiesz ryzyko, obiecuję, że otrzymasz nagrodę za poświęcony czas. Na przykład nie czytaj na Habré, jak działają HashMap, ArrayList, LinkedList i tak dalej, ale przeczytaj ich kod i sam to rozwiąż. Oto lista zajęć do przeczytania:
Konwencje kodowania to zestaw wytycznych opracowanych przez zespoły programistów, które obejmują wytyczne dotyczące stylu i technik programowania dla każdego aspektu kodu napisanego w firmie lub konkretnym projekcie. Konwencje te są zazwyczaj specyficzne dla każdego języka programowania i obejmują organizację plików, wcięcia, komentarze, deklaracje, operatory, białe znaki, konwencje nazewnictwa, techniki i zasady programowania, reguły programowania, najlepsze praktyki architektoniczne itp. Główną zaletą niektórych standardów jest to, że kod wygląda tak samo i jest napisany w tym samym stylu. Dzięki temu jest on bardziej czytelny i pomaga programistom zrozumieć kod napisany przez innego programistę. Jeśli standardy kodowania będą przestrzegane i konsekwentnie stosowane w całym procesie programowania, łatwiej będzie utrzymać i rozszerzać kod, refaktoryzować go i rozwiązywać konflikty integracyjne w przyszłości. Konwencje kodowania są ważne dla programistów z wielu powodów:
Dlaczego? Ponieważ kod będzie sprawdzany przez tych specjalistów, którzy go nie napisali. A świeży wygląd jest bardzo przydatny. Często to właśnie Code Review pomaga zapobiec pisaniu naprawdę okropnego kodu. Wiem, że nie zawsze jest to możliwe, bo trzeba znaleźć inną osobę, która będzie chciała to zrobić. Nie oznacza to jednak, że nie warto korzystać z tego narzędzia. Wręcz przeciwnie: to powód, aby znaleźć podobnie myślących ludzi, dla których ważne jest także doskonalenie jakości kodu. Swoją drogą, kto zabrania Ci znaleźć je tutaj, na JavaRush? W miejscu, w którym każdy chce zostać programistą.
Zdecydowanie moją ulubioną metodą ulepszania kodu jest pisanie testów jednostkowych. Co więcej, im więcej ich napiszesz, tym lepiej. W programowaniu komputerowym testowanie jednostkowe to proces tworzenia oprogramowania, podczas którego najmniejsza testowalna część kodu źródłowego, zwana jednostką, jest testowana indywidualnie i niezależnie w celu sprawdzenia, czy działa zgodnie z oczekiwaniami. Pomoże to zidentyfikować błędy w algorytmach i/lub logice przed wydaniem kodu. Ponieważ testy jednostkowe wymagają odpowiedniej struktury kodu, oznacza to, że kod należy podzielić na mniejsze i bardziej ukierunkowane funkcje. Każda z nich odpowiada za pojedynczą operację na zbiorze danych, a nie duże funkcje wykonujące szereg różnych operacji.(Jak to mówią pozdrawiam z Zasady Pojedynczej Odpowiedzialności ...)Druga korzyść z napisania dobrze przetestowanego kodu polega na tym, że możesz zapobiec przyszłym awariom dzięki niewielkim zmianom w istniejącej funkcjonalności łamania kodu. Gdy wystąpi awaria, testy jednostkowe wykażą, że coś zostało zapisane niepoprawnie. Na pierwszy rzut oka spędzanie czasu na pisaniu testów jednostkowych w trakcie programowania wydaje się dodatkowym wydatkiem. Pozwoli to jednak zaoszczędzić czas w przyszłości, który trzeba będzie poświęcić na debugowanie. Powinien to być proces etapowy. Dlatego śmiało śpiewaj - pisz testy dla wszystkich metod i klas :D
Nie ma programisty, który nigdy nie popełnia błędów. Zazwyczaj kompilator wychwytuje problemy składniowe i arytmetyczne i generuje ślad stosu. Ale nadal mogą występować pewne problemy, których kompilator nie wychwytuje. Na przykład nieprawidłowo zaimplementowane wymagania, nieprawidłowe algorytmy, nieprawidłowa struktura kodu lub jakieś potencjalne problemy znane społeczności z doświadczenia. Jedynym sposobem na wyłapanie takich błędów jest poproszenie starszego programisty o sprawdzenie kodu. Takie podejście nie jest panaceum i niewiele zmienia. Każdy nowy programista w zespole powinien mieć dodatkową parę oczu obserwujących jego kod. Ale na szczęście istnieje wiele narzędzi, które mogą pomóc Ci kontrolować jakość kodu. W pracy nad różnymi projektami korzystałem z Checkstyle, PMD, FindBugs, SonarQube. Są też inni. Wszystkie są powszechnie używane do analizy jakości i generowania przydatnych raportów. Bardzo często raporty te publikowane są przez serwery ciągłej integracji takie jak Jenkins.
Zawsze pisz prosty, przejrzysty i logiczny kod. Ludzie mają tendencję do pisania złożonego kodu, aby udowodnić, że potrafią to zrobić. Prosty, ale logiczny kod zawsze działa dobrze, powoduje mniej problemów i jest bardziej rozszerzalny. Dobry kod oznacza lepszą dokumentację. Jeśli zastanawiasz się nad dodaniem komentarza, zadaj sobie pytanie: „ Jak mogę ulepszyć kod, aby ten komentarz nie był potrzebny? „ ~Steve McConnell.
Jednym z ważnych nawyków dobrych programistów jest czytanie dużej ilości dokumentacji. Niech to będą specyfikacje, JSR, dokumentacja API, samouczki itp. Czytanie dokumentacji pomaga zbudować mocny fundament, na którym najlepiej programujesz. I wreszcie, nie porównuj się z innymi. Porównywanie się z innymi doprowadzi jedynie do negatywnych uczuć i niezdrowej rywalizacji. Każdy ma swoje mocne i słabe strony. Dlatego ważne jest, aby je znać i pracować z nimi. Przeanalizuj siebie, wypisz swoje mocne strony i pracuj nad nimi. Programowanie to prawdziwa zabawa: ciesz się nią.
Na całym świecie tysiące entuzjastów pracuje nad tymi samymi technologiami i pisze o nich. Blogi są często tworzone przez samych programistów i większość z nich dzieli się osobistymi opiniami i doświadczeniami. Na blogach można zobaczyć różne spojrzenia na tę samą technologię. Na blogach można zobaczyć zarówno dobrą, jak i złą technologię. Przeczytaj przynajmniej artykuły na temat 
Nic nie zastąpi dobrej książki. Dobra książka nauczy podstawowych pojęć w znacznie prostszy sposób i zastosuje je do obiektów ze świata rzeczywistego. Ich autorzy sami są świetnymi programistami. Czytając książki, możesz uczyć się na doświadczeniach innych. Sugeruję przeczytanie „Java. Efektywne programowanie Joshua Bloch. W tej książce przedstawiono siedemdziesiąt osiem niezastąpionych praktycznych zasad programisty: działanie, najlepsze rozwiązania problemów programistycznych, z którymi spotykasz się każdego dnia. Zawiera najbardziej praktyczne i wiarygodne wytyczne, których możesz użyć do napisania skutecznych, dobrze zaprojektowanych programów. Jeśli dopiero zaczynasz przygodę z Javą i nie masz doświadczenia w programowaniu, być może zechcesz przeczytać książkę Sams Teach Yourself Java 2 w 24 godziny. A jeśli chodzi o pisanie czystego kodu, jest doskonała książka „Clean Code by Robert Martin”. Następnie pojawi się „poczucie piękna” w odniesieniu do kodu.
Łatwo jest mówić o koncepcjach teoretycznych. Ale ograniczeń językowych i opracowania najlepszych praktyk można nauczyć się tylko podczas pisania kodu. Dlatego, aby zostać dobrym programistą, trzeba napisać dużo kodu. Jeśli jesteś początkujący, zacznij od napisania programów do prostych problemów, takich jak ciąg Fibonacciego, palindrom, trójkąt Pascala itp., a następnie przejdź do większych problemów, takich jak drzewo wyszukiwania binarnego itp. Jeśli szukasz platformy internetowej do ćwiczenia programów w języku Java, spójrz na Coding Ground . Ponadto można skorzystać z kursu CS50 , którego tłumaczenie dostarczyło nam „wiesz kto” :D
GO TO FULL VERSION