Badanie cech dużych funkcji

Ukończone

Możliwość rozpoznawania dużych funkcji jest ważną umiejętnością dla deweloperów mających na celu utrzymanie wysokiej jakości kodu. Duże funkcje mogą prowadzić do różnych problemów, w tym słabej czytelności, trudności w konserwacji, niskiej możliwości ponownej obsługi i wyzwań związanych z testowaniem. Deweloperzy, którzy są w stanie zidentyfikować funkcje, które wykazują te cechy, mogą podjąć proaktywne kroki refaktoryzacji ich w mniejszych, bardziej zarządzanych składnikach.

Uwaga / Notatka

Ważne jest, aby deweloperzy zrozumieli, jak ręcznie wykrywać duże funkcje, a nie polegać wyłącznie na narzędziach sztucznej inteligencji. Znajomość cech dużych funkcji, które sprawiają, że są one problematyczne, pomaga deweloperom podejmować świadome decyzje o tym, kiedy i jak skutecznie refaktoryzować kod.

Kodowe smrody i ich symptomy

Kod "zapach" to termin dla wzorców w kodzie, które wskazują głębsze problemy. W terminologii zapach kodu duża funkcja jest "bloater", który zwykle narusza zasadę pojedynczej odpowiedzialności. Duże funkcje to klasyczny zapach kodu.

Poniżej przedstawiono typowe wskaźniki, że funkcja jest zbyt duża lub robi zbyt wiele:

• Nadmierna długość: Liczba linii powyżej 30 jest oznaką potencjalnego problemu. Liczba wierszy powyżej 80 jest prawie zawsze za długa.
• Głębokie zagnieżdżanie: Wiele poziomów zagnieżdżania (pętle w pętlach, zagnieżdżone if/else/try bloki).
• Zbyt wiele parametrów: Więcej niż 5–6 parametrów może wskazywać, że funkcja agreguje zbyt dużą logikę.
• Mieszane poziomy abstrakcji: Operacje wysokiego poziomu i szczegóły niskiego poziomu są przeplatane.
• Sekcje z komentarzami: Komentarze, takie jak // Step 1, // Step 2 sugerują wiele obowiązków.
• Powtórzenie wzorców kodu: Zduplikowana logika lub powtarzające się bloki, które można wyodrębnić.

Uwaga / Notatka

Obecność komentarzy lub bloków regionów wewnątrz funkcji jest czerwoną flagą. Jeśli widzisz funkcję zawierającą serię komentarzy, takich jak // validate inputs, // do X, // clean upitp., oznacza to, że funkcja ma wiele odrębnych sekcji logiki. Każda z tych sekcji prawdopodobnie może być funkcją własną.

Narzędzia i podejścia do znajdowania dużych funkcji

Istnieje kilka sposobów identyfikowania dużych funkcji w bazie kodu:

• Inspekcja ręczna: Przewiń pliki i poszukaj długich zwijanych bloków.
• Wyszukaj komentarze lub obiekty TODO: Deweloperzy często pozostawiają wskazówki, takie jak // this is doing a lot.
• Funkcje środowiska IDE: Visual Studio "Oblicz > metryki kodu" lub rozszerzenia Visual Studio Code.
• Narzędzia do analizy statycznej: Linters lub analizatory (na przykład StyleCop, Roslyn).
• Narzędzia sztucznej inteligencji: Narzędzia korzystające z sztucznej inteligencji, takie jak GitHub Copilot, mogą pomóc zidentyfikować duże funkcje i zasugerować możliwości refaktoryzacji.
• Opinie dotyczące przeglądu kodu: Poszukaj wcześniejszych komentarzy na temat złożoności lub utrzymywalności.
• Metryki: Metryki kodu, takie jak złożoność cyklatyczna i wiersze kodu, mogą pomóc w identyfikowaniu dużych funkcji.
• Raporty pokrycia kodu: Duże funkcje są często trudne do pełnego pokrycia testami.

Typowe "kształty" dużych funkcji

Duże funkcje często są zgodne z pewnymi wzorcami. Oto kilka typowych "kształtów", na które warto zwrócić uwagę:

• Sekwencyjny skrypt: Wykonuje serię kroków po drugim.
• Logika sterowana flagą: Używa switch lub if/else łańcuchów do obsługi wielu trybów.
• Logika skoncentrowana na pomocniczych metodach: Zawiera fragmenty, które mogą być pomocniczymi metodami.
• Powtarzające się bloki: Podobna logika powtarzana dla różnych zestawów danych lub warunków.

Uwaga / Notatka

Użyj testu "wyobraźni wyodrębniania": jeśli możesz nazwać blok kodu jako funkcji, prawdopodobnie powinien być jednym.

Metryki do obejrzenia

Złożoność cyklatyczna, wiersze kodu i liczba parametrów to metryki kwantyfikacyjne, które mogą pomóc w identyfikacji dużych funkcji.

Poniżej przedstawiono niektóre typowe progi wskazujące wysoki priorytet refaktoryzacji:

Wskaźnik	Threshold	Dlaczego ma to znaczenie
Wiersze kodu	80+	Wskazuje złożoność i ryzyko związane z konserwację
Złożoność cyklotyczna	20+	Wiele niezależnych ścieżek = trudniejsze do przetestowania
Parametry	6+	Może wskazywać na słabą enkapsulację lub przekroczenie kompetencji

Co to jest złożoność cyklatyczna?

Złożoność cyklatyczna to metryka oprogramowania, która mierzy liczbę niezależnych ścieżek za pośrednictwem kodu funkcji. Pomyśl o tym jak liczenie, ile różnych ścieżek wykonania programu może przechodzić przez twoją funkcję. Istnieje kilka narzędzi i funkcji IDE, które mogą obliczyć złożoność cyklatyczną. Na przykład w programie Visual Studio możesz użyć funkcji "Analizuj > Oblicz metryki kodu", aby uzyskać wartości złożoności cyklomatycznej dla metod. W programie Visual Studio Code możesz użyć rozszerzeń, takich jak "CodeMetrics", aby przeanalizować kod.

Jak jest obliczana złożoność cyklatyczna

Podstawowa formuła to: Złożoność cyklotyczna = E - N + 2P

Where:

E = krawędzie (przejścia między węzłami) N = węzły (sekwencyjne bloki kodu) P = połączone składniki (zwykle 1 dla pojedynczej funkcji)

Jeśli nie masz dostępu do narzędzia, istnieje proste podejście ręczne, którego można użyć do oszacowania złożoności cyklatycznej:

1. Zacznij od 1.
2. Dodaj 1 dla każdego, jeśli, inaczej, przypadek (w przełączniku).
3. Dodaj 1 dla każdej pętli (for, while, do-while).
4. Dodaj 1 dla każdego operatora logicznego (&&, ||) w warunkach.
5. Dodaj 1 dla każdego bloku catch.

Używanie złożoności jako przewodnika do identyfikowania dużych funkcji

Gdy dokument wspomina o "Złożoność cyklomatyczna powyżej 10–15 jest ostrzeżeniem", oznacza to:

• 1–10: Proste, niskie ryzyko
• 10+: Zacznij rozważać refaktoryzację
• 15+: Zdecydowanie potrzebuje uwagi
• 20+: Wysoki priorytet refaktoryzacji

Złożoność cyklotyczna jest przydatna, ponieważ jest obiektywna i wymierna, co czyni ją doskonałą metryki do identyfikowania funkcji wymagających refaktoryzacji.

Jak zmniejszyć złożoność

Istnieje kilka strategii zmniejszania złożoności dużych funkcji:

• Wyodrębnianie metod: podział złożonej logiki na mniejsze funkcje.
• Użyj polimorfizmu: zastąp złożone warunkowe wzorcami strategii.
• Wczesne powroty: Wyjście wcześnie zamiast głębokiego zagnieżdżania.
• Uprość warunki: Wyodrębnij złożoną logikę boolowską do dobrze nazwanych zmiennych.
• Usuń argumenty flagi: Podziel funkcje, które zachowują się inaczej na podstawie flag.

Nie wszystkie duże funkcje są złe

Niektóre duże funkcje są dopuszczalne w określonych kontekstach (na przykład kod krytyczny dla wydajności). Kieruj się rozsądkiem. Celem jest ułatwienie pracy z kodem.

Uwaga / Notatka

Jeśli funkcja jest trudna do podzielenia, ponieważ wszystko jest ściśle przeplatone, jest to znak wysokiego sprzężenia. Tryb pytania Copilota może pomóc w jego rozplątaniu.

Podsumowanie

Duże funkcje mogą utrudniać proces programowania, wprowadzając różne wyzwania. Często prowadzą one do zmniejszenia czytelności, zwiększenia złożoności i wyższych kosztów konserwacji. Rozpoznając oznaki dużych funkcji i zrozumiejąc ich wpływ, deweloperzy mogą podjąć proaktywne kroki, aby zrefaktoryzować je na mniejsze, jednozadaniowe funkcje, z którymi praca jest łatwiejsza.