Чи повинен бути оголошений "статичний кінцевий реєстратор" у верхньому випадку?

У Java статичні кінцеві змінні є константами, і умовою є те, що вони повинні бути великими. Однак я бачив, що більшість людей заявляють реєстратори в малих регістрах, що вважається порушенням PMD .

наприклад:

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

Просто шукайте в Google або SO "статичний остаточний реєстратор", і ви переконаєтесь у цьому самі.

Чи слід замість цього використовувати LOGGER?

Посилання реєстратора не є постійною, а кінцевою посиланням, і НЕ повинно бути великим. Постійна VALUE повинна бути великою літерою.

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

private static final double MY_CONSTANT = 0.0;

Щоб додати більше значення відповіді крихти, в Посібнику стилю кодування Java зазначено це в пункті 3.3 Назва поля

Назви полів, що використовуються як константи, повинні бути великими літерами з підкресленнями слів. Константами вважаються:

1. Усі static finalпримітивні типи (пам’ятайте, що всі поля інтерфейсу притаманні static final).
2. Усі static finalтипи посилань на об'єкти, за якими ніколи не дотримується " ." (крапка).
3. Усі static finalмасиви, які ніколи не супроводжуються " [" (відкриття квадратної дужки).

Приклади:

MIN_VALUE, MAX_BUFFER_SIZE, OPTIONS_FILE_NAME

Дотримуючись цієї конвенції, logger є static finalпосиланням на об'єкт , як зазначено в пункті 2, а тому , що це слід « .» кожен раз ви його використовуєте, це не може розглядатися як константа , і , отже , повинні бути в нижньому регістрі.

З ефективної java, 2-е видання,

Єдиний виняток із попереднього правила стосується "постійних полів", назви яких повинні складатися з одного або декількох великих речей, розділених символом підкреслення, наприклад, VALUES або NEGATIVE_INFINITY. Постійне поле - статичне кінцеве поле, значення якого незмінне . Якщо статичне кінцеве поле має примітивний тип або незмінний тип відліку (Пункт 15), то це постійне поле. Наприклад, константи перерахунків - це постійні поля. Якщо статичне кінцеве поле має змінний опорний тип, воно все одно може бути постійним полем, якщо посилається об'єкт є незмінним.

Підсумовуючи, константа == статичний фінал, плюс якщо це посилання (проти простого типу), незмінність.

Дивлячись на реєстратор slf4j, http://www.slf4j.org/api/org/slf4j/Logger.html

Це незмінне. З іншого боку, реєстратор JUL є змінним. Журнал log4j також може змінюватися. Отже, щоб бути правильним, якщо ви використовуєте log4j або JUL, він повинен бути "реєстратором", а якщо ви використовуєте slf4j, він повинен бути LOGGER.

Зауважте, що сторінка slf4j javadocs, пов'язана вище, має приклад, коли вони використовують "реєстратор", а не "ЛОГЕР".

Це, звичайно, лише конвенції, а не правила. Якщо ви випадково використовуєте slf4j і хочете скористатися "реєстратором", тому що ви звикли до цього з інших фреймворків, або якщо це простіше вводити чи для читання, продовжуйте.

Мені подобається взяти на себе Google ( стиль Java Java )

Кожна константа є статичним кінцевим полем, але не всі статичні кінцеві поля є константами. Перш ніж вибирати постійний випадок, подумайте, чи справді поле відчуває себе постійним. Наприклад, якщо стан спостереження будь-якого з цих екземплярів може змінитися, це майже напевно не є постійною. Зазвичай, лише намірів ніколи не мутувати об'єкт, як правило, недостатньо.

Приклади:

// 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"};

Якщо ви використовуєте автоматизований інструмент для перевірки своїх стандартів кодування, і він порушує зазначені стандарти, то його або стандарти слід виправити. Якщо ви використовуєте зовнішній стандарт, виправте код.

Конвенція в Sun Java є великою літерою для публічних статичних констант. Очевидно, що реєстратор не є постійним, але являє собою предмет, що змінюється (інакше не було б сенсу викликати на нього методи з надією, що щось станеться); немає нестандартних кінцевих полів.

Якщо ви google це, ви можете виявити, що в деяких випадках реєстратори не визначаються як статичний остаточний. Додайте до цього кілька швидких копій-n-вставок, і це може пояснити це.

Ми використовуємо LOGGER у всьому своєму коді, і це відповідає нашій умові іменування (і наша CheckStyle задоволена цим).

Ми навіть йдемо далі, користуючись суворою конвенцією про іменування в Eclipse. Ми створюємо новий клас з кодовим шаблоном:

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

Реєстратор коментується, оскільки спочатку він нам не потрібен. Але якщо нам це буде потрібно пізніше, ми просто його відмежуємо.

Потім у коді ми використовуємо шаблони коду, які очікують, що цей реєстратор буде присутній. Приклад із шаблоном спроб улов:

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

У нас є ще кілька шаблонів, які ним користуються.

Суворі конвенції дозволяють нам бути більш продуктивними і узгоджуються з шаблонами коду .

Я особисто думаю, що це виглядає дуже великим у великій частині. Більше того, оскільки це клас, який безпосередньо не пов'язаний з поведінкою класу, я не бачу серйозної проблеми в використанні loggerзамість цього LOGGER. Але якщо ви будете суворо педантичні, тоді використовуйте LOGGER.

Не забувайте, що PMD поважатиме коментар

// NOPMD

в цьому. Це призведе до того, що PMD пропустить рядок зі своїх чеків, це дозволить вам вибрати будь-який стиль, який ви хочете.

Зазвичай константи знаходяться в великих літерах.

Однак реєстратори не повинні бути статичними, а шукати кожен "новий" клас, що містить, якщо використовується фасад slf4j. Це дозволяє уникнути деяких неприємних проблем із завантажувачем класів у особливо веб-контейнерах, а також дозволяє рамці реєстратора робити спеціальні речі залежно від контексту виклику.

Я віддаю перевагу "реєстратору", тобто нижньому регістру. Причина не в тому, що це постійна чи не константа (змінна чи незмінна). Якщо ми будемо використовувати це міркування, нам доведеться перейменувати змінну, якщо ми змінимо каркас ведення журналу (або якщо фреймворк змінить можливість зміни змінних журналів).

Для мене важливіші інші причини.

1. Реєстратор - це тіньовий об’єкт у класі і не повинен бути дуже помітним, оскільки він не реалізує основної логіки. Якщо ми використовуємо "LOGGER", це привернення уваги коду, що привертає занадто багато уваги.

2. Іноді реєстратори декларуються на рівні екземпляра (тобто не як статичні) і навіть вводяться як залежність. Я не хотів би змінювати свій код, якщо я вирішу змінити спосіб отримання реєстратора. Стабільність коду Wrt. ця (гіпотетична у багатьох випадках) зміна є іншою причиною, чому я віддаю перевагу нижній регістр.

Якщо ваші стандарти кодування - якщо у вас є такі - скажіть, що це повинно бути великими літерами, то так.

Я не бачу жодної суворої причини для того чи іншого шляху. Я думаю, це повністю залежить від ваших особистих симпатій, відповідно. стандарти кодування вашої компанії.

BTW: Я віддаю перевагу "LOGGER" ;-)