首页/开发/代码质量与评审速查/Checkstyle:Java 规范检查器
规范与静态检查65 条

Checkstyle:Java 规范检查器

Checkstyle 检查 Java 代码规范:内置 google_checks.xml 与 sun_checks.xml 预设,覆盖 Javadoc、命名、import 顺序、行宽等;可集成进构建。

预设google_checks.xml / sun_checks.xml
集成Maven / Gradle 插件,违规可失败构建
示例模块CyclomaticComplexity(默认阈值 10)

Gradle 片段

Gradle 片段
checkstyle {
    config = resources.text.fromFile("config/checkstyle/checkstyle.xml")
}
存量项目先裁剪规则集再逐步收紧,避免一次性上千条违规。

易错点

  • 直接套用 sun_checks 到存量项目:海量违规,团队失去信心
  • 与 spotless 格式规则冲突(缩进对齐等):需要对齐两侧配置

数据来源与参考

  • Checkstyle 官方文档(checkstyle.org)
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌