Внедрение конструктора Spring регистратора SLF4J – как получить целевой класс инъекции?

Вот альтернатива вашему решению. Вы можете достичь своей цели с реализацией BeanFactoryPostProcessor.

Предположим, вы хотите иметь класс с ведением журнала. Вот:

  package log;
  import org.apache.log4j.Logger;

  @Loggable
  public class MyBean {

     private Logger logger;
  }

Как вы могли видеть, этот класс ничего не делает и создан просто для простоты, чтобы быть контейнером регистратора. Единственная примечательная вещь здесь — аннотация @Loggable. Вот его исходный код:

package log;

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

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Loggable {
}

Эта аннотация является лишь маркером для дальнейшей обработки. А вот и самая интересная часть:

package log;

import org.apache.log4j.Logger;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;

import java.lang.reflect.Field;

public class LoggerBeanFactoryPostProcessor implements BeanFactoryPostProcessor{

    public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
        String[] names = beanFactory.getBeanDefinitionNames();
        for(String name : names){
            Object bean = beanFactory.getBean(name);
            if(bean.getClass().isAnnotationPresent(Loggable.class)){
                try {
                    Field field = bean.getClass().getDeclaredField("logger");
                    field.setAccessible(true);
                    field.set(bean, Logger.getLogger(bean.getClass()));
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        }
    }
}

Он просматривает все bean-компоненты и, если bean-компонент помечен как @Loggable, инициализирует свое личное поле с именем logger. Вы можете пойти еще дальше и передать некоторые параметры в аннотации @Loggable. Например, это может быть имя поля, соответствующего регистратору.

В этом примере я использовал Log4j, но я думаю, что он должен работать точно так же и с slf4j.

Я решил это с помощью пользовательского BeanFactory. Если кто-то предложит лучшее решение, буду рад его услышать. В любом случае, вот бобовая фабрика:

import java.util.Set;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.BeansException;
import org.springframework.beans.TypeConverter;
import org.springframework.beans.factory.config.DependencyDescriptor;
import org.springframework.beans.factory.support.DefaultListableBeanFactory;

public class CustomBeanFactory extends DefaultListableBeanFactory {

    public CustomBeanFactory() {
    }

    public CustomBeanFactory(DefaultListableBeanFactory delegate) {
        super(delegate);
    }

    @Override
    public Object resolveDependency(DependencyDescriptor descriptor,
            String beanName, Set<String> autowiredBeanNames,
            TypeConverter typeConverter) throws BeansException {
        //Assign Logger parameters if required      
        if (descriptor.isRequired()
                && Logger.class.isAssignableFrom(descriptor
                        .getMethodParameter().getParameterType())) {            
            return LoggerFactory.getLogger(descriptor.getMethodParameter()
                    .getDeclaringClass());
        } else {
            return super.resolveDependency(descriptor, beanName,
                    autowiredBeanNames, typeConverter);
        }
    }
}

Пример использования с конфигурацией XML:

        CustomBeanFactory customBeanFactory = new CustomBeanFactory();      
        GenericApplicationContext ctx = new GenericApplicationContext(customBeanFactory);
        XmlBeanDefinitionReader xmlReader = new XmlBeanDefinitionReader(ctx);
        xmlReader.loadBeanDefinitions(new ClassPathResource("beans.xml"));
        ctx.refresh();

РЕДАКТИРОВАТЬ:

Ниже вы можете найти улучшенную версию Arend v. Reinersdorffs (пояснение см. в комментариях).

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

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.BeansException;
import org.springframework.beans.TypeConverter;
import org.springframework.beans.factory.config.DependencyDescriptor;
import org.springframework.beans.factory.support.DefaultListableBeanFactory;
import org.springframework.core.MethodParameter;

public class CustomBeanFactory extends DefaultListableBeanFactory {

    public CustomBeanFactory() {
    }

    public CustomBeanFactory(DefaultListableBeanFactory delegate) {
        super(delegate);
    }

    @Override
    public Object resolveDependency(DependencyDescriptor descriptor,
            String beanName, Set<String> autowiredBeanNames,
            TypeConverter typeConverter) throws BeansException {
        //Assign Logger parameters if required      
        if (Logger.class == descriptor.getDependencyType()) {            
            return LoggerFactory.getLogger(getDeclaringClass(descriptor));
        } else {
            return super.resolveDependency(descriptor, beanName,
                    autowiredBeanNames, typeConverter);
        }
    }

    private Class<?> getDeclaringClass(DependencyDescriptor descriptor) {
        MethodParameter methodParameter = descriptor.getMethodParameter();
        if (methodParameter != null) {
            return methodParameter.getDeclaringClass();
        }
        Field field = descriptor.getField();
        if (field != null) {
            return field.getDeclaringClass();
        }
        throw new AssertionError("Injection must be into a method parameter or field.");
    }
}

Чтобы сделать ваш код более осведомленным о Spring, используйте InjectionPoint для определения регистраторов, то есть:

@Bean
@Scope("prototype")
public Logger logger(InjectionPoint ip) {
    return Logger.getLogger(ip.getMember().getDeclaringClass());
}

@Scope("prototype") необходим здесь для создания экземпляра bean-компонента 'logger' каждый раз, когда вызывается метод.

Попробуйте что-то вроде:

@Component
public class Example {

  @Autowired
  @Qualifier("exampleLogger")
  private final Logger logger;

}

А также:

<bean id="exampleLogger" class="org.slf4j.LoggerFactory" factory-method="getLogger">
  <constructor-arg type="java.lang.Class" value="package.Example"/>        
</bean>

1. Почему вы создаете новый регистратор для каждого экземпляра? Типичным шаблоном является наличие одного регистратора на класс (как частный статический член).

2. Если вы действительно хотите сделать это таким образом: может быть, вы можете написать класс фабрики регистратора и внедрить его? Что-то типа:

   @Singleton 
   public class LogFactory { 
       public Logger getLogger(Object o) {  
           return LoggerFactory.getLogger(o.getClass());  
       }  
   }
   

Да, вы идете не в том направлении. На вашем месте я бы внедрил LoggerFactory. Если вы хотите скрыть, что это slf4j, я бы определил интерфейс LoggerFactory и внедрил класс, который делегирует slf4j Logger.

public interface LoggerFactory {
    public Logger getLogger(Class<?> clazz);
}
...
import org.slf4j.LoggerFactory;
public class Slf4jLoggerFactory implements LoggerFactory {
    public Logger getLogger(Class<?> clazz) {
        return org.slf4j.LoggerFactory.getLogger(clazz);
    }
}

Однако, прежде чем вы отправитесь туда, это примерно то, что делает org.apache.commons.logging правильно? http://commons.apache.org/logging/

Вы используете журналы вместо регистраторов:

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
public class CLASS {
    private Log log = LogFactory.getLog(CLASS.class);
    ...

Затем Apache просматривает путь к классам, чтобы увидеть, есть ли у вас log4j или другие, и делегирует «лучший», который он находит. Slf4j заменяет log4j в пути к классам, поэтому, если он загружен (и исключен apache log4j), ведение журнала общих ресурсов будет делегировано ему вместо этого.

Начиная с Spring 4.3.0 вы можете использовать InjectionPoint или DependencyDescriptor в качестве параметров для методов создания компонентов:

@Component
public class LoggingFactoryBean {
    @Bean
    public Logger logger(InjectionPoint injectionPoint) {
        Class<?> targetClass = injectionPoint.getMember().getDeclaringClass();
        return LoggerFactory.getLogger(targetClass);
    }
}

Я пытаюсь включить эту функцию в официальный API SLF4J. Пожалуйста, поддержите/голосуйте/внесите свой вклад: https://issues.jboss.org/browse/JBLOGGING-62

(эта функция уже реализована JBoss Logging + Seam Solder, см. http://docs.jboss.org/seam/3/latest/reference/en-US/html/solder-logging.html)

11.4. Собственный API регистратора

Вы также можете внедрить старый добрый Logger (из JBoss Logging API):

import javax.inject.Inject;
import org.jboss.logging.Logger;

public class LogService {

    @Inject
    private Logger log;

    public void logMessage() {
        log.info("Hey sysadmins!");
    }

}

Сообщения журнала, созданные из этого регистратора, будут иметь категорию (имя регистратора), равную полному имени класса класса реализации компонента. Вы можете указать категорию явно, используя аннотацию.

@Inject @Category("billing")
private Logger log;

Вы также можете указать категорию, используя ссылку на тип:

@Inject @TypedCategory(BillingService.class)
private Logger log;

Извините, что не предоставил соответствующий ответ.