Использование Java-аннотации для внедрения зависимости от логгера - PullRequest
Новая
       17

Использование Java-аннотации для внедрения зависимости от логгера

27 голосов
/ 15 июня 2011

Я использую пружину с поддержкой аннотаций aspect-j, чтобы разрешить аннотацию @Loggable. Это позволяет автоматически регистрировать классы в зависимости от конфигурации.

Мне интересно, могу ли я каким-то образом использовать эту аннотацию, чтобы выставить переменную slf4j Logger в классе для непосредственного использования, чтобы мне не приходилось что-то делать с эффектом: 

Logger logger = LoggerFactory.getLogger(MyClass.class);

Было бы неплохо, если бы вышеприведенное было неявно доступно из-за аннотации, и я мог бы просто сделать logger.debug("..."); без объявления. Я не уверен, возможно ли это вообще.

Ответы [ 7 ]

21 голосов
/ 15 июня 2011

Вы можете использовать интерфейс BeanPostProcessor, который вызывается ApplicationContext для всех созданных bean-компонентов, поэтому у вас есть возможность заполнить соответствующие свойства.

Я создал простую реализацию, которая делаетчто: 

import java.lang.reflect.Field;
import java.util.List;

import net.vidageek.mirror.dsl.Mirror;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanPostProcessor;
import org.springframework.stereotype.Component;

@Component
public class LoggerPostProcessor implements BeanPostProcessor {

    @Override
    public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
        List<Field> fields = new Mirror().on(bean.getClass()).reflectAll().fields(); 
        for (Field field : fields) {
            if (Logger.class.isAssignableFrom(field.getType()) && new Mirror().on(field).reflect().annotation(InjectLogger.class) != null) {
                new Mirror().on(bean).set().field(field).withValue(LoggerFactory.getLogger(bean.getClass()));
            }
        }
        return bean;
    }

    @Override
    public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
        return bean;
    }
}

Вам не нужно выполнять какие-либо сложные шаги регистрации, поскольку ApplicationContext способен распознавать BeanPostProcessor экземпляров и автоматически их регистрировать.

@InjectLogger аннотация: 

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)
public @interface InjectLogger {
}

И тогда вы можете легко использовать аннотацию: 

public static @InjectLogger Logger LOGGER;

...

LOGGER.info("Testing message");

Я использовал библиотеку Зеркало , чтобы найти аннотированные поля, но, очевидно,вы можете выполнить поиск вручную, чтобы избежать этой дополнительной зависимости.

На самом деле это хорошая идея - избегать повторного кода и даже небольших проблем, возникающих при копировании и вставке определений Logger из других классов, напримеркогда мы забываем изменить параметр class, что приводит к неправильным журналам.

10 голосов
/ 15 июня 2011

Вы не можете сделать это с аспектом, но может помочь вам, на мой взгляд, элегантным способом. См. @ Log аннотация.

5 голосов
/ 08 марта 2015

Я хочу внести некоторые улучшения в решение @ Redder.

  • Первое - мы можем опустить введение новой аннотации @Log, вместо этого мы можем использовать аннотацию Spring * @Autowired с флагом 'required'установите значение false, чтобы Spring не проверял, был ли введен компонент или нет (потому что мы добавим его позже).
  • Второе - используйте API ReflectionUtils Spring, который предоставляет все необходимые методы для обнаружения и манипулирования полями, поэтому нам не нужны дополнительные внешние зависимости.

Вот пример (в Java8, но может быть переписано в Java 7/6 / etc., Также используется slf4j фасад, но его можно заменить любым другим регистратором): 

@Component
public class LoggerPostProcessor implements BeanPostProcessor {

    @Override
    public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {

        Logger logger = getLogger(bean.getClass());
        doWithFields(bean.getClass(), field -> {

            makeAccessible(field);
            setField(field, bean, logger);

        }, field -> field.isAnnotationPresent(Autowired.class) && Logger.class.equals(field.getType()));

        return bean;
    }
    ...
}
...
//logger injection candidate
@Autowired(required = false)
private Logger log;
5 голосов
/ 18 января 2013

Я думаю, что решение @Redder - отличный способ сделать это.Однако я не хотел включать библиотеку Mirror, поэтому я написал реализацию LoggerPostProcessor, которая вместо этого использует библиотеку отражения Java.Вот оно: 

package com.example.spring.postProcessor;

import com.example.annotation.InjectLogger;

import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
import java.util.Arrays;
import java.util.List;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanPostProcessor;
import org.springframework.stereotype.Component;

@Component
public class LoggerPostProcessor implements BeanPostProcessor {

    private static Logger logger = LoggerFactory.getLogger(LoggerPostProcessor.class);

    /* (non-Javadoc)
     * @see org.springframework.beans.factory.config.BeanPostProcessor#postProcessBeforeInitialization(java.lang.Object, java.lang.String)
     */
    @Override
    public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {

        List<Field> fields = Arrays.asList(bean.getClass().getDeclaredFields());

        for (Field field : fields) {
            if (Logger.class.isAssignableFrom(field.getType()) && field.getAnnotation(InjectLogger.class) != null) {

                logger.debug("Attempting to inject a SLF4J logger on bean: " + bean.getClass());

                if (field != null && (field.getModifiers() & Modifier.STATIC) == 0) {
                    field.setAccessible(true);
                    try {
                        field.set(bean, LoggerFactory.getLogger(bean.getClass()));
                        logger.debug("Successfully injected a SLF4J logger on bean: " + bean.getClass());
                    } catch (IllegalArgumentException e) {
                        logger.warn("Could not inject logger for class: " + bean.getClass(), e);
                    } catch (IllegalAccessException e) {
                        logger.warn("Could not inject logger for class: " + bean.getClass(), e);
                    }
                }
            }
        }

        return bean;
    }

    /* (non-Javadoc)
     * @see org.springframework.beans.factory.config.BeanPostProcessor#postProcessAfterInitialization(java.lang.Object, java.lang.String)
     */
    @Override
    public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
        return bean;
    }

}
2 голосов
/ 06 февраля 2013

Так как я получил это как первый результат при попытке сделать то же самое в CDI (JSR 299: Внедрение контекста и зависимости) , эта ссылка показывает простой способ сделать это используя CDI (а также альтернативу используя Spring):

В основном вам нужно только ввести: 

class MyClass {
   @Inject private Log log;

И у фабрики логгеров вот так: 

@Singleton
public class LoggerFactory implements Serializable {
    private static final long serialVersionUID = 1L;

    static final Log log = LogFactory.getLog(LoggerFactory.class);

   @Produces Log createLogger(InjectionPoint injectionPoint) {
    String name = injectionPoint.getMember().getDeclaringClass().getName(); 
    log.debug("creating Log instance for injecting into " + name); 
    return LogFactory.getLog(name);
    }   
}

Я обнаружил, что мне нужно добавить transient к введенному log, чтобы я не получил исключение пассивирующей области в моих bean-объектах сессионной области: 

@Named()
@SessionScoped()
public class MyBean implements Serializable {
    private static final long serialVersionUID = 1L;

    @Inject
    private transient Log log;
0 голосов
/ 26 февраля 2015

Herald предоставляет очень простой BeanPostProcessor, который делает всю магию за вас.Вы можете аннотировать любое поле bean-компонента Spring аннотацией @Log, чтобы Herald мог внедрить подходящий регистратор в это поле.

Поддерживаемые каркасы ведения журналов:

  • JavaTM 2Базовая платформа ведения журнала платформы
  • Apache Commons Logging
  • Простой фасад ведения журнала для Java (SLF4J)
  • SLF4J Расширенный регистратор
  • Logback
  • ApacheLog4j
  • Apache Log4j 2
  • JBoss Logging
  • Syslog4j
  • Вилка Syslog4j от Graylog
  • Fluent Logger для Java

Также можно добавить другие каркасы ведения журналов.

Github repo: https://github.com/vbauer/herald

0 голосов
/ 12 августа 2011

Вот сообщение в блоге, которое содержит полный пример со всем кодом: Внедрение регистраторов с использованием Spring

...