示例

假設您的代碼庫看起來像這樣，您的測試代碼與源代碼混合在一起：

#?Define?the?same?root?directory?for?sources?and?tests
sonar.sources?=?src/
sonar.tests?=?src/
#?Include?test?subdirectories?in?test?scope
sonar.test.inclusions?=?src/**/test/**/*
#?Exclude?test?subdirectories?from?source?scope
sonar.exclusions?=?src/**/test/**/*

代碼覆蓋率的排除

「配置不應該檢測代碼覆蓋率的文件」。參數(shù)的值是相對于當前工作目錄的路徑匹配模式的逗號分隔列表 Administration > General Settings > Analysis Scope > Code Coverage > Coverage Exclusions。

按文件類型設置范圍

大多數(shù)語言都提供了一種將分析范圍限制為與一組擴展名匹配的文件的方法。您可以為每種語言指定一個或多個后綴（文件擴展名）。 例如，對于 C 語言，.c 和 .h是默認設置 通過參數(shù)key設置時，可使用相應參數(shù)sonar.<LANGUAGE>.file.suffixes

重復的排除

Administration > General Settings > Analysis Scope > Duplications 用于從重復檢測機制中排除某些源文件的模式。該值是相對于當前工作目錄的路徑匹配模式的逗號分隔列表。

忽略問題

可使用SonarQube忽略某些組件和某些編碼規(guī)則的問題。Administration > General Settings > Analysis Scope > Issues。 請注意，以下屬性只能通過Web界面設置，因為它們是多值的。

• Ignore Issues on Files
• Ignore Issues in Blocks
• Ignore Issues on Multiple Criteria
• Restrict Scope of Coding Rules

根據(jù)內(nèi)容忽略文件中的問題

Analysis Scope > D. Issue Exclusions > Ignore Issues on Files可以忽略包含與給定正則表達式匹配的代碼塊的文件。這些文件中的所有問題以及安全熱點都將被忽略。在此設置中，可以輸入一個或多個正則表達式模式。任何至少包含一種指定模式的文件都將被忽略。 例如，假設您在 Java 項目中生成了希望排除的類文件。這些文件看起來像這樣：

@Generated("com.example.generated")
public?class?GeneratedClass?extends?AnotherClass?{
????//?Some?generated?code
}

要排除所有此類文件，您可以將此參數(shù)設置為：

@Generated\(".*"\)
#如果在文件中找到此正則表達式，則會忽略整個文件

請注意，由于該值是正則表達式，因此您需要轉(zhuǎn)義(和)括號字符并使用表達式 .* 匹配這些括號之間的字符串。 然而，該參數(shù)的關鍵是 sonar.issue.ignore.allfile，因為它是一個多值屬性，所以我們建議僅通過 UI 設置它。

忽略文件中的塊

Analysis Scope > D. Issue Exclusions > Ignore Issues on Blocks您可以忽略文件中的特定代碼塊，同時繼續(xù)掃描文件的其余部分。要忽略的塊在文件內(nèi)由「開始」和「結(jié)束」字符串分隔。您可以通過正則表達式指定這些開始和結(jié)束字符串。這些塊內(nèi)的所有問題以及安全熱點都將被忽略。您可以輸入一對或多對正則表達式模式。任何文件中位于起始模式與其相應的結(jié)束模式之間的任何代碼都將被忽略「注意：」

• 如果找到第一個正則表達式但未找到第二個正則表達式，則文件末尾被視為塊的末尾。
• 正則表達式不匹配多行。

例如，假設想忽略方法 doSomethingElse 中使用塊分隔符的代碼，如下所示：

public?class?MyClass?{
????public?MyClass()?{
????????...
????}
????public?void?doSomething()?{
????????...????}
????//?BEGIN-NOSCAN
????public?void?doSomethingElse()????{
????????...
????}
????//?END-NOSCAN}

您可以指定以下正則表達式：「塊的開始」： \s*//\s*START-NOSCAN「塊結(jié)束：」** **\s*//\s*END-NOSCAN這些正則表達式可確保無論行注釋字符 ( ) 周圍的空格數(shù)量如何，都可以識別起始塊分隔符和結(jié)束塊分隔符//。 該參數(shù)的關鍵是 sonar.issue.ignore.block. 但是，由于它是一個多值屬性，因此我們建議僅通過 UI 設置它。

從特定文件中排除特定規(guī)則

您可以通過組合由規(guī)則鍵模式** **和_文件路徑模式_組成的一對或多對字符串來防止將特定規(guī)則應用于特定文件。 然而，該參數(shù)的關鍵是 sonar.issue.ignore.multicriteria,，因為它是一個多值屬性，所以我們建議僅通過 UI 設置。

規(guī)則鍵模式

規(guī)則鍵模式由規(guī)則存儲庫名稱、后跟冒號、規(guī)則鍵或規(guī)則名稱通配模式組成。「例如：」

• java:S195與java規(guī)則庫中的規(guī)則 rule S1195完全匹配。
• java:Naming匹配java存儲庫中規(guī)則名稱中包含字符串Naming的所有規(guī)則。

您可以在規(guī)則定義中找到規(guī)則定義的完全限定規(guī)則 ID 和規(guī)則名稱。 例如，對于 此規(guī)則：

• 規(guī)則ID： css:S4655
• 規(guī)則名稱： ?"!important" should not be used on "keyframes"

文件路徑模式

文件路徑模式使用上述路徑匹配格式來指定一組目錄或文件。

示例

如下圖所示，這個配置將忽略所有文件的 針對規(guī)則 java:S2259 進行檢查

• 忽略所有文件中的所有問題：
• 規(guī)則關鍵模式： *
• 文件路徑模式： */
• 忽略文件中的所有問題 bank/ZTR00021.cbl：
• 規(guī)則關鍵模式： *
• 文件路徑模式： bank/ZTR00021.cbl
• 忽略直接位于 Java 包中 com.foo但不位于其子包中的文件中的所有問題：
• 規(guī)則關鍵模式： *
• 文件路徑模式： com/foo/*
• cpp:Union 忽略目錄 object 及其子目錄 中文件中所有違反編碼規(guī)則的問題 ：
• 規(guī)則關鍵模式： cpp:Union
• 文件路徑模式： object/**/* :::

將特定規(guī)則應用于特定文件

• Global level: Administration > Configuration > General Settings > Analysis Scope > D. Issue Exclusions > Restrict Scope of Coding Rules
• Project level: Project Settings > General Settings > Analysis Scope > D. Issue Exclusions > Restrict Scope of Coding Rules

設置這些參數(shù)的機制與上面的 sonar.issue.**ignore**.multicriteria相同：每個條目都包含一個規(guī)則鍵模式和一個文件路徑模式。 不同的是，在這種情況下，這意味著指定的規(guī)則將僅應用于指定的文件集。 該參數(shù)的關鍵是 sonar.issue.**enforce**.multicriteria. 但是，由于它是一個多值屬性，因此我們建議僅通過 UI 設置它。

示例

:::success

• 只檢查“Bean”對象上的“Magic Number”規(guī)則，而不檢查其他任何東西：
• 規(guī)則鍵模式：checkstyle:com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck
• 文件路徑模式：**/*Bean.java
• 僅檢查規(guī)則_Prevent GO TO statement from transferring control outside current module on COBOL programs_ in the directories：bank/creditcardbank/bankcard
• 規(guī)則鍵模式 1：cobol:COBOL.GotoTransferControlOutsideCurrentModuleCheck
• 文件路徑模式 1：bank/creditcard/**/*
• 規(guī)則鍵模式 2：cobol:COBOL.GotoTransferControlOutsideCurrentModuleCheck
• 文件路徑模式 2：bank/bankcard/**/*:::

總結(jié)

「有以下幾種方式來縮小要分析源碼的范圍，如下：」

1. 首先設置「初始化分析范圍」：設置_sonar.sources_參數(shù)指定源代碼目錄的范圍
2. 文件后綴：許多語言都提供了限制文件后綴名的的參數(shù)，’配置’–>’通用’–>’[語言]’，設置File suffixes屬性
3. 「再從上述范圍內(nèi)選擇指定文件」，縮小關注的文件范圍

• _sonar.exclusions/sonar.test.exclusions_ 設置分析「除指定文件以外的所有文件」
• _sonar.inclusions/sonar.test.inclusions_ 設置「僅僅分析指定的文件」

如下圖所示，通過四種不同的方法可將分析范圍縮小到與開發(fā)團隊相關的源代碼。 :::warning

• 源目錄(Source Directories)
• 文件后綴(File Suffixes)
• 選擇文件(Choosing Files)