「静的な最終ロガー」は大文字で宣言する必要がありますか？

Javaでは、静的なfinal変数は定数であり、慣習として、それらは大文字でなければなりません。しかし、ほとんどの人がロガーを小文字で宣言し、それがPMDの違反として現れるのを見てきました。

例えば：

private static final Logger logger = Logger.getLogger(MyClass.class);

googleまたはSOで「静的な最終ロガー」を検索すると、これが表示されます。

代わりにLOGGERを使用する必要がありますか？

ロガー参照は定数ではなく、最終的な参照であり、大文字であってはなりません。定数VALUEは大文字でなければなりません。

private static final Logger logger = Logger.getLogger(MyClass.class);

private static final double MY_CONSTANT = 0.0;

クランチドッグの答えにさらに価値を追加するために、Javaコーディングスタイルガイドでは、3.3項でこれを述べています

定数として使用されるフィールドの名前は、すべて大文字で、アンダースコアで単語を区切る必要があります。以下は定数と見なされます。

1. すべてのstatic finalプリミティブタイプ（すべてのインターフェイスフィールドは本質的にであることを忘れないでくださいstatic final）。
2. static final" ."（ドット）が後に続かないすべてのオブジェクト参照タイプ。
3. static final" ["（開き角括弧）が後に続かないすべての配列。

例：

MIN_VALUE, MAX_BUFFER_SIZE, OPTIONS_FILE_NAME

この規則に従って、loggerはstatic finalポイント2で述べたオブジェクト参照ですが、使用するたびに" " が続くため.、定数と見なすことができず、小文字にする必要があります。

効果的なJavaから、第2版、

前のルールの唯一の例外は、「定数フィールド」に関するもので、その名前は、下線文字で区切られた1つ以上の大文字の単語（たとえば、VALUESまたはNEGATIVE_INFINITY）で構成される必要があります。定数フィールドは、値が不変である静的な最終フィールドです。静的最終フィールドがプリミティブ型または不変参照型（アイテム15）を持っている場合、それは定数フィールドです。たとえば、列挙型定数は定数フィールドです。静的なfinalフィールドに変更可能な参照型がある場合でも、参照されるオブジェクトが不変であれば、それは定数フィールドである可能性があります。

要約すると、定数==静的な最終、および参照（単純型に対して）の場合、不変性。

slf4jロガーを見ると、 http：//www.slf4j.org/api/org/slf4j/Logger.html

それは不変です。一方、JULロガーは変更可能です。log4jロガーも変更可能です。つまり、正しいことは、log4jまたはJULを使用している場合は「ロガー」であり、slf4jを使用している場合はLOGGERです。

上記のslf4j javadocsページには、「LOGGER」ではなく「logger」を使用する例があることに注意してください。

もちろん、これらは規則のみであり規則ではありません。たまたまslf4jを使用していて、他のフレームワークに慣れているために「ロガー」を使用したい場合、またはタイプしやすく、読みやすくする場合は、先に進んでください。

私はグーグルがそれを引き受けるのが好きです（グーグルJavaスタイル）

すべての定数は静的最終フィールドですが、すべての静的最終フィールドが定数であるとは限りません。定数のケースを選択する前に、フィールドが本当に定数のように感じるかどうかを検討してください。たとえば、そのインスタンスの監視可能な状態のいずれかが変化する可能性がある場合、それはほぼ確実に定数ではありません。オブジェクトを変更しないことを意図するだけでは、通常は十分ではありません。

例：

// Constants
static final int NUMBER = 5;
static final ImmutableList<String> NAMES = ImmutableList.of("Ed", "Ann");
static final Joiner COMMA_JOINER = Joiner.on(',');  // because Joiner is immutable
static final SomeMutableType[] EMPTY_ARRAY = {};
enum SomeEnum { ENUM_CONSTANT }

// Not constants
static String nonFinal = "non-final";
final String nonStatic = "non-static";
static final Set<String> mutableCollection = new HashSet<String>();
static final ImmutableSet<SomeMutableType> mutableElements = ImmutableSet.of(mutable);
static final Logger logger = Logger.getLogger(MyClass.getName());
static final String[] nonEmptyArray = {"these", "can", "change"};

自動化ツールを使用してコーディング標準をチェックしていて、それが上記の標準に違反している場合は、それまたは標準を修正する必要があります。外部標準を使用している場合は、コードを修正します。

Sun Javaの規則は、パブリック静的定数の大文字です。明らかに、ロガーは一定ではありませんが、変更可能なものを表します（それ以外の場合、何かが起こることを期待して、ロガーのメソッドを呼び出す意味はありません）。非定数の最終フィールドに特定の標準はありません。

これをググると、ロガーが静的ファイナルとして定義されていない場合があります。これに簡単なコピーアンドペーストを追加してください。これで説明が付くかもしれません。

すべてのコードでLOGGERを使用しており、これは命名規則に対応しています（そして、CheckStyleはこれに満足しています）。

さらに進んで、Eclipseの厳密な命名規則を利用しています。次のコードテンプレートを使用して新しいクラスを作成します。

    // private static final Logger LOGGER = Logger.getLogger(${enclosing_type}.class);

ロガーはコメントアウトされています。最初は必要ありません。しかし、後で必要になった場合は、コメントを外します。

次に、コードでは、このロガーが存在することを期待するコードテンプレートを使用します。try-catchテンプレートの例：

    try {
      ${cursor} or some other template
    } catch (Exception t) {
      LOGGER.error("${methodName} ${method parameters}", t);
    }

それを使用するテンプレートがいくつかあります。

厳格な規則は、私たちはより生産とコードテンプレートとコヒーレントことを可能にします。

個人的には大文字で見ると本当に大きいと思います。また、クラスの振る舞いに直接関係しないクラスなので、のlogger代わりに使うことに大きな問題はないと思いますLOGGER。ただし、厳密に知識を深める場合は、を使用しますLOGGER。

PMDはコメントを尊重することを忘れないでください

// NOPMD

初期化。これにより、PMDはその行をチェックからスキップします。これにより、必要なスタイルを選択できます。

通常、定数は大文字です。

ただし、ロガーは静的である必要はありませんが、slf4jファサードを使用している場合は、包含クラスのすべての「新規」を探します。これにより、特にWebコンテナーでの厄介なクラスローダーの問題がいくつか回避され、さらに、ロガーフレームワークが呼び出しコンテキストに応じて特別な処理を実行できるようになります。

私は「ロガー」、つまり小文字を好みます。その理由は、それが定数または定数ではない（可変または不変）ことではありません。その推論を使用する場合、ロギングフレームワークを変更する場合（またはフレームワークがロガーの可変性を変更する場合）は、変数の名前を変更する必要があります。

私にとっては、他の理由がより重要です。

1. ロガーはクラスのシャドウオブジェクトであり、メインロジックを実装していないため、あまり目立たないはずです。「LOGGER」を使用する場合、それはあまりにも注目を集めるコードの目印です。

2. ロガーはインスタンスレベルで宣言される場合があり（つまり、静的ではない）、依存関係として挿入されることもあります。ロガーの入手方法を変更する場合は、コードを変更したくありません。コードの安定性について。この（多くの場合は架空の）変更が、小文字を好むもう1つの理由です。

コーディング標準がある場合-ある場合は-大文字にする必要があると言います。

どちらにしても厳しい理由は見当たらない。私はそれはあなたの個人的ないいねレスポンスに完全に依存すると思います。会社のコーディング標準。

ところで：私は「ロガー」を好む;-)