SonarQube规则squid:S1166误报咨询：工具类记异常仍触发违规

我之前也碰到过一模一样的情况！SonarQube抛出的「Either log or rethrow this exception」（通常对应规则java:S1166）违规提示，核心原因是它无法自动识别你自定义日志工具类的异常处理逻辑——它默认只认SLF4J、Logback、Log4j这类标准日志框架的直接调用。

下面给你几个可行的解决方案：

方案1：配置SonarQube，让它认可你的自定义日志方法 #

这是最彻底的解决方式，从规则层面告诉SonarQube：LogUtils.logErr是合法的异常处理方法。具体操作步骤：

• 登录SonarQube控制台，进入你的项目对应的Quality Profiles（质量规则集）
• 找到「Either log or rethrow this exception」规则（ID：java:S1166）
• 编辑该规则，在「Accepted logging methods」（认可的日志方法）列表中添加你的方法全限定名：

  your.package.path.LogUtils.logErr(java.lang.Throwable)
  

• 保存规则配置，重新扫描项目后，这个违规提示就会消失。

方案2：调整LogUtils的实现，让SonarQube能识别异常处理 #

如果不想改SonarQube配置，可以修改日志工具类的实现，让它的内部调用符合SonarQube的识别逻辑。比如改用标准日志框架的API来封装，确保异常被传递给日志框架：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class LogUtils {
    public static void logErr(Throwable e) {
        // 获取调用者的类信息，保持原有的日志上下文
        StackTraceElement[] ste = Thread.currentThread().getStackTrace();
        Class<?> callerClass;
        try {
            callerClass = Class.forName(ste[2].getClassName());
        } catch (ClassNotFoundException ex) {
            callerClass = LogUtils.class;
        }
        Logger logger = LoggerFactory.getLogger(callerClass);
        // 关键：将异常作为参数传递给日志框架的error方法
        logger.error("异常信息", e);
    }
}

这样SonarQube能检测到你在工具类内部调用了标准日志框架的异常记录方法，就不会再误判了。

方案3：临时忽略单个违规（不推荐） #

如果以上两种方式都暂时无法实施，可以在catch块中添加SonarQube的忽略注释，跳过该位置的检查：

catch (Exception e) {
    // NOSONAR: SonarQube无法识别自定义日志工具的异常处理逻辑
    LogUtils.logErr(e);
}

⚠️ 注意：这个方案是权宜之计，会让代码中留下特殊注释，长期来看不利于代码维护，建议优先用前两种方案。

为什么会出现这个误判？ #

SonarQube的java:S1166规则是检查：在catch块中，是否直接对异常做了「日志记录」或「重新抛出」的处理。你的LogUtils.logErr虽然内部做了日志记录，但SonarQube的静态代码分析无法深入到工具类内部判断逻辑，它只看到你在catch块里调用了一个自定义方法，没有直接处理异常，因此触发了违规提示。

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