如何配置Checkstyle检测Log4j日志字符串格式错误

要禁止日志语句中使用%s格式化符、强制使用SLF4J风格的{}占位符，可以通过Checkstyle的RegexpSinglelineJava规则实现，具体配置步骤如下：

配置规则 #

在你的Checkstyle配置文件（通常是checkstyle.xml）中添加以下模块：

<module name="RegexpSinglelineJava">
  <!-- 匹配LOGGER的常见日志方法调用，且参数包含%s的情况 -->
  <property name="format" value="LOGGER\.(info|warn|error|debug|trace)\(.*%s.*\);"/>
  <!-- 违规提示信息 -->
  <property name="message" value="禁止在日志语句中使用%s格式化符，请改用SLF4J标准的{}占位符"/>
  <!-- 违规级别：ERROR表示直接报错，可根据需求改为WARN -->
  <property name="severity" value="ERROR"/>
</module>

规则说明 #

• RegexpSinglelineJava：Checkstyle内置的单行Java代码正则匹配规则，专门用于检测单行代码中的特定模式。
• format正则：
  • LOGGER：匹配你的日志实例变量名，如果项目中用LOG/LOG_TAG等其他命名，可修改为(LOGGER|LOG|LOG_TAG)覆盖更多场景。
  • (info|warn|error|debug|trace)：覆盖常用的日志级别方法。
  • .*%s.*：匹配日志字符串中包含%s的情况。
• severity：设为ERROR会让Checkstyle在检测到违规时直接抛出错误，设为WARN则仅给出警告提示。

适配场景 #

该规则适用于所有遵循SLF4J规范的日志框架（如Logback、适配SLF4J的Log4j2），这类框架原生支持{}占位符，使用%s不仅不符合规范，还可能导致日志格式化异常。

内容的提问来源于stack exchange，提问作者Andrei Berenda