Java logging: как вы объявляете log-поле в классе

Question

[relgames]

Есть 2 основных способа объявить log-поле в своем классе:

private static final Logger log = LoggerFactory.getLogger(ClassName.class);

или

private final Logger log = LoggerFactory.getLogger(this.getClass());

Я обычно использую второй способ — меньше ошибок при рефакторинге (например, классы переименовали, а log-поле забыли). Но вот задумался — может, есть какие-то недостатки такого подхода, которые я не вижу?

А какой подход используете вы?

Comments

[relgames]

UPD: нашел замечательную статью slf4j.org/faq.html#declared_static
Вкратце, если вы шарите свои классы между различными приложениями (например, общие классы для 2х WAR приложений), то лучше использовать non-static поле

Answer 1

[sergei-grigorev]

Использую первый способ, специально для этого в Intellij IDEA сделал макрос. Специально для того, чтобы даже если класс потом кем-то отнаследуется, лог все равно привязывался к конкретному классу и было легче найти строчку, где сообщение было сгенерировано.

private static final org.slf4j.Logger LOGGER =
org.slf4j.LoggerFactory.getLogger($CLASS_NAME$.class.getName());

Comments

[relgames]

Про макросы не знал, спасибо!

Answer 2

[Lendon]

Logger обьявляется для класса, соответственно нужно использовать модификатор уровня класса — static. Т.е. мне кажется первый вариант правильнее.
Для обьявления логгера использую шаблон в eclipse:

${:import(org.slf4j.Logger, org.slf4j.LoggerFactory)}
private static final Logger log = LoggerFactory.getLogger(${primary_type_name}.class);

Comments

[Lendon]

Да, и если кто не знает как добавить шаблон:
Windows — Preferences — Java — Editor — Templates — New

Answer 3

[MikeMirzayanov]

Такое хорошо протягивать через DI, а объявление делать в таком стиле:

@InjectLogger
private Logger logger;

Answer 4

[relgames]

slf4j.org/faq.html#declared_static

Answer 5

[barker]

Конечно, первый способ. А при рефакторинге это в какой это IDE не переименуется и в объявлении имя? Да и как его можно забыть тем более, если компилироваться перестанет? Не понимаю…

Comments

[relgames]

Ну вот тупо копи-пастом скопировал строчку с логгером в другой класс, а поменять забыл.
Сам видел в нескольких проектах — у класса одно название, у логгера — другое.

Answer 6

[png]

Однозначно первый для большинства случаев.
если рефакторить при помощи той же idea, которая умеет заменять название класса во всех местах, где он используется. Заменяет даже в комментариях и не java-файлах.

второй подход не верен, если не понимать разницы. Так как не рационально используются ресурсы (и память, и процессор) подумайте, вы для каждого объекта создаете его собственный объект Logger. Он будет создаваться при создании объекта, уничтожаться уничтожении основного объекта.

Оно вам надо?

Comments

[relgames]

Создание объекта зависит от используемой реализации LoggerFactory. Но в целом я согласен, у меня были подобные сомнения. Сам раньше использовал первый подход, но в одном из проектов на работе наткнулся на кашу из логгеров — видно, копи-пастом вставляли строчки; решил писать через не-static поле, чтобы не повторять ошибок. Но это все потому, что не знал про макросы :)

[png]

Хорошо, не создание, а ссылка то будет храниться внутри объекта. а если у вас их миллион?

[png]

На счет макроса, не думаю что надо туда это помещать, не в каждом объекте оно надо. не все объекты следует логировать.

[relgames]

Пихать логгирование в объекты, которых миллион — не очень хорошая идея :) Но я уже сверху написал, что есть специфические случаи, когда без non-static логгера не обойтись. В целом меня убедили, что лучше использовать static поле, так что вопрос решен :)

Answer 7

[mark_stein]

Я тоже использую первый вариант, вот только до сих пор мучаюсь — прописывать имя переменной маленькими буквами 'log' или большими 'LOG' — по правилам константы надо большими, а так не хочется.

Comments

[relgames]

stackoverflow.com/questions/1417190/should-a-static-final-logger-be-declared-in-upper-case