Санитары кода — следим за чистотой силами автоматизации

Алена Манюхина, Авто.ру – MOSDROID #9 #Flourine – Видео https://youtu.be/4T3q5qXwhgY?t=1h26m42s

Как удерживать код чистым и при этом не довести коллегу-программиста до нервного тика мелкими правками? Как замерить «чистоту кода»? Как не допустить протухания кодовой базы? Как принести порядок в код старого проекта? И как сделать это в измеримые сроки? С такими вопросами хотя бы раз сталкивается каждый программист во время работы над проектами, особенно большими и долгоживущими.

Transcript

1. О том как важно и довольно просто поддерживать ваш код чистым Санитары кода
2. Чистый код?
4. ›MVP ›MVVM ›MVI 4
5. Делай нормально, будет нормально
8. Fail fast, fail early, fail cheap
9. buildTypes { release { shrinkResources true minifyEnabled true proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' } } «Мне достаточно proguard и shrinkResources» 9
10. @Nullable Action1<VASPurchase> onAfterPurchase) { return enrichVasInfosWithActivationState(purchases) .concatMapIterable(infos -> infos) .map(vas -> new VASPurchase(vas, vas.activated ? PurchaseState.SUCCESS : PurchaseState.WAITING)) .concatMap(purchase -> Observable.concat( Observable.just(purchase) .doOnNext(purchase1 -> purchase1.purchaseState = purchase1.isActivated() ? PurchaseState.SUCCESS : PurchaseState.IN_PROGRESS) .observeOn(AutoSchedulers.main()) .doOnNext(res -> { if (onBeforePurchase != null) onBeforePurchase.call(res); }), !purchase.isActivated() ? VASManager.getInstance().purchase(offerId, purchase.vas) .onErrorResumeNext(e -> processPurchaseError(e, purchase)) .observeOn(AutoSchedulers.main()) .doOnError(e -> { if (onAfterPurchase != null) onAfterPurchase.call(purchase); }) .map(res -> { purchase.vas.activated = res; purchase.purchaseState = res ? PurchaseState.SUCCESS : PurchaseState.FAIL; return purchase; }) .doOnNext(res -> AnalystManager.getInstance().logPurchase(purchase.vas)) .doOnNext(res -> { if (onAfterPurchase != null) onAfterPurchase.call(purchase); }) : Observable.just(new VASPurchase(purchase.vas, PurchaseState.SUCCESS)) )); } 10 РЕАЛЬНЫЙ КОД ИЗ ПРОЕКТА
11. public class BaseFile { protected int id; protected String name; protected String path; protected long date; public BaseFile(int id, String name, String path, long date) { this.id = id; this.name = name; this.path = path; this.date = date; } @Override public boolean equals(Object o) { if (this == o) return true; if (!(o instanceof BaseFile)) return false; BaseFile baseFile = (BaseFile) o; return id == baseFile.id; } } 11 РЕАЛЬНЫЙ КОД ИЗ ПРОЕКТА
12. Давайте автоматизируем!
13. Всегда с вами Заточен под андроид > 300 проверок https://developer.android.com/studio/ write/lint http://tools.android.com/tips/lint lint 13 … <3 Kotlin (c 3.1.3)
14. › @Nullable/@NonNull › @IntRange, @FloatRange, @Size › @DrawableRes, @ColorRes, @ColorInt, @IdRes, @StringRes … › @IntDef, @StringDef › @Px, @Dimension, @DimenRes, › @CheckResult, @CallSuper › @RequiresPermission, @RequiresApi Аннотации <3 14
16. android { lintOptions { lintConfig file("$project.rootDir/tools/lint/rules-lint.xml") htmlOutput file("$project.buildDir/tools/reports/lint.html") baseline file("$project.rootDir/tools/lint/baseline-lint.xml") warningsAsErrors false abortOnError true ignore 'MissingTranslation' } } Конфигурация 16
17. Использует скомпилированные .class файлы > 400 проверок Gradle plugin, standalone, IDE plugin https://github.com/spotbugs/spotbugs- gradle-plugin Findbugs / Spotbugs 17
20. spotbugs { toolVersion "3.1.3" effort "max" ignoreFailures false reportsDir file("$buildDir/tools/reports/spotbugs") } // To generate an HTML report instead of XML tasks.withType(SpotBugsTask) { reports { xml.enabled = false html.enabled = true } } 20
21. Умный поиск «копипасты» Некоторое пересечение со Spotbugs, но все еще туча проверок Gradle plugin, standalone PMD 21
23. Гибкий. Очень гибкий Gradle plugin, standalone Checkstyle 23
25. 25 <module name="Indentation"> <property name="basicOffset" value="2"/> <property name="braceAdjustment" value="0"/> <property name="caseIndent" value="2"/> <property name="throwsIndent" value="4"/> <property name="lineWrappingIndentation" value="4"/> <property name="arrayInitIndent" value="2"/> </module> <module name="AbbreviationAsWordInName"> <property name="ignoreFinal" value="false"/> <property name="allowedAbbreviationLength" value="1"/> </module>
26. А котлин?… 26
27. Gradle plugin ktlint 27
28. <?xml version="1.0" encoding="utf-8"?> <checkstyle version="8.0"> <file name="/androidProject/app/src/main/kotlin/ru/android/example/ DraftScreenTest.kt"> <error line="43" column="1" severity="error" message="Unexpected blank line(s) before &quot;}&quot;" source="no-blank-line-before-rbrace" /> <error line="45" column="1" severity="error" message="Unexpected blank line(s) before &quot;}&quot;" source="no-blank-line-before-rbrace" /> <error line="46" column="1" severity="error" message="Needless blank line(s)" source="no-consecutive-blank-lines" /> </file> </checkstyle> 28
30. Gradle plugin, (experimental) IDE plugin Чертовски быстрый detekt 30
32. 32 build: warningThreshold: 0 failThreshold: 0 weights: complexity: 1 style: 1 empty-blocks: 2 exceptions: 2 potential-bugs: 2 performance: 1 complexity: active: true LongMethod: active: false threshold: 20 ComplexInterface: active: false threshold: 10 includeStaticDeclarations: true
33. Как запускать и не забывать
34. 34 Есть CI Нет CI );
35. «Заведите себе CI!»
36. Алёна Манюхина Android-разработчик @aleien aleien@yandex-team.ru That’s all, folks?
37. /projectDir/.git/hooks/pre-commit /projectDir/.git/hooks/pre-push ./gradlew detektCheck ktlint app:lintDevDebug git-hooks (svn-hooks) 37
38. Marketplace/integrations 38 Code Factor Codebeat Codacy Code Climate BetterCode Hub
46. Что у нас? 46
47. Алёна Манюхина Android-разработчик @aleien aleien@yandex-team.ru Спасибо за рыбу!