Question

我使用带有aspect-j注释支持的spring来允许@Loggable注释。这允许基于配置自动登录类。

我想知道我是否可以以某种方式使用此注释将slf4j Logger变量暴露给类以供直接使用，这样我就不必为此产生某些影响：

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

如果上面因为注释而隐式可用，那将是很好的，我可以在没有声明的情况下继续执行logger.debug("...");。我不确定这是否可能。

Answer 1

您可以使用由BeanPostProcessor为所有已创建的bean调用的ApplicationContext接口，以便您有机会填充相应的属性。

我创建了一个简单的实现，它可以做到：

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参数时错误的日志。

Answer 2

你不能用方面来做，但lombok可以帮助你，在我看来，优雅的方式。请参阅@Log注释。

Answer 3

我认为@Redder的解决方案是一种很好的方法。但是，我不想包含镜像库，因此我编写了一个使用Java反射库的LoggerPostProcessor实现。这是：

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

}

Answer 4

我想对@Redder的解决方案做一些改进。

首先 - 我们可以省略新注释@Log的引入，而不是我们可以使用Spring的@Autowired注释并将'required'标志设置为 '假'使春天不要检查是否注入了豆子（因为，我们稍后会注入它）。
第二 - 使用提供所有功能的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;

Answer 5

因为我试图在CDI （JSR 299：上下文和依赖注入），this link shows the straightforward way to do this using 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;

Answer 6

这是一篇博文，其中包含一个包含所有代码的完整示例：Injecting loggers using Spring

Answer 7

Herald 提供了一个非常简单的BeanPostProcessor，可以为您提供所有的魔力。你可以使用@Log注释来注释Spring bean的任何字段，让Herald在这个字段中注入合适的记录器。

支持的日志记录框架：

JavaTM 2平台的核心日志框架
Apache Commons Logging
Java简单日志外观（SLF4J）
SLF4J扩展记录器
的logback
Apache Log4j
Apache Log4j 2
JBoss Logging
Syslog4j
来自Graylog的Syslog4j fork
Fluent Logger for Java

还可以添加其他日志框架。

Github回购：https://github.com/vbauer/herald

使用java注释注入logger依赖项

7 个答案: