Sonar參數(shù)分析

1、Sonar 參數(shù)分析API compatibility1. API behavior changes-Clirr Plugin正常接口變化數(shù)2. API breaks-Clirr Plugin可能引發(fā)錯誤的接口變化3. New API-Clirr Plugin新增接口數(shù)4. Total API Changes-Clirr Plugin接口變化總數(shù)注：以上參數(shù)需要依賴于Clirr ，暫時仍存在問題Architecture5. Architecture- Total Quality Plugin架構(gòu)質(zhì)量計算方式：ARCH = 100TITI = Tangle Index6. Architectur

2、e Tangle Index- Total Quality Plugin架構(gòu)復(fù)雜指標(biāo)Complexity7. Complexity 默認(rèn)復(fù)雜度8. Complexity /class 默認(rèn)類復(fù)雜度9. Complexity /file 默認(rèn)文件復(fù)雜度10. Complexity /method 默認(rèn)方法復(fù)雜度11. Complexity Factor- Quality Index Plugin復(fù)雜度因素計算方式：CF = (5 * Complexity>30) * 100 / (Complexity>1 + Complexity>10 + Complexity>20 +

3、 Complexity>30)12. Complexity Factor Methods- Quality Index Plugin方法復(fù)雜度因素13. QI Complexity-Quality Index Plugin復(fù)雜度質(zhì)量指標(biāo)計算方式：(Complexity>30 *10 + Complexity>20 * 5 + Complexity>10 * 3 + Complexity>1) / validLinesDesign14. Design Classes and Methods Complexity- Total Quality PluginNOM =

4、(1 - (class_complexity - 12) / (acel * 12) * 50 + (1 - (method_complexity - 2.5) / (acel * 2.5)* 50參見 1915. Design Coupling Between Objects- Total Quality PluginCBO = (1 - (efferent_coupling - 5) / (acel * 5) * 100參見 1916.Design Depth of Inheritance Tree- Total Quality PluginDIT = (1 - (depth_of_inh

5、eritance_tree - 5) / (acel * 5) * 100參見 1917.Design Lack of Cohesion of Methods- Total Quality PluginLCOM = (1 - (lack_of_cohesion_of_method - 1) / (acel * 1) * 100參見 1918.Design Response for Class- Total Quality PluginRFC = (1 - (response_for_class - 50) / (acel * 50) * 100參見 1919.Design Quality- T

6、otal Quality Plugin設(shè)計質(zhì)量計算方式：DES = 0.15*NOM + 0.15*LCOM + 0.25*RFC 0.25*CBO + 0.20*DITNOM = (1 - (class_complexity - 12) / (acel * 12) * 50 + (1 - (method_complexity - 2.5) / (acel *2.5) * 50LCOM = (1 - (lack_of_cohesion_of_method - 1) / (acel * 1) * 100RFC = (1 - (response_for_class - 50) / (acel *

7、50) * 100CBO = (1 - (efferent_coupling - 5) / (acel * 5) * 100DIT = (1 - (depth_of_inheritance_tree - 5) / (acel * 5) * 100Acel 參數(shù)因子的值可以在 Sonar setting 頁面配置。每一個度量標(biāo)準(zhǔn)的默認(rèn)闕值也可以進(jìn)行配置（例如，50 是 response_for_class 的默認(rèn)閾值 ）。20. LCOM4（Lack of cohesion of methods）用來說明class 內(nèi)部方法和變量之間的關(guān)系, 值越大 , 說明內(nèi)聚性越差. 一般情況下LCOM4=

8、1是內(nèi)聚性最佳的. 2 說明可以拆成兩個類, 以此類推 .但是這種測量對門面服務(wù)類來說不適用. 有時候很小的類也會根據(jù)需要合并在一起, 盡管關(guān)聯(lián)不大21. Package tangle index包復(fù)雜指數(shù)此參數(shù)為包的復(fù)雜等級，最好的值為0%，意味著包之間沒有圈依賴；最差的值為100%，意味著包與包之間的關(guān)系特別的復(fù)雜。該指數(shù)的計算公式：2 * (package_tangles / package_edges_weight)* 100.22. RFC（Response for Class ）通過檢查一個方法被調(diào)用的情況來反映一個 class 的復(fù)雜程度 . 也可以簡單的理解為一個類所包含的方法

9、多寡 .23. Suspect LCOM4 densityLCOM4密度值Documentation24. Comment linesJavadoc、多行注釋、單行注釋的總數(shù)?？兆⑨屝小㈩^文件中的注釋（主要用于定義許可證）以及 commented-out 行均不會包括在內(nèi)。25. Commented-out LOC注釋掉的代碼行數(shù)。Javadoc 塊不會被掃描26. Comments (%)注釋行數(shù) /( 注釋行數(shù) +有效代碼行數(shù))27. Public documented API (%)添加注釋的公有API 占總的公有API 的百分比28. Public undocumented API公有

10、 API 未添加注釋個數(shù)Duplication29. DRYness - Total Quality PluginDRYNESS = 100 - Duplicated lines density30. Duplicated blocks重復(fù)塊數(shù)31. Duplicated files重復(fù)文件數(shù)32. Duplicated lines重復(fù)行數(shù)33. Duplicated lines (%)重復(fù)行占總行數(shù)的百分比34. Useless Duplicated Lines-Useless Code Tracker無用的重復(fù)行數(shù)；當(dāng)前的Sonar 告訴你有 50 重復(fù)的行數(shù)，但是不能告訴你是有兩塊25

11、行的代碼重復(fù)（這樣你可以節(jié)省 25 行代碼）還是有 5 塊 10 行（這樣你可以節(jié)省 40 行代碼）的代碼重復(fù)；通過這個插件，你可以獲取到額外的信息。General35. Analysability Value- SIG Maintainability Model可理解性請查看 37 指標(biāo)后的詳細(xì)介紹36. Changeability Value- SIG Maintainability Model可擴展性37. Stability Value- SIG Maintainability Model穩(wěn)定性38. Testability Value- SIG Maintainability Mod

12、el可測試性可維護(hù)性可通過7 個質(zhì)量特性來衡量:可理解性可測試性可修改性可靠性可移植性可使用性效率這個插件標(biāo)示了一個Software Improvement Group (SIG)可維護(hù)性模型這個模型需要兩步: 計算基數(shù)的指標(biāo)，然后結(jié)合他們計算出更高層面上的數(shù)值。每一個指標(biāo)被分成5 級別排名：從 -（很糟糕）到 +（非常好）第一步加上基數(shù)的指標(biāo)。Volume : 基于代碼的行數(shù)Rank LOC-> 1310000-> 6550000> 246000+> 66000+> 0Duplications :基于代碼重復(fù)的密度Rank Duplication-> 20

13、%-> 10%0> 5%+> 3%+> 0%Unit tests :基于單元測試覆蓋率Rank Coverage+ > 95%+>80%0>60%->20%- > 0%Complexity :基于方法的圈復(fù)雜度第一步根據(jù)圈復(fù)雜度的范圍確定在方法代碼行中的百分比。EvalComplexityVery high> 50High> 20Medium> 10Low> 0然后根據(jù)分布，我們使用下面的表格來計算等級：Rank MediumHighVery High+ <25% <0% <0%+ <30%

14、<5% <0%0<40%<10%<0%- <50% <15%<5%否則等級是 -Unit size: 基于方法代碼的行數(shù)第一步根據(jù)行數(shù)的范圍確定方法代碼行數(shù)的百分比。EvalLOCsVery high> 100High> 50Medium> 10Low> 0然后根據(jù)分布，使用下面的表格來計算等級：Rank MediumHighVery High+ <25% <0% <0%+ <30% <5% <0%0<40%<10%<0%- <50% <15%<5%否

15、則等級為 -第二步是通過一個簡單的平均，將他們結(jié)合起來，使用以下映射表來確定最終等級.Volume Complexity DuplicationsUnit size Unit testsanalysabilitychangeabilitystabilitytestability因此 4 個代表軟件可維護(hù)性四維的先進(jìn)指標(biāo)。可選項，通過將 4 個指標(biāo)簡單的結(jié)合在一塊，可以得到可維護(hù)性排名。需要注意的是，圖表的顏色代表實際結(jié)合后的值，從紅色=-到綠色 =+.39.Profile version 未知未知40.Quality Index- Quality Index Plugin計算方式：QI = 1

16、0 - 4.5 * coding - 2 * complexity - 2 * coverage -1.5 * style41.SIG MM- SIG Maintainability ModelSIG可維護(hù)性模型，參考 3742.Technical Debt ($)-Technical Debt Plugin清除所有技術(shù)債務(wù)需要的花費43.Technical Debt in days-Technical Debt Plugin需要多少人日去解決技術(shù)債務(wù)44.Technical Debt ratio-Technical Debt Plugin技術(shù)債務(wù)占整個項目的比例45.Total Qualit

17、y- Total Quality Plugin總體質(zhì)量計算方式：TQ= 0.25*ARCH + 0.25*DES + 0.25*CODE + 0.25*TSManagement46. Burned budget燃盡預(yù)算47. Business value商業(yè)價值48. Team size團(tuán)隊規(guī)模注：以上變量為手動輸入變量，另外這里可以添加一些自定義的變量Rules49. Blocker violations阻礙性違規(guī)50. Code Quality- Total Quality Plugin代碼質(zhì)量計算方式：Code = 0.15*DOC + 0.45*RULES + 0.40*DRYNESS

18、DOC = Documented API densityRULES = Rules compliance indexDRYNESS = 100 - Duplicated lines density51. Critical violations嚴(yán)重違規(guī)52. Dead Code- Useless Code Tracker無作用程序代碼53. Info violations建議級別違規(guī)54. Major violations重要違規(guī)55. Minor violations次要違規(guī)56. Potential Dead Code- Useless Code Tracker當(dāng)前代碼中未使用的 prote

19、cted 方法數(shù)目；此參數(shù)可通過 PMD :UnusedProtectedMethod 或者 SQUID:UnusedProtectedMethod 獲取到。計算他們行數(shù)的和值。57. QI Coding Violations-Quality Index Plugin代碼違規(guī)質(zhì)量指標(biāo)（PMD 規(guī)則指數(shù)）計算方式：(Blocker * 10 + Critical * 5 + Major * 3 + Minor + Info) / validLines58. QI Coding Weighted Violations-Quality Index Plugin代碼違規(guī)權(quán)重指標(biāo)59. QI Style

20、 Violations-Quality Index Plugin風(fēng)格違規(guī)質(zhì)量指標(biāo)(CheckStyle 規(guī)則指數(shù)）計算方式：Style = (Errors*10 + Warnings) / ValidLines * 10QI = 10 - 4.5 * coding - 2 * complexity - 2 * coverage -1.5 * style60. QI Style Weighted Violations-Quality Index Plugin風(fēng)格違規(guī)權(quán)重質(zhì)量指標(biāo)61. Rules compliance遵守規(guī)則率62. Security rules compliance- Secu

21、rity Rules PluginSecurity 規(guī)則遵守率63. Security violations- Security Rules Plugin符合 Security 規(guī)則數(shù)目64. Violations違規(guī)總數(shù)65. Weighted Security Violations- Security Rules PluginSecurity 規(guī)則權(quán)重值（總數(shù)）Size66. AccessorsGetter 及 setter 方法的數(shù)量/ Getterspublic String getName()return ;public boolean isParent()retu

22、rn this.isParent;/ Setterspublic void setName(String name) = name;public void setIsParent(boolean isParent)this.isParent = isParent;67.Artifact Size (Kb)- Artifact Size Plugin記錄最終產(chǎn)品大小68.Classes類總數(shù)69.Files文件數(shù)70.Lines文件中行數(shù)71.Lines of code代碼行數(shù)72.Methods方法數(shù)目73.Packages包數(shù)目74.Public API公共類、公共方法（不

23、包括訪問器）以及公共屬性（不包括public final static 類型的）的數(shù)目。75.StatementsJava語言規(guī)范中沒有塊定義的語句數(shù)目；此數(shù)目在遇到含有if, else, while, do, for, switch, break,continue, return, throw, synchronized, catch, finally等關(guān)鍵字的語句時增加。例如：/i = 0;if (ok)if (exit) if (3 = 4);if (4 = 4) ; else trywhile(true)for(.).語句數(shù)目不會隨著以下情況增加，類、方法、字段、注釋定義、包以及imp

24、ort 定義。76. Total Useless Code- Useless Code Tracker可以刪除的代碼行數(shù)Tests77. Coverage覆蓋率78. Line coverage行覆蓋率79. QI Test Coverage-Quality Index Plugin測試覆蓋率質(zhì)量指標(biāo)80. Skipped unit tests忽略的單元測試數(shù)81. Testing Quality- Total Quality Plugin測試質(zhì)量計算方式：Test = 0.80*COV + 0.20*SUCCOV = Code coverageSUC = Unit Tests success

25、 density82. Uncovered lines未覆蓋行數(shù)83. Unit test errors單元測試出錯數(shù)84. Unit test failures單元測試失敗數(shù)85. Unit test success (%)單元測試成功率86. Unit tests單元測試個數(shù)87. Unit tests duration單元測試需要的時間SCM88. CommitsSVN庫總的提交數(shù)89. Last commit最近的一次提交時間SQALE90. SQALE RatingSQALE（ Software Quality Assessment based on Lifecycle Expect

26、ations ）評級；基于生命周期期望的軟件質(zhì)量模型91. SQALE Remediation CostSQALE整治成本附錄92. Sonar 插件插件名稱插件介紹度量參數(shù)ABAPABAP 項目插件Artifact Size衡量項目產(chǎn)品的大小Artifact Size (Kb)Branding允許添加 Logo 到 Sonar 界面上Build Breaker在有一個警報閾值滿足時，停止分析處理CC 項目插件C RulesC 規(guī)則插件Clirr檢查 Java庫二進(jìn)制文件及源代碼與API behavior changes之前版本的兼容性API breaksNew APITotal API Ch

27、angesClover通過 Atlassian Clover（收費）獲取覆蓋率CobolCobol 項目插件CrowdAtlassian Crowd 在 Sonar 上的認(rèn)證委托Email分析報告可通過 Email 進(jìn)行傳輸EmmaEmma 是替代 Clover 和 Cobertura測量單元測試代碼覆蓋率的工具FlexActionScript 項目插件French Pack法語包Google Calendar將 Google 日歷集成到 SonarGreenPepper收集 GreenPepper Maven plugin 提供的測試報告到 Sonar 上GroovyGroovy 項目插件J

28、Meter在 Sonar 上展示 JMeter 測試結(jié)果JaCoCoJaCoCo 是替代 Clover 和 Cobertura測量單元測試代碼覆蓋率的工具JavaScriptJavaScript 項目插件Jira從 Jira 服務(wù)中收集項目缺陷的數(shù)目LDAPLDAP 在 Sonar 上的認(rèn)證委托Mantis從 Mantis BugTracker 中檢索項目缺陷的個數(shù)Motion Chart顯示一組指標(biāo)隨著時間的演變(需要接入互聯(lián)網(wǎng) )NaturalNatural 項目插件PAM允許 Sonar 在 *nix box 上使用 PAM認(rèn)證PDF ReportPDF報告插件PHPPHP 項目插件PL

29、/SQLPL/SQL項目插件Quality Index根據(jù)編碼規(guī)范、樣式、復(fù)雜度、覆蓋率計算一個全局的質(zhì)量指標(biāo)Radiator使用 treemap 顯示度量指標(biāo)SCM Activity從 SCM 收集和報告信息。SIG Maintainability ModelSIG可維護(hù)性模型接口Security Rules檢測一組已定義的安全規(guī)則Sonar Cutoff Plugin通過日期排除要分析的文件；所有從最后修改時間到配置的截止時間QI Test CoverageQI Style Weighted Violations QI Style ViolationsQI Coding Weighted

30、ViolationsQI Coding ViolationsComplexity FactorComplexity Factor MethodsQI ComplexityQuality IndexCommitsLast commitSIG MMTestability ValueStability ValueChangeability ValueAnalysability ValueWeighted Security ViolationsSecurity violationsSecurity rules complianceSonar Piwik PluginSonargraphSQALESpa

31、nish PackSwitch Off Violations TaglistTechnical DebtTimelineTotal QualityTracUseless Code TrackerViews之內(nèi)的源文件都被排除在外。當(dāng)你需要分析在現(xiàn)有代碼基礎(chǔ)上新增代碼或修改時，這可能是有用的。這種方式對于以前各階段的分析不會影響分析結(jié)果。Piwik （ ） 是 一 個 開 源 的 可 替 換 Google Analytics 來使用的網(wǎng)絡(luò)分析軟件，特別是在內(nèi)部網(wǎng)站。 Piwik 插件可以將 Sonar 上個人瀏覽活動的記錄提交到 Piwik 服務(wù)器。通過循環(huán)依賴及其他架構(gòu)方面的指標(biāo)提供架構(gòu)改進(jìn)功

32、能基于生命周期期望的軟件質(zhì)量評估西班牙包關(guān)閉違規(guī)檢查分析代碼中像 TODO 或者 /TODO 的標(biāo)記以美元計算修復(fù)源代碼中所有質(zhì)量問題所需要的工作量高級時間機器（ time machine ）圖表（需要連入互聯(lián)網(wǎng)）將代碼質(zhì)量、設(shè)計、架構(gòu)及測試質(zhì)量結(jié)合在一塊提供項目的整體質(zhì)量度量從 Trac 中檢索和報告項目問題查找項目內(nèi)重復(fù)源代碼創(chuàng)建項目的樹狀圖，項目按照應(yīng)用程序進(jìn)行分類，應(yīng)用程序按照小組SQALE Remediation Cost SQALE RatingTechnical Debt ratio Technical Debt in days Technical Debt ($)Testing

33、 QualityCode QualityTotal QualityDrynessDesign QualityDesign Response for ClassDesign Lack of Cohesion of Methods Design Depth of Inheritance Tree Design Coupling Between Objects Design Classes and MethodsComplexityArchitecture Tangle Index ArchitectureTotal Useless CodePotential Dead CodeDead CodeU

34、seless Duplicated Lines來進(jìn)行分類，小組按照部門進(jìn)行分類Visual BasicVisual Basic 項目插件Web分析 Web 代碼Xml分析 XML 和 XHTML 文檔fb-contrib新的 FindBugs 規(guī)則Checkstyle使用 Checkstyle 5.1 分析 Java 代碼Cobertura使用 Cobertura .獲取覆蓋率Core提供覆蓋到所有語言的通用組件Database Cleaner清除舊的或無用的數(shù)據(jù)，來提高數(shù)據(jù)庫性能Design分析 Java 字節(jié)碼來計算O.O.度量值并提取資源之間的依賴關(guān)系Duplications查找項目中重

35、復(fù)的源代碼Email notificationsEmail 通知English Pack英語包Findbugs使用分析 Java代碼Google analytics將 Google Analytics跟蹤腳本添加到 Sonar 應(yīng)用程序PMD使用分析 Java 代碼Squid for JavaSquid 分析 JavaSurefire使用 Surefire 獲取單元測試結(jié)果93. Sonar 幫助文檔中的度量值度量是 Sonar 的核心，有效的使用 Sonar，需要完全了解每個參數(shù)的定義和計算方式。NameKeyDescriptionPhysical lineslinesComment lin

36、escomment_lines回車數(shù)目Javadoc、多行注釋、 單行注釋的總數(shù)。 空注釋行、 頭文件中的注釋 （主要用于定義許可證）以及commented-out 行均不會包括在內(nèi)。/* This is a javadoc block* <- empty comment line considered as a blank line*/<-empty comment line considered as a blank line/* This is a multi-comment block*/ This is a single-comment block/ log("

37、Debug information");<- commented-out line of code is nota comment lineCommented-outcommented_out_code_lines注釋掉的代碼行數(shù)。 Javadoc塊不會被掃描lines of code/*Lines of codenclocDensity ofcomment_lines_densitycomment linesPackagespackagesClassesclassesFilesfilesDirectoriesdirectoriesAccessorsaccessorsMetho

38、dsFunctionsPublic APIpublic_apiPublicpublic_undocumented_apiundocumentedAPIDensity of publicpublic_documented_api_densitydocumented APIDuplicated linesduplicated_linesDuplicatedduplicated_blocksblocksDuplicated filesduplicated_filesDensity ofduplicated_lines_densityduplicated linesStatementsstatemen

39、ts* someoneCommentMeOutOneDay();* nobodyKnowWhatAmISupposedToDo();*/physical lines - blank lines - comment lines - header file comments -commented-out lines of codecomment lines / (lines of code + comments lines) * 100%包數(shù)目類的數(shù)目，包括內(nèi)部類、接口、枚舉及注釋標(biāo)簽分析的文件數(shù)目分析的目錄數(shù)目Getter及 setter方法數(shù)目，通過 get(reading)或 set(wri

40、ting)一個類屬性/ Getterspublic String getName()return ;public boolean isParent()return this.isParent;/ Setterspublic void setName(String name) = name;public void setIsParent(boolean isParent)this.isParent = isParent;方法數(shù)目，不包括訪問器。一個構(gòu)造函數(shù)算作一個方法公共類、方法（不包括訪問器）以及屬性（不包括public final static 修飾的屬性

41、）不包含 javadoc 塊的公共 API 數(shù)目(public API - undocumented public API) / public API * 100%重復(fù)的物理行數(shù)重復(fù)的代碼塊數(shù)涉及到重復(fù)代碼的文件數(shù)目Duplicated lines / Physical lines * 100%Java 語言規(guī)范中沒有塊定義的語句數(shù)目；此數(shù)目在遇到含有if, else,Complexitycomplexitywhile, do, for, switch, break, continue, return, throw, synchronized, catch,finally 等關(guān)鍵字的語句時增加

42、。例如：/i = 0;if (ok)if (exit) if (3 = 4);if (4 = 4) ; else try while(true) for(.).語句數(shù)目不會隨著以下情況增加，類、方法、字段、注釋定義、包以及 import定義。圈 復(fù) 雜 度 也 被 稱 為McCabe 度 量 。 它 簡 單 歸 結(jié) 為 一 個 方 法中if,for ,while 等塊的數(shù)目。當(dāng)一個方法的控制流分割，圈計數(shù)器加1.除不被認(rèn)為是方法的訪問器外，每個方法默認(rèn)有最小的值 1，所以不會增加復(fù)雜度。對于以下的每一個 java關(guān)鍵字 / 語句，圈復(fù)雜度均會加 1：ifforwhilecasecatchthr

43、owreturn ( 當(dāng)不是一個方法最好一個語句時)&&|?注意 else, default 及 finally 不會增加 CCN的值。另一方面，一個含 switch語句及很大塊case 語句的簡單方法可以擁有一個令人驚訝的高的CCN 值（同時，當(dāng)將switch 塊轉(zhuǎn)化為等效的if 語句時，它具有相同的CCN值）。例如，下面的方法具有5 的復(fù)雜度。public void process(Car myCar)<- +1if(myCar.isNotMine()<- +1return;<- +1car.paint("red");car.chang

44、eWheel();while(car.hasGazol() && car.getDriver().isNotStressed()<- +2car.drive();return;Averagefunction_complexitycomplexity bymethodComplexityfunction_complexity_distributiondistribution bymethodAverageclass_complexitycomplexity byclassComplexityclass_complexity_distributiondistribution

45、byclassAveragefile_complexitycomplexity byfileViolationsviolationsNew Violationsnew_violationsxxxxx violationsxxxxx_violationsNew xxxxxnew_xxxxx_violationsviolationsWeightedweighted_violationsviolationsRulesviolations_densitycomplianceindexUnit testsTestsUnit teststest_execution_timedurationUnit tes

46、t errortest_errorsUnit test failurestest_failuresUnit test successtest_success_densitydensitySkipped unitskipped_teststestsLine Coverageline_coverageNew Linenew_line_coverageCoverageBranch coveragebranch_coverage方法的平均圈復(fù)雜度方法復(fù)雜度的分布類的平均圈復(fù)雜度類復(fù)雜度的分布文件平均復(fù)雜度違規(guī)總數(shù)新的違規(guī)數(shù)目Xxxxx 級別違規(guī)的數(shù)目，xxxxx 為阻礙、嚴(yán)重、主要、次要和建議新的 Xxxxx級別違規(guī)的數(shù)目， xxxxx 為阻礙、嚴(yán)重、主要、次要和建議通過每個級別的相關(guān)系數(shù)，違規(guī)權(quán)重的總