How to create a basic Gradle plugin that interacts with Android New Build System. Video in russian can be found here: https://events.yandex.ru/lib/talks/2447/

2. Plugin for plugin,
or extending
Android New Build System
Anton Rutkevich

3. About me
› 4+ years of Android development
› Mobile game-dev experience
› At Yandex:
1. Mobile Yandex.Metrica
2. Continuous Integration

4. Не удается отобразить рисунок. Возможно, рисунок
поврежден или недостаточно памяти для его открытия.
Перезагрузите компьютер, а затем снова откройте файл.
Если вместо рисунка все еще отображается красный
крестик, попробуйте удалить рисунок и вставить его
заново.
Why do I need this?
Intro

5. What can be done?
› Additional resources/code/manifest processing
› Output processing (apk, aar, jar)
› Other things

6. Story
Prod / test
servers
Flavors!
LoTgesst o /n /poroffd
AaUndnasil qyotunice/s bo uffi ld
numb...e r!
I want to
configure it
myself!
2 Flav3o rs!
FlaHvmorms?.. .
Manager Android dev

7. How should it work
Java code build.gradle Teamcity
Actual value:
"https://my.server.com"
CI server can do it
Our job

8. Insert CI value into BuildConfig.java
// app/build.gradle
apply plugin: 'com.android.application'
android {"
defaultConfig {
buildConfigField "String", "URL", ""${teamcity['server-url']}""
buildConfigField "String", "URL", ""#server-url""
}"
}
project.teamcity = [
"server-url" : "https://my.server.com"
// ..."
]
url']}"".

9. Use BuildConfig.java from Java
public class SomeJavaClass {
"
// ...
public static final String SERVER_URL = "https://my.server.com";
public static final String SERVER_URL = BuildConfig.URL;
// ...
}

10. BuildConfig placeholder plugin
› Replaces placeholder values with values from some map
› Map can come from anywhere

11. Goal
// app/build.gradle
apply plugin: 'com.android.application'
apply plugin: 'placeholder'
"
placeholder {"
replacements = project.teamcity
}
android {"
defaultConfig {"
buildConfigField "String", "URL", ""#server-url"""
}"
}

12. Table of contents
› Gradle basics
› New Build System workflow
› Hello, Gradle plugin!
› Extending Android New Build System

13. Не удается отобразить рисунок. Возможно, рисунок
поврежден или недостаточно памяти для его открытия.
Перезагрузите компьютер, а затем снова откройте файл.
Если вместо рисунка все еще отображается красный
крестик, попробуйте удалить рисунок и вставить его
заново.
Tools we will use
Gradle basics

14. Plugins everywhere
NBS

15. Tasks
› Can be configured with { }
› Consist of actions
› Can depend on other tasks
› Can have inputs / outputs

16. Task consists of actions
Task
Action Action
Action Action
doFirst() doLast(), or <<

17. Tasks execution order
Task 2
Task 3
Task 4
dependsOn
dependsOn
dependsOn
Execution order
Task 1
Task 2 Task 3 Task 4 Task 1

18. Outputs
Task inputs / outputs
Inputs Task
Inputs & outputs did not change
=>
UP-TO-DATE

19. Task example
task myTask {
ext.myMessage = "hello"
}
myTask << {
println myMessage
}
task otherTask(dependsOn: myTask)

20. Task example output
>> gradle otherTask
:app:myTask
hello
:app:otherTask

21. Build lifecycle
settings.gradle
build.gradle
Initialization Configuration Execution
Projects creation
Projects
configuration
Tasks creation
Tasks configuration
project.afterEvaluate { }
Task graph execution
Task graph
Build initialization

22. The New Build System
workflow
Не удается отобразить рисунок. Возможно, рисунок
поврежден или недостаточно памяти для его открытия.
Перезагрузите компьютер, а затем снова откройте файл.
Если вместо рисунка все еще отображается красный
крестик, попробуйте удалить рисунок и вставить его
заново.
What's so special?

23. What tasks will be launched?
build
check assemble
assembleDebug assembleRelease
Guaranteed assemble<VariantName>

24. Android project build overview

25. Tasks we will need
assemble<VariantName>
....
generate<VariantName>BuildConfig
....
compile<VariantName>Java
....

26. Variant API
Source code
is your documentation!
› Access to most variant's tasks
› Variant output related properties
› Different for apps & libraries

27. Hello, Gradle plugin!
Не удается отобразить рисунок. Возможно, рисунок
поврежден или недостаточно памяти для его открытия.
Перезагрузите компьютер, а затем снова откройте файл.
Если вместо рисунка все еще отображается красный
крестик, попробуйте удалить рисунок и вставить его
заново.
The first steps

28. The very basic one
src/main/groovy/com/example/gradle/PlaceholderPlugin.gradle
public class PlaceholderPlugin implements Plugin<Project> {
@Override"
void apply(Project project) {
project.task('hello') << {"
println "Hello Gradle plugin!"
}
}
}

29. Bind plugin class to plugin name
src/main/resources/META-INF/gradle-plugins/placeholder.properties
implementation-class=com.example.gradle.PlaceholderPlugin

30. Extension
Extension

31. Add extension
src/main/groovy/com/example/gradle/PlaceholderExtension.gradle
class PlaceholderExtension {"
def replacements = [:]
}"

32. Add extension
@Override"
void apply(Project project) {"
PlaceholderExtension extension = project.extensions.create("
"placeholder", PlaceholderExtension"
);
project.task('hello') << {
println "Hello Gradle plugin!"
println "Hi, ${project.placeholder.replacements}"
}
}"

33. Use extension
// app/build.gradle
apply plugin: 'placeholder'"
"
placeholder {"
replacements = ["server-url" : "https://my.server.com"]
}"
---------------------------------------------
>> gradle hello
:app:hello"
Hi, [server-url:https://my.server.com]

34. Extending
The New Build System
Не удается отобразить рисунок. Возможно, рисунок
поврежден или недостаточно памяти для его открытия.
Перезагрузите компьютер, а затем снова откройте файл.
Если вместо рисунка все еще отображается красный
крестик, попробуйте удалить рисунок и вставить его
заново.
Let's do it!

35. Check for New Build System
// PlaceholderPlugin.groovy
@Override"
void apply(Project project) {
if (project.hasProperty("android")) {
PlaceholderExtension extension = project.extensions.create("
"placeholder", PlaceholderExtension"
);
def android = project.android
// all code goes here
}
}"

36. Let the New Build System do its job
// PlaceholderPlugin.apply()
if (project.hasProperty("android")) {
PlaceholderExtension extension = project.extensions.create("
"placeholder", PlaceholderExtension"
);
def android = project.android
project.afterEvaluate {"
// at this point we have all
// tasks from New Build System
}
}

37. Process every variant
// PlaceholderPlugin.apply()
project.afterEvaluate {
if (android.hasProperty('applicationVariants')) {
android.applicationVariants.all { variant ->
addActions(project, variant, extension)
}
} else if (android.hasProperty('libraryVariants')) {
android.libraryVariants.all { variant ->
addActions(project, variant, extension)
}
}
}

38. Add task
// PlaceholderPlugin.groovy
def addActions(Project project, variant,
PlaceholderExtension extension) {
Task processPlaceholders = project.task(
"process${variant.name.capitalize()}Placeholders"
)
processPlaceholders << {
println "I will replace ${variant.name}!"
}
}

39. Insert task into build process
assemble<VariantName>
....
generate<VariantName>BuildConfig
....
process<VariantName>Placeholders
compile<VariantName>Java
....

40. Insert task into build process
// PlaceholderPlugin.groovy
def addActions(Project project, variant,
PlaceholderExtension extension) {
Task processPlaceholders = ...
...
variant.javaCompile.dependsOn processPlaceholders"
processPlaceholders.dependsOn variant.generateBuildConfig
}

41. Does it really work?
>> gradle assembleDebug
:app:preBuild
...
:app:generateDebugBuildConfig
...
:app:processDebugPlaceholders
I will replace debug!
:app:compileDebugJava
...

42. Actual work. Perform replacements
// PlaceholderPlugin.addActions()
processPlaceholders << {
def buildConfigFile = getBuildConfig(variant)
"
extension.replacements.each { replacement ->"
project.ant.replace("
file: buildConfigFile,"
token: "#${replacement.key}",
value: replacement.value"
)"
}
}

43. Handling inputs / outputs
process
Placeholders
BuildConfig.java
BuildConfig.java
BuildConfig.java
replacements
generate
BuildConfig
...
replacements
<< Action

44. Replace task with 'doLast'
// PlaceholderPlugin.addActions()
processPlaceholders << {
variant.generateBuildConfig << {
def buildConfigFile = ...
extension.replacements.each { ... }
}
variant.generateBuildConfig.inputs.property(
"replacements", extension.replacements
)

45. │ We've done it!

46. Remember how to use it?
// app/build.gradle
apply plugin: 'com.android.application'"
apply plugin: 'placeholder'"
"
placeholder {"
replacements = project.teamcity
}"
"
android {"
defaultConfig {"
buildConfigField "String", "URL", ""#server-url"""
}"
}

47. Does it work?
app/build/generated/source/buildConfig/debug/com/example/
sample/BuildConfig.java
public final class BuildConfig {"
// Fields from default config."
public static final String URL = "https://my.server.com";
}

48. Не удается отобразить рисунок. Возможно, рисунок
поврежден или недостаточно памяти для его открытия.
Перезагрузите компьютер, а затем снова откройте файл.
Если вместо рисунка все еще отображается красный
крестик, попробуйте удалить рисунок и вставить его
заново.
To summarize

49. Key steps
› Create Gradle plugin
› Inside afterEvaluate { }
› Process every variant
› Add action to generateBuildConfig
› Handle inputs / outputs

50. What's next?
› Default values support
› Errors handling
› Publish ( jcenter / mavenCentral / other )

51. Links
Gradle
http://www.gradle.org/
The New Build System
http://tools.android.com/tech-docs/new-build-system
http://tools.android.com/tech-docs/new-build-system/build-workflow
Github sample
https://github.com/roottony/android-placeholder-plugin

52. Thank you for your attention!
Anton Rutkevich
Senior software engineer
antonrut@yandex-team.ru
anton.rutkevich@gmail.com