Czy powinienem zadeklarować „statyczny rejestrator końcowy” w GÓRNEJ PRZYPADKU?

W Javie statyczne zmienne końcowe są stałymi, a konwencja jest taka, że ​​powinny być pisane wielkimi literami. Widziałem jednak, że większość ludzi deklaruje rejestratory małymi literami, co pojawia się jako naruszenie w PMD .

na przykład:

private static final Logger logger = Logger.getLogger(MyClass.class);

Po prostu wyszukaj w Google lub SO „statyczny rejestrator końcowy”, a zobaczysz to sam.

Czy zamiast tego powinniśmy używać LOGGERA?

Odwołanie do programu rejestrującego nie jest stałą, ale ostatecznym odniesieniem i NIE powinno być pisane wielkimi literami. Stała WARTOŚĆ powinna być pisana wielkimi literami.

private static final Logger logger = Logger.getLogger(MyClass.class);

private static final double MY_CONSTANT = 0.0;

Aby dodać więcej wartości do odpowiedzi crunchdog, Przewodnik po stylu kodowania Java zawiera to w paragrafie 3.3 Nazewnictwo pól

Nazwy pól używanych jako stałe powinny być pisane wielkimi literami, z podkreślnikami oddzielającymi słowa. Za stałe uważa się:

1. Wszystkie static finalpierwotne typy (pamiętaj, że wszystkie pola interfejsu są z natury static final).
2. Wszystkie static finaltypy odwołań do obiektów, po których nigdy nie następuje „ .” (kropka).
3. Wszystkie static finaltablice, po których nigdy nie następuje „ [” (otwierający nawias kwadratowy).

Przykłady:

MIN_VALUE, MAX_BUFFER_SIZE, OPTIONS_FILE_NAME

Po tej konwencji, loggerto static finalodwołanie do obiektu, jak wskazano w pkt 2, ale dlatego, że jest następnie „ .” za każdym razem go używać, to nie można uznać za stałą, a zatem powinny być małe.

Od wersji skutecznej Java, wyd. 2,

Jedyny wyjątek od poprzedniej reguły dotyczy „stałych pól”, których nazwy powinny składać się z jednego lub więcej wielkich liter oddzielonych znakiem podkreślenia, na przykład VALUES lub NEGATIVE_INFINITY. Pole stałe to statyczne pole końcowe, którego wartość jest niezmienna . Jeśli statyczne pole końcowe ma typ pierwotny lub niezmienny typ odniesienia (pozycja 15), to jest to pole stałe. Na przykład stałe wyliczeniowe są polami stałymi. Jeśli statyczne pole końcowe ma zmienny typ odniesienia, może nadal być polem stałym, jeśli obiekt odniesienia jest niezmienny.

Podsumowując, stała == statyczny finał, plus jeśli jest to referencja (w porównaniu z typem prostym), niezmienność.

Patrząc na rejestrator slf4j, http://www.slf4j.org/api/org/slf4j/Logger.html

Jest niezmienny. Z drugiej strony rejestrator JUL jest zmienny. Rejestrator log4j jest również modyfikowalny. Tak więc, aby być poprawnym, jeśli używasz log4j lub JUL, powinien to być „logger”, a jeśli używasz slf4j, powinien to być LOGGER.

Zauważ, że strona slv4j javadocs, do której prowadzi link powyżej, zawiera przykład, w którym używają „logger”, a nie „LOGGER”.

Są to oczywiście tylko konwencje, a nie reguły. Jeśli akurat używasz slf4j i chcesz użyć „loggera”, ponieważ jesteś przyzwyczajony do tego z innych frameworków, lub jeśli łatwiej jest pisać lub dla czytelności, śmiało.

Podoba mi się podejście Google ( Google Java Style )

Każda stała jest statycznym polem końcowym, ale nie wszystkie statyczne pola końcowe są stałymi. Przed wybraniem stałej wielkości, zastanów się, czy pole naprawdę wydaje się stałą. Na przykład, jeśli którykolwiek z obserwowalnych stanów tego wystąpienia może się zmienić, prawie na pewno nie jest stały. Sam fakt, że nigdy nie zmutujesz obiektu, na ogół nie wystarcza.

Przykłady:

// Constants
static final int NUMBER = 5;
static final ImmutableList<String> NAMES = ImmutableList.of("Ed", "Ann");
static final Joiner COMMA_JOINER = Joiner.on(',');  // because Joiner is immutable
static final SomeMutableType[] EMPTY_ARRAY = {};
enum SomeEnum { ENUM_CONSTANT }

// Not constants
static String nonFinal = "non-final";
final String nonStatic = "non-static";
static final Set<String> mutableCollection = new HashSet<String>();
static final ImmutableSet<SomeMutableType> mutableElements = ImmutableSet.of(mutable);
static final Logger logger = Logger.getLogger(MyClass.getName());
static final String[] nonEmptyArray = {"these", "can", "change"};

Jeśli używasz zautomatyzowanego narzędzia do sprawdzania standardów kodowania, które narusza wspomniane standardy, należy je naprawić. Jeśli używasz zewnętrznego standardu, napraw kod.

Konwencja w Sun Java jest wielka dla publicznych stałych statycznych. Oczywiście logger nie jest stały, ale reprezentuje zmienną rzecz (inaczej nie byłoby sensu wywoływać w nim metod w nadziei, że coś się wydarzy); nie ma określonego standardu dla niestałych pól końcowych.

Jeśli google to, może się okazać, że w niektórych przypadkach rejestratory nie są zdefiniowane jako statyczny końcowy. Dodaj do tego szybkie kopiowanie i wklejanie, a to może to wyjaśnić.

Używamy LOGGERA w całym naszym kodzie, co odpowiada naszej konwencji nazewnictwa (i nasz CheckStyle jest z niego zadowolony).

Posuwamy się nawet dalej, korzystając ze ścisłej konwencji nazewnictwa w Eclipse. Tworzymy nową klasę z szablonem kodu:

    // private static final Logger LOGGER = Logger.getLogger(${enclosing_type}.class);

Rejestrator został skomentowany, ponieważ początkowo nie jest nam potrzebny. Ale jeśli będziemy go potrzebować później, po prostu odkomentujemy.

Następnie w kodzie używamy szablonów kodu, które oczekują obecności tego programu rejestrującego. Przykład z szablonem try-catch:

    try {
      ${cursor} or some other template
    } catch (Exception t) {
      LOGGER.error("${methodName} ${method parameters}", t);
    }

Mamy jeszcze kilka szablonów, które z niego korzystają.

Ścisłe konwencja pozwala nam być bardziej wydajne i spójne z szablonów kodu .

Osobiście uważam, że wielkie litery wyglądają na naprawdę duże. Co więcej, ponieważ jest to klasa, która nie jest bezpośrednio związana z zachowaniem klasy, nie widzę większego problemu w użyciu loggerzamiast LOGGER. Ale jeśli będziesz ściśle pedantyczny, użyj LOGGER.

Nie zapominaj, że PMD uszanuje komentarz

// NOPMD

w tym. Spowoduje to, że PMD pominie linię z kontroli, umożliwi to wybór dowolnego stylu.

Zwykle stałe są pisane wielkimi literami.

Rejestratory nie powinny jednak być statyczne, ale sprawdzane dla każdej „nowej” klasy zawierającej, jeśli używa się fasady slf4j. Pozwala to uniknąć pewnych nieprzyjemnych problemów z modułami ładującymi w kontenerach internetowych, a ponadto umożliwia programowi rejestrującemu wykonywanie specjalnych czynności w zależności od kontekstu wywołania.

Wolę „logger”, czyli małe litery. Powodem nie jest to, że jest stała lub nie stała (zmienna lub niezmienna). Jeśli użyjemy tego rozumowania, będziemy musieli zmienić nazwę zmiennej, jeśli zmienimy strukturę rejestrowania (lub jeśli struktura zmieni zmienność programów rejestrujących).

Dla mnie ważniejsze są inne powody.

1. Program rejestrujący jest obiektem cienia w klasie i nie powinien być bardzo widoczny, ponieważ nie implementuje głównej logiki. Jeśli użyjemy „LOGGER”, przyciąga wzrok w kodzie, który przyciąga zbyt wiele uwagi.

2. Czasami rejestratory są deklarowane na poziomie instancji (tj. Nie jako statyczne), a nawet wstrzykiwane są jako zależność. Nie chciałbym zmieniać kodu, jeśli zdecyduję się zmienić sposób uzyskiwania programu rejestrującego. Wrt stabilność kodu. ta (hipotetyczna w wielu przypadkach) zmiana jest drugim powodem, dla którego wolę małe litery.

Jeśli twoje standardy kodowania - jeśli je masz - mówią, że powinny być pisane wielkimi literami, to tak.

Nie widzę żadnego wyraźnego powodu z takiego czy innego powodu. Myślę, że to całkowicie zależy od twoich osobistych upodobań. standardy kodowania twojej firmy.

BTW: Wolę „LOGGER” ;-)