解決 Java Checkstyle 錯誤：名稱 'logger' 必須匹配模式 '^[AZ][A-Z0-9]*(_[A-Z0-9]+)*$'

Question

使用 Eclipse Checkstyle 插件我看到這個錯誤：

名稱 'logger' 必須匹配模式'^[AZ][A-Z0-9]*(_[A-Z0-9]+)*$' 。

我通過更改解決了這個錯誤：

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

到

private static final Logger LOGGER = Logger.getLogger(someClass.class);

為什么這是一個 checkstyle 警告？

Answer 1

因為該字段被標記為final和static這意味着它是一個常量，應該用大寫字母命名。

從這個鏈接，您可以看到模塊ConstantName的格式為^[AZ][A-Z0-9]*(_[A-Z0-9]+)*$ ，這正是您的 Checkstyle 插件指定的格式。

Answer 2

如果您希望將logger保留為有效選項，則文檔建議使用此配置：

<module name="ConstantName">
  <property name="format"
    value="^log(ger)?$|^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$"/>
</module>