制實戰(zhàn)：3 招精準(zhǔn)跳過類、包與文件)
sbt-scoverage 排除機(jī)制實戰(zhàn)3 招精準(zhǔn)跳過類、包與文件【免費下載鏈接】sbt-scoveragesbt plugin for scoverage項目地址: https://gitcode.com/gh_mirrors/sb/sbt-scoverage想知道如何讓sbt-scoverage 排除掉那些不需要統(tǒng)計的代碼嗎在 Scala 項目中接入sbt-scoverage覆蓋率插件后生成的報告常?；烊胱詣由傻念悺影宕a或第三方橋接文件導(dǎo)致覆蓋率數(shù)字失真。其實這個插件的排除機(jī)制非常靈活只需 3 個技巧就能精準(zhǔn)跳過類、包與文件讓報告只反映你真正關(guān)心的業(yè)務(wù)代碼。本文將用最少的代碼帶你一次掌握全部排除玩法。先搞清楚sbt-scoverage 排除機(jī)制是怎么運作的sbt-scoverage 是 Scala 生態(tài)最流行的覆蓋率插件支持 Scala 2.12 / 2.13 / 3它通過編譯器插件對字節(jié)碼插樁來統(tǒng)計語句與分支的覆蓋情況。排除Exclusion發(fā)生在插樁階段被排除的代碼根本不會被埋點也就不會出現(xiàn)在任何報告中。所有排除規(guī)則都定義在插件的配置鍵中源碼見src/main/scala/scoverage/ScoverageKeys.scala配置鍵作用匹配對象coverageExcludedPackages排除包或類類的全限定名coverageExcludedFiles排除文件或目錄源文件路徑$COVERAGE-OFF$注釋排除代碼片段注釋包裹的源碼區(qū)間三條規(guī)則都用正則表達(dá)式匹配多個規(guī)則之間用英文分號;分隔。注意正則必須完整匹配目標(biāo)字符串才會生效不是部分匹配。第 1 招用 coverageExcludedPackages 一鍵排除整個包最常用的場景是把模型層、生成代碼、工具包整體移出統(tǒng)計。在build.sbt中這樣配置coverageExcludedPackages : empty;Reverse.*;.*AuthService.*;models\\.data\\..*這條規(guī)則拆開看empty排除默認(rèn)包無 package 聲明的類Reverse.*排除以 Reverse 開頭的類.*AuthService.*排除名字中含 AuthService 的類models\\.data\\..*排除models.data包下的所有類插件源碼中的處理邏輯見src/main/scala/scoverage/ScoverageSbtPlugin.scala它會把該值原樣拼進(jìn)編譯器參數(shù)-P:scoverage:excludedPackages:。官方測試用例src/sbt-test/scoverage/coverage-excluded-packages/展示了驗證方式排除后報告目錄中不再生成對應(yīng)包的 HTML 文件。 小提示正則中的.要轉(zhuǎn)義成\\.*要寫成.*否則會匹配到意料之外的內(nèi)容。第 2 招用 coverageExcludedFiles 按路徑排除文件當(dāng)你想跳過某個具體文件或某個目錄時用coverageExcludedFiles更直觀——它匹配的是源文件路徑coverageExcludedFiles : .*\\/two\\/GoodCoverage;.*\\/three\\/.*.*\\/two\\/GoodCoverage排除two/GoodCoverage.scala文件.*\\/three\\/.*排除three目錄下的所有文件兩個關(guān)鍵細(xì)節(jié)不要帶.scala擴(kuò)展名規(guī)則直接匹配去掉擴(kuò)展名后的路徑匹配的是以/分隔的路徑字符串在正則里要寫成\\/。插件在 Windows 下還會自動把/替換為\\見ScoverageSbtPlugin.scala中的處理邏輯所以跨平臺寫\\/最穩(wěn)妥。官方測試用例參考src/sbt-test/scoverage/coverage-excluded-files/其中build.sbt正是用了上面這條規(guī)則并斷言報告目錄中不存在被排除文件的頁面。第 3 招用 COVERAGE-OFF 注釋跳過指定代碼段如果只想跳過某個方法或某段臟代碼不必動用文件級規(guī)則。在源碼里用注釋標(biāo)記即可def legacyParser(raw: String): Int { // $COVERAGE-OFF$這段是歷史遺留代碼暫不納入統(tǒng)計 val tokens raw.split(,) var acc 0 for (t - tokens) acc t.toInt acc // $COVERAGE-ON$ }// $COVERAGE-OFF$與// $COVERAGE-ON$之間的所有代碼都不會被插樁也不會進(jìn)入覆蓋率報告。這是按代碼區(qū)間排除的唯一方式適合臨時豁免、歷史遺留代碼或與測試無關(guān)的初始化邏輯。?? 注意注釋排除目前僅適用于 Scala 2Scala 3 項目請改用前兩招。版本與平臺不同 Scala 版本的排除能力差異排除能力并非所有版本一視同仁這點最容易踩坑排除方式Scala 2Scala 33.2Scala 33.3.4 / 3.4.2coverageExcludedPackages?? 需升級?coverageExcludedFiles?? 需升級?$COVERAGE-OFF$注釋???在舊版 Scala 3 上配置排除規(guī)則會靜默失效插件會給出 warning 日志代碼仍會被統(tǒng)計。判斷邏輯見ScoverageSbtPlugin.scala中的isScala3SupportingFilePackageExclusion方法。如果你用的是 Scala 3請確保版本不低于 3.3.4 或 3.4.2。此外Scala.js 與 Scala Native 目前僅支持 Scala 2?？偨Y(jié)一張表記住 3 招排除技巧想排除什么用什么示例整個包 / 指定類coverageExcludedPackagesmodels\\..*;Reverse.*指定文件 / 目錄coverageExcludedFiles.*\\/generated\\/.*方法內(nèi)的一段代碼$COVERAGE-OFF$注釋見上文示例掌握這 3 招之后你就能讓 sbt-scoverage 報告精準(zhǔn)聚焦業(yè)務(wù)代碼配合coverageFailOnMinimum與coverageMinimumStmtTotal等最低覆蓋率門檻把覆蓋率檢查真正變成團(tuán)隊的質(zhì)量閘門。記住核心口訣排除包看全限定名排除文件看路徑排除片段看注釋Scala 3 記得升級版本。趕快在你的build.sbt里試試吧【免費下載鏈接】sbt-scoveragesbt plugin for scoverage項目地址: https://gitcode.com/gh_mirrors/sb/sbt-scoverage創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考 sbt-scoverage 排除機(jī)制實戰(zhàn)：3 招精準(zhǔn)跳過類、包與文件
sbt-scoverage 排除機(jī)制實戰(zhàn)3 招精準(zhǔn)跳過類、包與文件【免費下載鏈接】sbt-scoveragesbt plugin for scoverage項目地址: https://gitcode.com/gh_mirrors/sb/sbt-scoverage想知道如何讓sbt-scoverage 排除掉那些不需要統(tǒng)計的代碼嗎在 Scala 項目中接入sbt-scoverage覆蓋率插件后生成的報告常?；烊胱詣由傻念悺影宕a或第三方橋接文件導(dǎo)致覆蓋率數(shù)字失真。其實這個插件的排除機(jī)制非常靈活只需 3 個技巧就能精準(zhǔn)跳過類、包與文件讓報告只反映你真正關(guān)心的業(yè)務(wù)代碼。本文將用最少的代碼帶你一次掌握全部排除玩法。先搞清楚sbt-scoverage 排除機(jī)制是怎么運作的sbt-scoverage 是 Scala 生態(tài)最流行的覆蓋率插件支持 Scala 2.12 / 2.13 / 3它通過編譯器插件對字節(jié)碼插樁來統(tǒng)計語句與分支的覆蓋情況。排除Exclusion發(fā)生在插樁階段被排除的代碼根本不會被埋點也就不會出現(xiàn)在任何報告中。所有排除規(guī)則都定義在插件的配置鍵中源碼見src/main/scala/scoverage/ScoverageKeys.scala配置鍵作用匹配對象coverageExcludedPackages排除包或類類的全限定名coverageExcludedFiles排除文件或目錄源文件路徑$COVERAGE-OFF$注釋排除代碼片段注釋包裹的源碼區(qū)間三條規(guī)則都用正則表達(dá)式匹配多個規(guī)則之間用英文分號;分隔。注意正則必須完整匹配目標(biāo)字符串才會生效不是部分匹配。第 1 招用 coverageExcludedPackages 一鍵排除整個包最常用的場景是把模型層、生成代碼、工具包整體移出統(tǒng)計。在build.sbt中這樣配置coverageExcludedPackages : empty;Reverse.*;.*AuthService.*;models\\.data\\..*這條規(guī)則拆開看empty排除默認(rèn)包無 package 聲明的類Reverse.*排除以 Reverse 開頭的類.*AuthService.*排除名字中含 AuthService 的類models\\.data\\..*排除models.data包下的所有類插件源碼中的處理邏輯見src/main/scala/scoverage/ScoverageSbtPlugin.scala它會把該值原樣拼進(jìn)編譯器參數(shù)-P:scoverage:excludedPackages:。官方測試用例src/sbt-test/scoverage/coverage-excluded-packages/展示了驗證方式排除后報告目錄中不再生成對應(yīng)包的 HTML 文件。 小提示正則中的.要轉(zhuǎn)義成\\.*要寫成.*否則會匹配到意料之外的內(nèi)容。第 2 招用 coverageExcludedFiles 按路徑排除文件當(dāng)你想跳過某個具體文件或某個目錄時用coverageExcludedFiles更直觀——它匹配的是源文件路徑coverageExcludedFiles : .*\\/two\\/GoodCoverage;.*\\/three\\/.*.*\\/two\\/GoodCoverage排除two/GoodCoverage.scala文件.*\\/three\\/.*排除three目錄下的所有文件兩個關(guān)鍵細(xì)節(jié)不要帶.scala擴(kuò)展名規(guī)則直接匹配去掉擴(kuò)展名后的路徑匹配的是以/分隔的路徑字符串在正則里要寫成\\/。插件在 Windows 下還會自動把/替換為\\見ScoverageSbtPlugin.scala中的處理邏輯所以跨平臺寫\\/最穩(wěn)妥。官方測試用例參考src/sbt-test/scoverage/coverage-excluded-files/其中build.sbt正是用了上面這條規(guī)則并斷言報告目錄中不存在被排除文件的頁面。第 3 招用 COVERAGE-OFF 注釋跳過指定代碼段如果只想跳過某個方法或某段臟代碼不必動用文件級規(guī)則。在源碼里用注釋標(biāo)記即可def legacyParser(raw: String): Int { // $COVERAGE-OFF$這段是歷史遺留代碼暫不納入統(tǒng)計 val tokens raw.split(,) var acc 0 for (t - tokens) acc t.toInt acc // $COVERAGE-ON$ }// $COVERAGE-OFF$與// $COVERAGE-ON$之間的所有代碼都不會被插樁也不會進(jìn)入覆蓋率報告。這是按代碼區(qū)間排除的唯一方式適合臨時豁免、歷史遺留代碼或與測試無關(guān)的初始化邏輯。?? 注意注釋排除目前僅適用于 Scala 2Scala 3 項目請改用前兩招。版本與平臺不同 Scala 版本的排除能力差異排除能力并非所有版本一視同仁這點最容易踩坑排除方式Scala 2Scala 33.2Scala 33.3.4 / 3.4.2coverageExcludedPackages?? 需升級?coverageExcludedFiles?? 需升級?$COVERAGE-OFF$注釋???在舊版 Scala 3 上配置排除規(guī)則會靜默失效插件會給出 warning 日志代碼仍會被統(tǒng)計。判斷邏輯見ScoverageSbtPlugin.scala中的isScala3SupportingFilePackageExclusion方法。如果你用的是 Scala 3請確保版本不低于 3.3.4 或 3.4.2。此外Scala.js 與 Scala Native 目前僅支持 Scala 2?？偨Y(jié)一張表記住 3 招排除技巧想排除什么用什么示例整個包 / 指定類coverageExcludedPackagesmodels\\..*;Reverse.*指定文件 / 目錄coverageExcludedFiles.*\\/generated\\/.*方法內(nèi)的一段代碼$COVERAGE-OFF$注釋見上文示例掌握這 3 招之后你就能讓 sbt-scoverage 報告精準(zhǔn)聚焦業(yè)務(wù)代碼配合coverageFailOnMinimum與coverageMinimumStmtTotal等最低覆蓋率門檻把覆蓋率檢查真正變成團(tuán)隊的質(zhì)量閘門。記住核心口訣排除包看全限定名排除文件看路徑排除片段看注釋Scala 3 記得升級版本。趕快在你的build.sbt里試試吧【免費下載鏈接】sbt-scoveragesbt plugin for scoverage項目地址: https://gitcode.com/gh_mirrors/sb/sbt-scoverage創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考