web-dev-qa-db-ja.com

Javaアノテーションを使用してロガー依存関係を挿入する

_@Loggable_アノテーションを可能にするために、アスペクト-jアノテーションサポート付きのSpringを使用しています。これにより、構成に基づいてクラスの自動ロギングが可能になります。

このアノテーションを何らかの方法で使用して、直接使用するためにslf4j Logger変数をクラスに公開できるかどうか疑問に思っています。これにより、次のような影響を与える必要がなくなります。

_Logger logger = LoggerFactory.getLogger(MyClass.class);
_

注釈のために上記が暗黙的に利用可能で、宣言なしでlogger.debug("...");を実行できればいいのですが。これが可能かどうかはわかりません。

javaspringannotationsslf4j
28
mlo

作成されたすべてのBeanに対してBeanPostProcessorによって呼び出される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定義をコピーして貼り付けることで生じる小さな問題でさえ、これはいい考えです。間違ったログ。

21
Redder

アスペクトでそれを行うことはできませんが、 lombok は、私の意見では、エレガントな方法であなたを助けることができます。 @ Log アノテーションを参照してください。

10
sinuhepop

@Redderのソリューションを改善したい。

  • まず、新しいアノテーションの導入を省略できます@Log、代わりにSpringの@Autowiredアノテーションが 'required'フラグを 'false'に設定して、SpringがBeanが注入されたかどうかをチェックしないようにします（後で注入するため）。
  • 2番目-フィールドの検出と操作に必要なすべてのメソッドを提供するSpringのReflectionUtils AP​​Iを使用するため、追加の外部依存関係は必要ありません。

ここでは例（Java 8ですが、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
nndru

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

}
5
FGreg

CDI（JSR 299：Context and Dependency Injection）で同じことをしようとしたときに最初の結果としてこれを取得したので、 このリンクは、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);
    }   
}

セッションスコープBeanでパッシベーションスコープ例外が発生しないように、注入されたtransientにlogを追加する必要があることがわかりました。

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

    @Inject
    private transient Log log;
2
peater

Heraldは、すべての魔法を実行する非常にシンプルなBeanPostProcessorを提供します。 Spring Beanの任意のフィールドに@Logアノテーションを付けて、Heraldに適切なロガーをこのフィールドに挿入させることができます。

サポートされているロギングフレームワーク：

  • JavaTM 2プラットフォームのコアロギングフレームワーク
  • Apache Commons Logging
  • Java（SLF4J）のシンプルなロギングファサード
  • SLF4J拡張ロガー
  • ログバック
  • Apache Log4j
  • Apache Log4j 2
  • JBossロギング
  • Syslog4j
  • GraylogのSyslog4jフォーク
  • Fluent Logger for Java

他のロギングフレームワークを追加することも可能です。

Githubリポジトリ： https://github.com/vbauer/herald

0
Vladislav Bauer

以下は、すべてのコードを含む完全な例を含むブログ投稿です。 Springを使用したロガーの挿入

0
Aaron Digulla