Использование аннотации java для инъекции зависимости журнала

Ответ 1

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

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

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");

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

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

Ответ 2

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

Ответ 3

Я думаю, что решение от @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;
    }

}

Ответ 4

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

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

Здесь пример (в Java 8, но может быть переписан в Java 7/6/и т.д., используется также 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

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

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

class MyClass {
   @Inject private Log log;

И пусть у вас есть logger factory:

@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, чтобы я не получал исключение пассивной области в моем сеансе beans:

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

    @Inject
    private transient Log log;

Ответ 6

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

Ответ 7

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

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

• Платформа ядра для платформы JavaTM 2
• Журнал регистрации Apache
• Простой ведение журнала для Java (SLF4J)
• SLF4J Расширенный журнал
• Logback
• Apache Log4j
• Apache Log4j 2
• Ведение журнала JBoss
• Syslog4j
• Syslog4j fork от Graylog
• Свободный регистратор для Java

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

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