CodeQL提示缺失Override注解但已添加，如何在GitHub Actions中绕过？

问题背景 #

你通过Lombok的@Getter(onMethod_ = {@Override})注解实现了对abstractEntity.canEqual方法的重写，该写法已隐式包含@Override语义，但CodeQL仍触发以下告警：

Missing Override annotation.
This method overrides abstractEntity.canEqual; it is advisable to add an Override annotation.

同时IntelliJ IDEA 2023的代码检查工具会提示移除显式添加的@Override注解，方法本身运行正常，需要在GitHub Actions中绕过该误报。

解决方案 #

1. 代码内添加CodeQL忽略注释

直接在受影响的类或方法上方添加CodeQL忽略注释，精准屏蔽该告警：

// codeql[ignore=missing-override-annotation]
@Getter(onMethod_ = {@Override})
public class YourConcreteEntity extends AbstractEntity {
    // 类实现代码
}

2. 在GitHub Actions工作流中全局排除该查询

修改.github/workflows/codeql.yml文件，在analyze步骤中排除missing-override-annotation规则：

jobs:
  analyze:
    steps:
      # 其他步骤略
      - name: Perform CodeQL Analysis
        uses: github/codeql-action/analyze@v3
        with:
          queries: security-and-quality, -java/missing-override-annotation

这种方式会全局禁用该规则，适合项目中存在大量类似Lombok写法的场景。

3. 自定义CodeQL查询配置（可选）

如果项目使用自定义CodeQL查询集，可在qlpack.yml中添加规则排除：

exclude:
  - java/missing-override-annotation

注意事项 #

• 忽略告警前务必确认方法确实正确重写了父类的canEqual方法，避免因屏蔽告警遗漏真实的重写错误
• 优先使用代码内注释的方式，仅针对特定问题屏蔽，不影响其他代码的规则检查

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