gradle post source sets and optimization added

Author: maciej-nowak

_drafts/2019-09-16-gradle.md

@@ -6,7 +6,7 @@ categories: ["Budowanie"]
 image: build/gradle
 github: build/tree/master/gradle
 description: "Budowanie"
-keywords: "budowanie, kompilacja, konfiguracja, build, gradle, apk, properties, configuration, flavor, android, programowanie, programming"
+keywords: "budowanie, kompilacja, konfiguracja, build, gradle, apk, properties, configuration, variant, type, flavor, splits, android, programowanie, programming"
 ---
 
 ## Wstęp
@@ -16,11 +16,11 @@ System budowania aplikacji `Android` kompiluje zasoby, kod źródłowy oraz paki
 Budowanie aplikacji angażuje wiele narzędzi i uruchamia różne procesy umożliwiające konwersje projektu do `APK`. Typowy proces przebiega następująco. Na początku kompilator konwertuje kod źródłowy do plików `DEX` (`Dalvik Executable`) zawierających kod bajtowy, a pozostałe pliki i zależności do skompilowanych zasobów. Następnie `APK Packager` łączy i optymalizuje pliki `DEX` i skompilowane zasoby do jednego pliku `APK` podpisując go kluczem `debug` lub `release` z `keystore`. Powstały plik `APK` jest gotowy do instalacji, debugowania czy testowania.
 
 ## Konfiguracja 
-Dokonując konfiguracji budowania projektu można wyróżnić kilka aspektów wpływających na wyjściowy rezultat. `buildTypes` definiuje właściwości dla wydań (np. zaciemnienie release), `productFlavors` reprezentuje różne wersje aplikacji (np. płatna, darmowa, demo) które mogą używać współdzielonych jak i prywatnych zasobów natomiast `buildVariants` jest konkretnym wariantem budowania wynikającym z połączenia wybranych `buildTypes` i `productFlavors`. Wartości wpisów w `AndroidManifest` mogą się różnić w zależności od wariantu budowania (np. inna nazwa czy różne minSdk). System budowania zarządza także wpisami lokalnych i zdalnych zależności `dependencies` dzięki czemu nie ma potrzeby ręcznego szukania, pobierania i kopiowania pakietów zależności do projektu. Ponadto umożliwia ustawienie podpisu autentykacyjnego i zasad bezpieczeństwa `ProGuard` oraz wspiera budowanie wielu `APK`.
+Dokonując konfiguracji budowania projektu można wyróżnić kilka aspektów wpływających na wyjściowy rezultat. `buildTypes` definiuje właściwości dla wydań (np. zaciemnienie release), `productFlavors` reprezentuje różne wersje aplikacji (np. płatna, darmowa, demo). `buildVariants` jest konkretnym wariantem budowania wynikającym z połączenia wybranych `buildTypes` i `productFlavors`, które mogą używać współdzielonych jak i prywatnych zasobów. Wartości wpisów w `AndroidManifest` mogą się różnić w zależności od wariantu budowania (np. inna nazwa czy różne minSdk). System budowania zarządza także wpisami lokalnych i zdalnych zależności `dependencies` dzięki czemu nie ma potrzeby ręcznego szukania, pobierania i kopiowania pakietów zależności do projektu. Ponadto umożliwia ustawienie podpisu autentykacyjnego i zasad bezpieczeństwa `ProGuard` oraz wspiera budowanie wielu `APK`.
 
 ## Pliki
-Informacje nt konfiguracji znajdują sie w kilku plikach projektu. Używają one `DSL` (`Domain Specific Language`) do opisania i manipulowania logiką przy pomocy `Groovy` (dynamicznego języka dla `JVM`). `Android Gradle plugin` dostarcza większość potrzebnych elementów `DSL` w związku z czym nie jest wymagana wiedza programowania w `Groovy`. Kod źródłowy i zasoby powinny być logicznie pogrupowane zgodnie z przynależnością do modułu, tzn. kod oraz zasoby znajdujące się w `src/main` są współdzielone przez wszystkie warianty kompilacji, natomiast np. `src/debug` tylko dla wariantu debug.  
-  
+Informacje nt konfiguracji znajdują sie w kilku plikach projektu należących do danego modułu. Używają one `DSL` (`Domain Specific Language`) do opisania i manipulowania logiką przy pomocy `Groovy` (dynamicznego języka dla `JVM`). `Android Gradle plugin` dostarcza większość potrzebnych elementów `DSL` w związku z czym nie jest wymagana wiedza programowania w `Groovy`. 
+
 `settings.gradle` deklaruje moduły, które powinny wziąć udział w procesie budowania projektu
 
 {% highlight gradle %}
@@ -94,7 +94,7 @@ android {
     // Configure multiple build types like apply Proguard for release and make debug debuggable
     buildTypes {
         release {
-            minifyEnabled false
+            minifyEnabled true
             debuggable false
             proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
         }
@@ -119,31 +119,31 @@ android {
         }
     }
 
-    // Configure different APK builds that each contains only needed code and resources for density and abi
-    // Notice that every build must have unique version code for store
-    splits {
-        density {
-            enable true
-            exclude "ldpi"
-        }
-        abi {
-            enable true
-            universalApk true
+    // Use filter to disable some build variant
+    variantFilter { variant ->
+        def flavors = variant.flavors*.name
+        def types = variant.buildType*.name
+        if (types.contains("debug") && flavors.contains("paid")) {
+            setIgnore(true)
         }
     }
 }
 
 // Provide dependencies needed only for module itself
 dependencies {
-	//local binaries
+    //local binaries
     implementation fileTree(dir: 'libs', include: ['*.jar']) 
 
     //remote binaries
     implementation 'org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version' 
     implementation 'androidx.appcompat:appcompat:1.0.2'
     implementation 'androidx.core:core-ktx:1.0.2'
 
+    //add build type or flavor prefix to use implementation only for this variant
+    paidImplementation 'com.android.billingclient:billing:2.0.1'
+
     //unit and instrumental tests
+    //notice that test and androidTest are source sets like any other build variant
     testImplementation 'junit:junit:4.12'
     androidTestImplementation 'androidx.test:runner:1.2.0'
     androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
@@ -163,4 +163,46 @@ kotlin.code.style=official
 
 {% highlight properties %}
 sdk.dir=C\:\\Android\\Sdk
-{% endhighlight %}
+{% endhighlight %}
+
+## Źródła
+Aby budowane warianty aplikacji zadeklarowane w build.gradle rzeczywiście różniły się implementacją należy stworzyć dla nich lokalizacje odpowiadające nazwie wariantu oraz umieścić tam specyficzny kod źródłowy i zasoby. Dla zdefiniowanych powyżej wariantów ich zbiory źródeł mogłyby znajdować się w: `src/debug`, `src/release`, `src/debugFree`, `src/debugPaid`, `src/releaseFree`, `src/releasePaid`. Zawartość `src/main` jest traktowana jako domyślna i współdzielona przez wszystkie warianty kompilacji natomiast źródła konkretnych wariantów nadpisują implementację bazową zgodnie z zasadą priorytetów (`build variant > build type > build flavor > main > library`).
+
+## Optymalizacja
+Tworząc konfiguracje budowania aplikacji należy rozważyć optymalizację czasu procesu kompilacji oraz rozmiaru pliku wyjściowego. Budowanie wielu `APK` dedykowanych pod konkretne architektury czy gęstości ekranów pozwala zmniejszyć rozmiar poprzez załączenie tylko wymaganych zasobów. Jednakże taki proces znacząco wydłuża czas całkowitej kompilacji w związku z czym warto wyłączyć niepotrzebne wersje oraz zawężyć wariant deweloperski. Ponadto zastosowanie zasad `ProGuard` także umożliwia redukcje rozmiaru przy jednoczesnym spowolnieniu kompilacji. Użycie statycznych zależności, trybu offline, cache czy `Instant Run` przyśpiesza budowanie projektu. W przypadku wersji produkcyjnej przeważnie dąży się przede wszystkim do optymalizacji rozmiaru natomiast w wersji deweloperskiej do optymalizacji czasu kompilacji.
+
+{% highlight gradle %}
+android {
+
+    //...
+
+    flavorDimensions "stage", "version"
+    productFlavors {
+        //...
+        
+        //add developer and production flavor with new dimension
+        dev {
+            //...
+            dimension "stage"
+            resConfigs "pl", "xxhdpi" //attach only pl resources
+        }
+        prod {
+            //...
+            dimension "stage"
+        }
+    }
+
+    // Configure different APK builds that each contains only needed code and resources for density and abi
+    // Notice that every build must have unique version code for store
+    splits {
+        density {
+            enable true
+            exclude "ldpi"
+        }
+        abi {
+            enable gradle.startParameter.taskNames.any { it.contains("release") }
+            universalApk false
+        }
+    }
+}
+{% endhighlight %}