Dlaczego używanie System.out.println () jest tak złe? [Zamknięte]

Oczywiście bardzo przydatne jest użycie struktury rejestrowania komunikatów o błędach lub ostrzeżeń. Ale czasami używam System.out.println (), jeśli chcę wypróbować coś nowego w krótkim czasie.

Czy naprawdę źle jest używać System.out.println () do szybkiego testu?

Jak ujawniono w komentarzach, prawdziwym pytaniem jest, dlaczego narzędzia do analizy kodu statycznego używają System.out.println?

Powodem jest to, że wysyłanie wiadomości na standardowe wyjście jest zwykle nieodpowiednie w środowisku produkcyjnym. Jeśli kodujesz bibliotekę, biblioteka powinna zwrócić informacje do swojego obiektu wywołującego, a nie drukować na standardowe wyjście. Jeśli kodujesz aplikację GUI, informacje powinny być przedstawione użytkownikowi, a nie temu, na co wskazuje stdout (co może być nigdzie). Jeśli kodujesz serwer (lub coś, co działa w kontenerze po stronie serwera), powinieneś korzystać z dowolnej funkcji rejestrowania udostępnionej przez platformę. I tak dalej.

Ale jeśli używasz println do debugowania lub programowania, lub piszesz program i czyta stdin i pisze na stdout, println jest w porządku. Nie ma w tym nic złego w tego rodzaju przypadkach.

Wszystko stdoutjest buforowane, dlatego możliwe jest , że Twój program zawiesi się po twoim wywołaniu println(), ale zanim dotrze do ekranu.

Biorąc to pod uwagę, ten scenariusz jest naprawdę mało prawdopodobny. Śmiało i używaj go, ale zachowaj to niewielkie ograniczenie w głębi duszy.

System.outjest tylko opakowaniem BufferedOutputStream. Jest to prawdopodobnie podobne do każdego używanego frameworka rejestrowania, frameworki zapewniają po prostu więcej funkcji w postaci konfiguracji i miejsca docelowego danych wyjściowych dziennika

Źle jest, jeśli pracujesz nad nietrywialnym programem

• Używają System.out jako kuli zamiast zautomatyzowanych testów jednostkowych (JUnit)
• Poświęć dużo czasu na tworzenie i usuwanie lub komentowanie / komentowanie instrukcji System.out

Jest kilka ostrzeżeń dotyczących używania System.out, nawet w wyrzucanym kodzie.

Jednym z głównych problemów jest to, że zwykle jest powolny . Na przykład, jeśli próbujesz uzyskać ogólne pojęcie o szybkości jakiegoś kodu (pamiętaj, że mikrodrukowanie jest trudne ), to dodanie jednego w System.out.println()dowolnym miejscu może naprawdę zepsuć twój czas (ponieważ synchronizuje się i często czeka na faktyczne wyjście być widoczne dla użytkownika przed powrotem).

Poza tym nie przejmowałbym się tym zbytnio w wyrzucanym kodzie. Jeśli zamierzasz go zatwierdzić (czy to jako kod produkcyjny, czy jako kod testowy), powinieneś się go pozbyć i zastąpić wywołaniem rejestrującym propper (tak, nawet w kodzie testowym).

Jak to często bywa, odpowiedź brzmi „to zależy”. Jeśli Twoja aplikacja ma już strukturę rejestrowania, równie dobrze możesz jej użyć. Nie może być mniej zdolny println()i możesz skorzystać z innych funkcji, które zapewnia - śladów stosu, dodatkowego kontekstu, lepszego formatowania i tak dalej. Istnieje również wyraźna możliwość, że struktury rejestrowania oferują lepsze odzyskiwanie po błędzie, zapewniając, że dzienniki są zapisywane z powodzeniem nawet w przypadku katastrofalnej awarii.

Powstaje więc pytanie, kiedy należy dodać system rejestrowania. Jest to wezwanie do osądu: nie chcesz dodawać go zbyt wcześnie, tylko po to, aby dowiedzieć się, że naprawdę nie potrzebujesz go. Nie chcesz też dodawać go zbyt późno i nadmiernie pracujesz nad konwersją z rozwiązania ad-hoc.

Jeśli odkryjesz, że dużo się logujesz println(), twoja baza kodów próbuje ci powiedzieć, że odczuwa coraz większy ból. W tym momencie warto zainwestować w prawidłowe logowanie.

Często mam problem z tym, że System.out.print używa „domyślnej systemowej” strony kodowej, którą często jest UTF-8 pod Linuksem, ale niektóre zepsute pliki MS pod Windows.

Może to prowadzić do znaków Unicode, które są lub nie są poprawnie drukowane na ekranie, w zależności od miejsca działania programu.

Dlatego wolę niestandardowy PrintWriter niż System.out

To wcale nie jest takie złe. Pomysł może wynikać z faktu, że jest bardzo prosty i nie tak wyrafinowany, jak użycie dedykowanej struktury rejestrowania w aplikacji.

Nie oznacza to jednak, że jest to nieprawidłowe podejście. Używałem go wiele razy, aby sprawdzić przepływ aplikacji po kilku hijinkach do programowania czarnej magii voodoo .

Nie ma nic złego w korzystaniu z niego, pomaga dowiedzieć się „co do diabła się dzieje”.

Ale jeśli twoi rówieśnicy / inni deweloperzy / wyśmiewają cię, zawsze możesz użyć Loggera lub rozpocząć testy Junita !

Największym problemem z okazyjnym System.out.println, jak widzę, jest to, że jest to „zapach złego nawyku (tm)”. Jeśli to robisz, prawdopodobnie możesz poprawić swoją efektywność, poprawiając komfort korzystania z ulubionego debuggera.

Również dzięki debuggerowi masz pewność, że punkt przerwania nie wpadnie do twojego kodu produkcyjnego, podczas gdy System.out.println może.

Na marginesie, jeśli faktycznie przeprowadzasz szybki test i nadal nie używasz debugera, myślę, że System.out.println jest lepszy niż struktura rejestrowania, ponieważ jeśli przypadkowo zostawisz instrukcję log.debug podczas gotowe, trudniej jest wykorzenić.

Zbudowanie całej strategii testowania w oparciu o echo zawartości stanu wewnętrznego nie jest najmądrzejszym posunięciem, ale w przypadku szybkich i brudnych testów kodu w trakcie projektowania dziwne println tutaj i nie będzie bolało tak długo, jak pamiętasz o ich usunięciu!

Niebezpieczeństwo zapomnienia o ich usunięciu jest prawdopodobnie powodem, dla którego jest odradzane.