Gradle plugins 101

Gradle Plugins 101
Getting up and running
@ddimitrov

Gradle bootstraps your build extensions
If you put some code in a project named buildSrc, directly under the
root of your build, Gradle will automatically compile them and add them
to the classpath of the main build.
This allows you to quickly hack plugins, tasks or utility classes that you
use in your build scripts.
https://docs.gradle.org/current/userguide/organizing_build_logic.html#sec:build_sources

You can put all the code for your plugin in one file
class MyPlug implements Plugin<Project> {
void apply(Project project) {
def plug = project.extensions.create('timer', MyPlugExtension, project)
def countClasses = project.task('countClasses', type: CountClassesTask) as CountClassesTask
countClasses.input = project.file(project.buildDir, 'classes')
}
}
class MyPlugExtension {
Project project
void start() { project.ext.timestamp = System.currentTimeMillis() }
void end() { project.logger.lifecycle("Time elapsed ${System.currentTimeMillis() - project.timestamp}") }
}
class CountClassesTask extends DefaultTask {
@InputDirectory File input
@OutputFile File output
@TaskAction
void generateClassCountFile() {
def counter=0
def cfv = [visitFile: { file, attrs -> counter++ } ].withDefault { file, attrs -> } as FileVisitor
Files.walkFileTree(input.toPath(),cfv)
output.text = "$counter files"
}
}
Not necessarily a good idea, but I can and I often do

Use extensions to expose plugin level configuration
}
}
Project project
}
@TaskAction
def counter=0
}
}
That means mostly settings.
Actually, you can put utility methods too,
but better keep them to config phase.
P.S. if you are not sure what the pre
paragraph means - just do settings.

Use tasks to do stuff
}
}
Project project
}
@TaskAction
def counter=0
}
}
BTW, these strings are the names by
which the tasks and extensions would
appear in your build script when you apply
the plugin.

Create a property file referring to your plugin class
}
}
Project project
}
@TaskAction
def counter=0
}
}
implementation-class=com.bar.MyPlug

Apply the plugin using the name of the props file
}
}
Project project
}
@TaskAction
def counter=0
}
}
apply plugin: 'my-plug'
timer.start()
tasks.countClasses.output = file('class-count.txt')
timer.end()

Your extension and predefined tasks are applied
}
}
Project project
}
@TaskAction
def counter=0
}
}
timer.start()
timer.end()

You can call methods and set props on them
}
}
Project project
}
@TaskAction
def counter=0
}
}
timer.start()
timer.end()
rootProject.name = 'tasks-and-plugins'

So, this is what the build looks like - modular...
}
}
Project project
}
@TaskAction
def counter=0
}
}
timer.start()
timer.end()

...and cohesive
}
}
Project project
}
@TaskAction
def counter=0
}
}
timer.start()
timer.end()

Don’t forget to name your root project!
}
}
Project project
}
@TaskAction
def counter=0
}
}
timer.start()
timer.end()
rootProject.name = 'tasks-and-plugins'

If you do this you can start debugging your builds!
gradlew -Dorg.gradle.debug=true --no-daemon build
● Attach remote debugger on port 5005
● Set breakpoints in your plugins and tasks under buildSrc
● Or Gradle classes that you see from the debug log
● You still cannot set breakpoints in the init scripts and build scritps.
One more reason to keep them declarative.
Keep in mind that Gradle decorates some objects such as tasks and extensions,

Gradle plugins 101

Empfohlen

Empfohlen

Weitere ähnliche Inhalte

Was ist angesagt?

Was ist angesagt? (20)

Andere mochten auch

Andere mochten auch (18)

Ähnlich wie Gradle plugins 101

Ähnlich wie Gradle plugins 101 (20)

Kürzlich hochgeladen

Kürzlich hochgeladen (20)

Gradle plugins 101