Pragmatic Gradle for your Multi-Module Projects

DroidCon Boston 2018

https://github.com/cliveleehere/multimodulegradle

I will be updating this project as I find more tips!

Transcript

1. Pragmatic Gradle for your Multi-Module Projects @CliveLeeHere
2. https://www.oviahealth.com/careers
3. https://www.oviahealth.com/careers
4. Terminology
5. { Project
6. { Project Root Project
7. { Project
8. Project Modules
9. Project Modules Subproject
10. Project Modules
11. Project Modules App
12. Project Modules App Libraries
14. “Pragmatic”
21. “Multi-Module”
25. App 1 Library Feature B Feature A App 2
26. App 1 feature1- presentation feature1- data feature1- domain feature2- presentation feature2- data feature2- domain ui-common network App 2
29. Tips https://github.com/cliveleehere/multimodulegradle
30. But First…
31. But First… ! Update Gradle (4.6)
32. But First… ! Update Gradle (4.6) ! Update Android Gradle Plugin (3.0.1)
33. But First… ! Update Gradle (4.6) ! Update Android Gradle Plugin (3.0.1) ! android-cache-fix-gradle-plugin
34. But First… ! Update Gradle (4.6) ! Update Android Gradle Plugin (3.0.1) ! android-cache-fix-gradle-plugin ! Gradle Properties
35. But First… ! Update Gradle (4.6) ! Update Android Gradle Plugin (3.0.1) ! android-cache-fix-gradle-plugin ! Gradle Properties AWESOME!
36. Update Gradle ./gradle-wrapper.properties
 distributionUrl=...-4.6-all.zip
37. Update Gradle ./gradle-wrapper.properties
 distributionUrl=...-4.6-all.zip or File > Project Structure > Project
38. Android Gradle Plugin ./build.gradle classpath
 'com.android.tools.build:gradle:3.0.1' or File > Project Structure > Project
39. Android Gradle Plugin ./build.gradle classpath
 'com.android.tools.build:gradle:3.0.1' or File > Project Structure > Project
40. android-cache-fix-gradle-plugin ./build.gradle plugins { id "org.gradle.android.cache-fix" version "0.3.6" }
41. Gradle.Properties
42. Gradle.Properties org.gradle.parallel=true
43. Gradle.Properties org.gradle.parallel=true org.gradle.caching=true
44. Gradle.Properties org.gradle.parallel=true org.gradle.caching=true org.gradle.configureondemand=true
45. Gradle.Properties org.gradle.parallel=true org.gradle.caching=true org.gradle.configureondemand=true
46. Parallel Execution
48. Dependency Management
49. Terminology: Dependency
50. Terminology: Dependency ‘com.google.dagger:dagger:2.15’ implementation
51. Terminology: Dependency ‘com.google.dagger:dagger:2.15’ coordinates
52. Terminology: Dependency ‘com.google.dagger:dagger:2.15’ group coordinates
53. Terminology: Dependency ‘com.google.dagger:dagger:2.15’ group name coordinates
54. Terminology: Dependency ‘com.google.dagger:dagger:2.15’ group name coordinates version
55. The Problem
56. The Problem ./app/build.gradle implementation ‘com.google.dagger:dagger:2.15’
57. The Problem ./app/build.gradle implementation ‘com.google.dagger:dagger:2.15’ ./lib/build.gradle implementation¡ ‘com.google.dagger:dagger:2.15’
58. The Problem ./app/build.gradle implementation ‘com.google.dagger:dagger:2.15’ ./lib/build.gradle implementation¡ ‘com.google.dagger:dagger:2.15’ implementation ‘com.google.dagger:dagger-android:2.15’
60. Dependency Management, part 1
61. Dependency Management, part 1 ./build.gradle ext { DAGGER=‘2.15’ }
62. Dependency Management, part 1 ./build.gradle ext { DAGGER=‘2.15’ } ./app/build.gradle implementation “com.google.dagger:dagger:$DAGGER”
63. Dependency Management, part 1 ./app/build.gradle implementation “com.google.dagger:dagger:$DAGGER”
64. Dependency Management, part 1 ./app/build.gradle implementation “...:$rootProject.ext.daggerVersion”
65. Dependency Management, part 1 ./app/build.gradle implementation “...:$DAGGER_VERSION”
66. Dependency Management, part 2
67. Dependency Management, part 2 ./build.gradle ext { DAGGER_VERSION=‘2.15’ dagger=“com.google.dagger:dagger: $DAGGER_VERSION” } ./app/build.gradle implementation rootProject.ext.dagger
68. Dependency Management, part 2 ./build.gradle ext { DAGGER_VERSION=‘2.15’ dagger=“com.google.dagger:dagger:$DAGGER_VERSION” } ./app/build.gradle implementation rootProject.ext.dagger
69. Dependency Management, part 2 rootProject.ext.dagger
70. Dependency Management, part 2 rootProject.dagger
71. Dependency Management, part 2 dagger
72. Dependency Management, part 2 daggerLibrary
73. Dependency Management, part 3
74. Dependency Management, part 3 ./build.gradle ./app/build.gradle ./versions.gradle
75. Dependency Management, part 3 ./versions.gradle ext.deps = [:]
76. Dependency Management, part 3 ./versions.gradle ext.deps = [:] def versions = [:] versions.dagger = "2.15"
77. Dependency Management, part 3 ./versions.gradle ext.deps = [:] def versions = [:] versions.dagger = "2.15" def deps = [:] def dagger = [:] dagger.runtime = "com.google.dagger:dagger$versions.dagger"
78. Dependency Management, part 3 ./versions.gradle ext.deps = [:] def versions = [:] versions.dagger = "2.15" def deps = [:] def dagger = [:] dagger.runtime = "com.google.dagger:dagger$versions.dagger" deps.dagger = dagger ext.deps = deps
79. Dependency Management, part 3 ./app/build.gradle ./build.gradle ./versions.gradle
80. Dependency Management, part 3 ./build.gradle buildscript { apply from: ‘./versions.gradle' }
81. Dependency Management, part 3 ./versions.gradle ./build.gradle ./app/build.gradle
82. Dependency Management, part 3 ./app/build.gradle dependencies { implementation deps.dagger.runtime
84. WHOA!
85. Dependency Management, part 4 ./buildSrc/src/main/java/../Deps.java
86. Dependency Management, part 4 ./buildSrc/src/main/java/../Deps.java package com.example.gradle; public class Deps { public static final String guava = "com.google.guava:guava:18.0"; }
87. Dependency Management, part 4 ./app/build.gradle import com.example.Deps; dependencies { implementation Deps.guava ./buildSrc/src/main/java/../Deps.java
88. Dependency Management, part 5
89. Dependency Management, part 5 ./buildSrc/src/main/java/../Deps.kt object Libs { val guava = “com.google.guava:guava:18.0”
90. Dependency Management, part 5 ./buildSrc/build.gradle.kts plugins { `kotlin-dsl` } ./buildSrc/src/main/java/../Deps.kt
91. Other Constants
92. Other Constants ./build.gradle ext { minSdkVersion = 18
93. Other Constants ./build.gradle ./versions.gradle def build_versions = [:] build_versions.min_sdk = 14 ext.build_versions = build_versions
94. Other Constants ./build.gradle ./versions.gradle ./buildSrc/src/main/java/../Deps.java public class Deps { public static final String minSdk = “14";
96. Sharing
98. YUM!
99. apply plugin: 'kotlin-kapt'
100. apply plugin: 'kotlin-kapt' apply from: “./versions.gradle"
101. apply from: “./versions.gradle"
102. Project Modules App Libraries
103. App 1 feature1- presentation feature1- data feature1- domain feature2- presentation feature2- data feature2- domain ui-common network App 2
104. App 1 feature1- presentation feature1- data feature1- domain feature2- presentation feature2- data feature2- domain ui-common network App 2
105. App 1 feature1- presentation feature1- data feature1- domain feature2- presentation feature2- data feature2- domain ui-common network App 2
106. App 1 feature1- presentation feature1- data feature1- domain feature2- presentation feature2- data feature2- domain ui-common network App 2
107. App 1 feature1- presentation feature1- data feature1- domain feature2- presentation feature2- data feature2- domain ui-common network App 2
108. feature1- domain feature2- domain
109. feature1- domain feature2- domain ./f1-domain/ build.gradle dependencies { ... }
110. feature1- domain feature2- domain ./f1-domain/ build.gradle dependencies { ... } ./f2-domain/ build.gradle dependencies { ... }
111. feature1- domain feature2- domain ./f1-domain/ build.gradle apply from: “/shared- domain.gradle” ./f2-domain/ build.gradle dependencies { ... }
112. feature1- domain feature2- domain ./f1-domain/ build.gradle apply from: “/shared- domain.gradle" ./f2-domain/ build.gradle apply from: “/shared- domain.gradle"
113. feature1- domain feature2- domain ./shared-domain.gradle dependencies { ... } ./f1-domain/ build.gradle ./f2-domain/ build.gradle
114. App 1 feature1- presentation feature1- data feature1- domain feature2- presentation feature2- data feature2- domain ui-common network App 2
115. App 1 feature1- presentation feature1- data feature1- domain feature2- presentation feature2- data feature2- domain ui-common network App 2
116. feature1- data feature2- data network ./.../build.gradle apply from: “../shared-domain.gradle” apply from: “../shared-data.gradle”
117. feature1- data feature2- data network ./.../build.gradle ./shared-data.gradle dependencies { ... }
118. App 1 feature1- presentation feature1- data feature1- domain feature2- presentation feature2- data feature2- domain ui-common network App 2
119. App 1 feature1- presentation feature1- data feature1- domain feature2- presentation feature2- data feature2- domain ui-common network App 2
120. feature1- presentation feature1- data feature2- presentation feature2- data ui-common network ./shared-android.gradle android { ... }
121. App 1 feature1- presentation feature1- data feature1- domain feature2- presentation feature2- data feature2- domain ui-common network App 2
122. App 1 feature1- presentation feature1- data feature1- domain feature2- presentation feature2- data feature2- domain ui-common network App 2
123. App 1 feature1- presentation feature2- presentation App 2 ./shared-variants.gradle android {Ω flavorDimensions “function” productFlavors { ... } }œ configurations { ... }
124. App 1 feature1- presentation feature2- presentation App 2 ./shared-variants.gradle android {Ω... flavorDimensions“function”productFlavors{ ... } }œ configurations { ... }
125. App 1 feature1- presentation feature2- presentation App 2 ./shared-variants.gradle android {Ω... flavorDimensions“function”productFlavors{ ... } }œ configurations { ... } android.variantFilter { ... }
126. App 1 feature1- presentation feature2- presentation App 2 ./shared-variants.gradle android {Ω... flavorDimensions“function”productFlavors{ ... } }œ configurations { ... } android.variantFilter { ... }
127. App 1 feature1- presentation feature1- data feature1- domain feature2- presentation feature2- data feature2- domain ui-common network App 2
128. App 1 feature1- presentation feature1- data feature1- domain feature2- presentation feature2- data feature2- domain ui-common network App 2
129. App 1 App 2 ./shared-apps.gradle android { buildTypes { proguardFiles ... testProguardFile ... } } packagingOptions { ... }
130. App 1 feature1- presentation feature1- data feature1- domain feature2- presentation feature2- data feature2- domain ui-common network App 2
131. App 1 feature1- presentation feature1- data feature2- presentation feature2- data ui-common network App 2 ./shared-test.gradle android { sourceSets { test.java.srcDirs += [“...”] } }
132. App 1 feature1- presentation feature1- data feature1- domain feature2- presentation feature2- data feature2- domain ui-common network App 2
133. feature1- presentation feature1- data feature1- domain ./shared-feature1-tasks.gradle task cleanReports( type: Delete, group: 'Reports') { description "Delete Repots" delete ‘reportsDirectory' }
135. Get Organized!
137. Get Organized! ./shard-apps.gradle ./shard-android.gr ./shard-domain.gra ./shard-data.gradle ./shard-variants.gradle
138. Get Organized! ./buildscripts/ ./shard-apps.gradle ./shard-android.gradle ./shard-domain.gradle
139. Get Organized! ./settings.gradle include ‘:buildscripts’, ... ./buildscripts/ ./shard-apps.gradle
140. Renaming
143. \ or /
144. ./app/build.gradle
145. ./app/app.gradle
146. ./lib/lib.gradle ./app/app.gradle
147. ./data/data.gradle ./app/app.gradle ./lib/lib.gradle
148. ./lib/lib.gradle ./data/data.gradle ./core/core.gradle
149. ./data/data.gradle ./core/core.gradle ./util/util.gradle
150. ./settings.gradle rootProject.children.each { subproject -> subproject.buildFileName = “${subproject.name}.gradle" }
153. Renaming ! bash script (github)
154. Renaming ! bash script (github) ! new modules
156. Pitfalls*
157. Pitfalls* DON’T DO THIS
158. “core” module
159. “core” module ! For dependency management?
160. “core” module ./module1/module1.gradle dependency { implementation deps.dagger implementation deps.timber implementation reps.rxjava }
161. “core” module ./core/core.gradle dependency { api deps.dagger api deps.timber api reps.rxjava }
162. App Core Library “core” module ./core/core.gradle
164. “core” module ! For dependency management? ! Don’t enlarge the surface!
165. “core” module ! For dependency management? ! Don’t enlarge the surface! ! Slower builds
166. “core” module ! For dependency management? ! Don’t enlarge the surface! ! Slower builds ! Shared gradle file instead
167. Nested Modules
168. Nested Modules feature1- presentation feature1- data feature1- domain
169. Nested Modules ./feature1 |-feature1-presentation |-feature1-data |-feature1-domain
171. Nested Modules ! Slower reloading project
172. Nested Modules ! Slower reloading project ! Does not show up in Android view
173. Nested Modules ! Slower reloading project ! Does not show up in Android view ! Relative paths
174. If you insist…
175. 1. Git History > mkdir feature1 > git mv feature1-domain ./feature1/ feature1-domain ...
176. 2. Replace Relative Paths apply from: "../buildscripts/shared- android.gradle"
177. 2. Replace Relative Paths apply from: "$BUILDSCRIPTS_DIR/shared- test.gradle"
178. 3. Additional Settings implementation project(“:feature1-data“)
179. 3. Additional Settings implementation project(“:feature1:feature1-data“)
180. 3. Additional Settings implementation project(“:feature1-data“) ./settings.gradle include ‘:feature1-data' project (':feature1-data').projectDir = new File('./feature1/feature1-data')
181. Resources https://google.github.io/android-gradle-dsl/current/ https://docs.gradle.org/current/dsl/index.html https://gradle.org/releases/ https://gradle.org/guides/ http://www.developerphil.com/ https://developer.android.com/studio/build/optimize-your- build.html
 https://github.com/cliveleehere/multimodulegradle
 Google I/O 2017 “What's New in Android Development Tools”
182. Thanks! @CliveLeeHere