sbt-scoverage 排除机制实战3 招精准跳过类、包与文件【免费下载链接】sbt-scoveragesbt plugin for scoverage项目地址: https://gitcode.com/gh_mirrors/sb/sbt-scoverage想知道如何让sbt-scoverage 排除掉那些不需要统计的代码吗在 Scala 项目中接入sbt-scoverage覆盖率插件后生成的报告常常混入自动生成的类、样板代码或第三方桥接文件导致覆盖率数字失真。其实这个插件的排除机制非常灵活只需 3 个技巧就能精准跳过类、包与文件让报告只反映你真正关心的业务代码。本文将用最少的代码带你一次掌握全部排除玩法。先搞清楚sbt-scoverage 排除机制是怎么运作的sbt-scoverage 是 Scala 生态最流行的覆盖率插件支持 Scala 2.12 / 2.13 / 3它通过编译器插件对字节码插桩来统计语句与分支的覆盖情况。排除Exclusion发生在插桩阶段被排除的代码根本不会被埋点也就不会出现在任何报告中。所有排除规则都定义在插件的配置键中源码见src/main/scala/scoverage/ScoverageKeys.scala配置键作用匹配对象coverageExcludedPackages排除包或类类的全限定名coverageExcludedFiles排除文件或目录源文件路径$COVERAGE-OFF$注释排除代码片段注释包裹的源码区间三条规则都用正则表达式匹配多个规则之间用英文分号;分隔。注意正则必须完整匹配目标字符串才会生效不是部分匹配。第 1 招用 coverageExcludedPackages 一键排除整个包最常用的场景是把模型层、生成代码、工具包整体移出统计。在build.sbt中这样配置coverageExcludedPackages : empty;Reverse.*;.*AuthService.*;models\\.data\\..*这条规则拆开看empty排除默认包无 package 声明的类Reverse.*排除以 Reverse 开头的类.*AuthService.*排除名字中含 AuthService 的类models\\.data\\..*排除models.data包下的所有类插件源码中的处理逻辑见src/main/scala/scoverage/ScoverageSbtPlugin.scala它会把该值原样拼进编译器参数-P:scoverage:excludedPackages:。官方测试用例src/sbt-test/scoverage/coverage-excluded-packages/展示了验证方式排除后报告目录中不再生成对应包的 HTML 文件。 小提示正则中的.要转义成\\.*要写成.*否则会匹配到意料之外的内容。第 2 招用 coverageExcludedFiles 按路径排除文件当你想跳过某个具体文件或某个目录时用coverageExcludedFiles更直观——它匹配的是源文件路径coverageExcludedFiles : .*\\/two\\/GoodCoverage;.*\\/three\\/.*.*\\/two\\/GoodCoverage排除two/GoodCoverage.scala文件.*\\/three\\/.*排除three目录下的所有文件两个关键细节不要带.scala扩展名规则直接匹配去掉扩展名后的路径匹配的是以/分隔的路径字符串在正则里要写成\\/。插件在 Windows 下还会自动把/替换为\\见ScoverageSbtPlugin.scala中的处理逻辑所以跨平台写\\/最稳妥。官方测试用例参考src/sbt-test/scoverage/coverage-excluded-files/其中build.sbt正是用了上面这条规则并断言报告目录中不存在被排除文件的页面。第 3 招用 COVERAGE-OFF 注释跳过指定代码段如果只想跳过某个方法或某段脏代码不必动用文件级规则。在源码里用注释标记即可def legacyParser(raw: String): Int { // $COVERAGE-OFF$这段是历史遗留代码暂不纳入统计 val tokens raw.split(,) var acc 0 for (t - tokens) acc t.toInt acc // $COVERAGE-ON$ }// $COVERAGE-OFF$与// $COVERAGE-ON$之间的所有代码都不会被插桩也不会进入覆盖率报告。这是按代码区间排除的唯一方式适合临时豁免、历史遗留代码或与测试无关的初始化逻辑。⚠️ 注意注释排除目前仅适用于 Scala 2Scala 3 项目请改用前两招。版本与平台不同 Scala 版本的排除能力差异排除能力并非所有版本一视同仁这点最容易踩坑排除方式Scala 2Scala 33.2Scala 33.3.4 / 3.4.2coverageExcludedPackages✅❌ 需升级✅coverageExcludedFiles✅❌ 需升级✅$COVERAGE-OFF$注释✅❌❌在旧版 Scala 3 上配置排除规则会静默失效插件会给出 warning 日志代码仍会被统计。判断逻辑见ScoverageSbtPlugin.scala中的isScala3SupportingFilePackageExclusion方法。如果你用的是 Scala 3请确保版本不低于 3.3.4 或 3.4.2。此外Scala.js 与 Scala Native 目前仅支持 Scala 2。总结一张表记住 3 招排除技巧想排除什么用什么示例整个包 / 指定类coverageExcludedPackagesmodels\\..*;Reverse.*指定文件 / 目录coverageExcludedFiles.*\\/generated\\/.*方法内的一段代码$COVERAGE-OFF$注释见上文示例掌握这 3 招之后你就能让 sbt-scoverage 报告精准聚焦业务代码配合coverageFailOnMinimum与coverageMinimumStmtTotal等最低覆盖率门槛把覆盖率检查真正变成团队的质量闸门。记住核心口诀排除包看全限定名排除文件看路径排除片段看注释Scala 3 记得升级版本。赶快在你的build.sbt里试试吧【免费下载链接】sbt-scoveragesbt plugin for scoverage项目地址: https://gitcode.com/gh_mirrors/sb/sbt-scoverage创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
