Kotlin Android專案靜態檢查工具的使用
Kotlin Android專案可用的靜態檢查工具: Android官方的Lint, 第三方的ktlint和detekt.
靜態檢查工具
靜態檢查工具, 指不需要運行代碼, 對代碼進行檢查的工具.
不止代碼風格, 還可以檢查代碼的正確性, 是否有安全問題, 是否有性能問題等.
靜態檢查工具一般都具備可擴展性, 方便使用者制定和添加自己的規則.
比較流行的Java靜態檢查工具有CheckStyle, FindBugs, PMD等.
Android專案, 用Kotlin語言, 可用的靜態檢查工具: 官方的Android Lint, ktlint和detekt.
Android Lint
Android官方提供了代碼掃描工具, 叫lint.
在Android Studio運行lint, 在選單中選:
Analyze -> Inspect Code..., 選擇范圍, 點OK即可運行.
也可以在命令列:
./gradlew lint
會分類報告出各種各樣的錯誤.
查看所有的Lint規則
點擊選單中的Analyze -> Inspect Code..., 在彈框的Inspection profile部分點擊表示更多的...按鈕, 會彈出框顯示當前的所有lint規則.
可以選擇是否包括規則, 編輯它們的優先級和應用范圍等.
Android Lint配置
全域的配置除了用IDE, 還可以通過lint.xml檔案.
還可以在gradle中配置, 比如:
android {
...
lintOptions {
// Turns off checks for the issue IDs you specify.
disable 'TypographyFractions','TypographyQuotes'
// Turns on checks for the issue IDs you specify. These checks are in
// addition to the default lint checks.
enable 'RtlHardcoded','RtlCompat', 'RtlEnabled'
// To enable checks for only a subset of issue IDs and ignore all others,
// list the issue IDs with the 'check' property instead. This property overrides
// any issue IDs you enable or disable using the properties above.
check 'NewApi', 'InlinedApi'
// If set to true, turns off analysis progress reporting by lint.
quiet true
// if set to true (default), stops the build if errors are found.
abortOnError false
// if true, only report errors.
ignoreWarnings true
}
}
特定代碼可以利用@SuprressLint注解.
比如: @SuppressLint("NewApi"), @SuppressLint("all").
特定xml檔案中可以用tools:ignore, 比如tools:ignore="UnusedResources", tools:ignore="NewApi,StringFormatInvalid", tools:ignore="all"等.
Android Lint現狀基準快照
可以在gradle中進行設定一個baseline:
android {
lintOptions {
baseline file("lint-baseline.xml")
}
}
第一次添加這個, 運行lint之后, 會自動創建一個lint-baseline.xml檔案, 所有當前的問題都會被寫入這個檔案.
當再次運行lint, 就只會讀這個檔案, 作為基準, 只報告新的錯誤或警告. 并且提示其他原有問題在baseline檔案中, 被排除.
如果想重新生成baseline可以手動洗掉這個檔案, 重新進行.
ktlint
ktlint
代碼風格檢查, 遵循的是: Kotlin style guide
所有的規則代碼: github: ktlint rule set
ktlint安裝
在app/build.gradle中添加:
configurations {
ktlint
}
dependencies {
ktlint "com.pinterest:ktlint:0.36.0"
...
}
task ktlint(type: JavaExec, group: "verification") {
description = "Check Kotlin code style."
classpath = configurations.ktlint
main = "com.pinterest.ktlint.Main"
args "src/**/*.kt"
// to generate report in checkstyle format prepend following args:
// "--reporter=plain", "--reporter=checkstyle,output=${buildDir}/ktlint.xml"
// see https://github.com/pinterest/ktlint#usage for more
}
check.dependsOn ktlint
task ktlintFormat(type: JavaExec, group: "formatting") {
description = "Fix Kotlin code style deviations."
classpath = configurations.ktlint
main = "com.pinterest.ktlint.Main"
args "-F", "src/**/*.kt"
}
ktlint使用
檢查:
./gradlew ktlint
自動修改:
./gradlew ktlintFormat
并不是所有問題都可以自動修改, 有的問題需要手動改.
配置中的這句:
check.dependsOn ktlint
把運行檢查加到了check task中. 通過:
./gradlew check --dry-run
可以查看運行check task都會做哪些事情(dry run表示不用實際執行這些任務).
ktlint原始碼
看ktlint的原始碼, 程式的入口是Main.kt檔案中的main.
使用的規則集是:
class StandardRuleSetProvider : RuleSetProvider {
// Note: some of these rules may be disabled by default. See the default .editorconfig.
override fun get(): RuleSet = RuleSet(
"standard",
ChainWrappingRule(),
CommentSpacingRule(),
FilenameRule(),
FinalNewlineRule(),
ImportOrderingRule(),
IndentationRule(),
MaxLineLengthRule(),
ModifierOrderRule(),
NoBlankLineBeforeRbraceRule(),
NoConsecutiveBlankLinesRule(),
NoEmptyClassBodyRule(),
NoLineBreakAfterElseRule(),
NoLineBreakBeforeAssignmentRule(),
NoMultipleSpacesRule(),
NoSemicolonsRule(),
NoTrailingSpacesRule(),
NoUnitReturnRule(),
NoUnusedImportsRule(),
NoWildcardImportsRule(),
ParameterListWrappingRule(),
SpacingAroundColonRule(),
SpacingAroundCommaRule(),
SpacingAroundCurlyRule(),
SpacingAroundDotRule(),
SpacingAroundKeywordRule(),
SpacingAroundOperatorsRule(),
SpacingAroundParensRule(),
SpacingAroundRangeOperatorRule(),
StringTemplateRule()
)
}
可以看到都是代碼格式相關的規則.
在線查看: ktlint ruleset standard
detekt
Github: detekt也是一個Kotlin的靜態分析工具.
官方網站: detekt.
detekt安裝
在專案根目錄的build.gradle檔案中添加:
plugins {
id("io.gitlab.arturbosch.detekt").version("1.5.0")
}
allprojects {
repositories {
google()
jcenter()
}
apply plugin: 'io.gitlab.arturbosch.detekt'
}
detekt {
failFast = true // fail build on any finding
buildUponDefaultConfig = true // preconfigure defaults
config = files("$projectDir/config/detekt.yml")
// point to your custom config defining rules to run, overwriting default behavior
baseline = file("$projectDir/config/baseline.xml")
// a way of suppressing issues before introducing detekt
reports {
html.enabled = true // observe findings in your browser with structure and code snippets
xml.enabled = true // checkstyle like format mainly for integrations like Jenkins
txt.enabled = true
// similar to the console output, contains issue signature to manually edit baseline files
}
}
運行./gradlew tasks可以看到相關任務被加進去了:
detekt
detektBaseline - Creates a detekt baseline on the given --baseline path.
detektGenerateConfig - Generate a detekt configuration file inside your project.
detektIdeaFormat - Uses an external idea installation to format your code.
detektIdeaInspect - Uses an external idea installation to inspect your code.
detekt使用
運行:
./gradlew detekt
進行檢測.
detekt {
}
塊是用來進行自定義的屬性設定的.
如果開啟了檔案輸出, 結果在:
app/build/reports/detekt目錄下可以查看.
并且運行./gradlew check --dry-run可以發現, 運行check的時候也會執行detekt.
可以利用:
./gradlew detektGenerateConfig
生成組態檔: config/detekt/detekt.yml.
在組態檔中可以看到對各種規則的開關狀態, 編輯它可以進行定制.
detekt原始碼
程式的入口在detekt-climodule的Main.kt.
根據引數的不同回傳不同的Runner.
主要用于檢測的是這個Runner, 它的執行方法:
override fun execute() {
createSettings().use { settings ->
val (checkConfigTime) = measure { checkConfiguration(settings) }
settings.debug { "Checking config took $checkConfigTime ms" }
val (serviceLoadingTime, facade) = measure { DetektFacade.create(settings) }
settings.debug { "Loading services took $serviceLoadingTime ms" }
var (engineRunTime, result) = measure { facade.run() }
settings.debug { "Running core engine took $engineRunTime ms" }
checkBaselineCreation(result)
result = transformResult(result)
val (outputResultsTime) = measure { OutputFacade(arguments, result, settings).run() }
settings.debug { "Writing results took $outputResultsTime ms" }
if (!arguments.createBaseline) {
checkBuildFailureThreshold(result, settings)
}
}
}
讀取配置, 創建服務, 執行檢測, 轉化輸出結果.
當沒有用戶自己宣告的組態檔時, 使用的默認組態檔是default-detekt-config.yml.
在這里可以看到對所有規則的默認開關狀態.
detekt的規則代碼放在detekt-rules這個module下:
detekt rules.
官方檔案上也有說明, 比如這是performance分類下的rules: detekt performance.
包含ktlint的規則
detekt的規則種類更多, 并且它包含了ktlint的代碼檢查規則.
所有的ktlint規則被包裝在detekt-formatting這個module下, 見: detekt formatting rules.
但是并不是所有規則都默認開啟.
在組態檔的formatting塊可以查看具體的規則開關狀態.
如果需要修改定制, 需要生成自己的組態檔.
和Git hook結合
Lint工具的運行可以放在CI上, 也可以每次本地手動跑, 這樣在push之前就能發現錯誤并改正.
一種避免忘記的方法就是使用Git hook.
專案的.git/hooks檔案夾下自帶一些有意思的sample.
如何使用git hook
只要在.git/hooks路徑下添加對應名字的檔案, 如pre-push, pre-commit, 寫入想要的代碼即可.
hook檔案回傳0表示通過, 會進行下一步操作. 否則后面的操作會被放棄.
注意檔案要有執行權限:
chmod +x 檔案名
如果不想跑hook可以加上 --no-verify
比如
git commit --no-verify
在提交之前運行靜態檢查
以ktlint為例, 我們希望每次commit的時候先運行./gradlew ktlint, 如果有issue則放棄提交.
在.git/hooks中添加pre-commit檔案, 其中:
#!/bin/bash
echo "Running ktlint"
./gradlew ktlint
result=$?
if [ "$result" = 0 ] ; then
echo "ktlint found no problems"
exit 0
else
echo "Problems found, files will not be committed."
exit 1
fi
detekt的添加也是類似, 官網上給了一個例子: detekt/git-pre-commit-hook.
如何track, 共享Git hooks
因為hooks檔案在.git目錄里, 只是在本地, 那么在團隊成員間如何共享呢?
根據這個問題: https://stackoverflow.com/questions/427207/can-git-hook-scripts-be-managed-along-with-the-repository
從git 2.9開始, 可以設定:core.hooksPath了.
可以在repo里面添加一個目錄hooks, 然后把git hooks檔案放進去track.
在命令列跑:
git config core.hooksPath hooks
把找hook檔案的目錄設定成指定目錄就好了.
總結
本文介紹了三種靜態檢查的工具:
- Android Lint: Android自帶的Lint檢查. 檢查的內容比較豐富.
- ktlint: Kotlin代碼樣式規范檢查. 特色: 有自動修正命令.
- detekt: 除了code style還有performance, exceptions, bugs等方面的檢查. formatting模塊包含了ktlint的所有style檢查(雖然有的具體的規則默認不開啟, 但是可以配置), 是前者的超集.
這些工具都可以擴展, 添加自定義的檢查規則.
結合Git hook把靜態檢查在本地進行, 可以實作問題的盡早暴露和修改.
示例代碼
AndroidLintDemo
- ktlint集成: ktlint分支.
- detekt集成: detekt分支.
參考
- Android Lint: 官方檔案
- ktlint
- detekt
- Kotlin靜態代碼檢測方案分析
轉載請註明出處，本文鏈接：https://www.uj5u.com/yidong/34294.html
標籤：Android