是否应在大写字母中声明“静态最终记录器”？

在Java中，静态最终变量是常量，并且约定应使用大写形式。但是，我已经看到大多数人以小写形式声明记录器，这在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;

为了给Crunchdog的答案增加更多价值，《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，第二版开始，

先前规则的唯一例外是“常量字段”，其名称应包含一个或多个大写单词，并用下划线字符分隔，例如VALUES或NEGATIVE_INFINITY。常量字段是静态最终字段，其值是不可变的。如果静态的final字段具有原始类型或不可变的引用类型（第15项），则它是一个常量字段。例如，枚举常量是常量字段。如果静态最终字段具有可变的引用类型，但如果引用的对象是不可变的，则它仍可以是常量字段。

总而言之，常量==静态最终形式，加上引用（相对于简单类型）的不变性。

查看slf4j记录器，http： //www.slf4j.org/api/org/slf4j/Logger.html

这是一成不变的。另一方面，JUL记录器是可变的。log4j记录器也是可变的。因此正确的是，如果您使用的是log4j或JUL，则应为“ logger”，如果您使用的是slf4j，则应为LOGGER。

请注意，上面链接的slf4j javadocs页面有一个示例，其中他们使用“ logger”，而不是“ LOGGER”。

这些当然只是约定，不是规则。如果您碰巧正在使用slf4j，并且您想使用“记录器”，因为您已经习惯了其他框架，或者如果键入起来更容易，或者出于可读性考虑，请继续。

我喜欢Google的支持（Google Java Style）

每个常量都是一个静态最终字段，但并非所有静态最终字段都是常量。选择常量大小写之前，请考虑该字段是否真的像常量。例如，如果该实例的可观察状态中的任何一个可以更改，那么几乎可以肯定它不是常数。仅企图从不改变对象通常是不够的。

例子：

// 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容器中出现一些令人讨厌的类加载器问题，此外，它还允许logger框架根据调用上下文执行特殊的操作。

我更喜欢“ logger”，即小写。原因不是它是一个常数还是一个常数（可变或不可变）。如果使用该推理，则如果我们更改日志记录框架（或者如果框架更改记录器的可变性），则必须重命名变量。

对我来说，其他原因更为重要。

1. 记录器是类中的影子对象，不应突出显示，因为它未实现主要逻辑。如果我们使用“ LOGGER”，那么它在代码中就非常吸引眼球。

2. 有时，记录器是在实例级别声明的（即不是静态的），甚至被注入为依赖项。如果我决定更改获取记录器的方式，则我不想更改代码。代码稳定性。这种（在许多情况下都是假设的）更改是我更喜欢小写字母的另一个原因。

如果您的编码标准-如果有的话-说它应该是大写的，那么可以。

我看不出任何一种严格的理由可以选择一种方法。我认为这完全取决于您的个人喜好。您公司的编码标准。

顺便说一句：我更喜欢“ LOGGER” ;-)