补齐Android技能树 - 玩转Gradle插件 | 小册免费学(上)

简介: 本节就来了解下:Gradle插件编写的知识储备 及 插件发布相关 姿势,读者亦可自行查阅官方文档:Packaging a plugin

在上一节《补齐Android技能树 - 玩转Gradle(二)》 提到过插件,有下面这样一段话:


Gradle自身 并没有提供编译打包的功能,它只是一个 负责定义流程和规则的框架,具体的编译工作都是由 插件 来完成的,比如编译Java用Java插件,编译Kotlin用Kotlin插件。插件的本质就是:定义Task,并具体执行这些Task的模板


本节就来了解下:Gradle插件编写的知识储备插件发布相关 姿势,读者亦可自行查阅官方文档:Packaging a plugin


Gradle插件本质上是一个jar文件,可以用idea创建项目,也可以使用gradle init命令创建,示例如下:


网络异常,图片无法展示
|


Tips:选择Groovy、Java、Kotlin实现都可,脚本DSL选Groovy、Kotlin皆可,笔者都用的Groovy ~


0x1、Gradle插件分类


1. 构建脚本


严格来说不上插件,就是把构建脚本代码写到一个单独的文件中,复制粘贴到项目目录下引用。示例如下:


外部构建脚本:other.gradle


// 脚本内部访问
def versionName = "v1.0.0"
def versionDesc = "第一个版本"
// 脚本外部访问
ext {
    author = "CoderPig"
}
// Task任务
task printVersionInfo {
    doLast {
        println "$versionName → $versionDesc"
    }
}


build.gradle中引用此脚本:


apply from: 'other.gradle'
task test {
    dependsOn(printVersionInfo)
    doFirst { println(author) }
    doLast { println("build.gradle里的task") }
}


键入 gradle test 执行任务结果输出如下:


网络异常,图片无法展示
|


2. buildSrc项目


执行Gradle时会将根目录下的buildSrc目录作为插件源码目录进行编译,并将结果加入到构建脚本的classpath中。


这种插件不需要plugins{}引入,一般适合没有复用性的插件或者新插件开发调试用,还有个缺点:无法使用属性配置DSL,需通过 configure<...> {...} 配置插件属性。


3. 独立项目


将项目打成jar包,可在多个项目间复用,一般的插件开发都是指的这一类~


0x2、Gradle Plugin Demo 初体验


我们上面通过命令行创建了一个Gradle插件项目,接着来康一康都有哪些核心要素( 顺带吐槽下网上一堆说得不清不楚的文章...)


1. 项目组成


① 插件实现类:CpPluginPlugin.groovy


package cn.coderpig.plugins
import org.gradle.api.Project
import org.gradle.api.Plugin
public class CpPluginPlugin implements Plugin<Project> {
    public void apply(Project project) {
        // 注册一个Task
        project.tasks.register("greeting") {
            doLast {
                println("Hello from plugin 'cn.coderpig.plugins.greeting'")
            }
        }
    }
}


代码比较浅显易懂,实现了 Plugin 接口,指定泛型类为Project,定义了apply方法,并注册了一个名为greeting带闭包的Task,打印一句话。


② 根目录下的 build.gradle


// 引用java gradle插件开发插件、groovy支持
plugins {
    id 'java-gradle-plugin'
    id 'groovy'
}
gradlePlugin {
    plugins {
        greeting {
            // 插件id
            id = 'cn.coderpig.plugins.greeting'
            // 插件实现类
            implementationClass = 'cn.coderpig.plugins.CpPluginPlugin'
        }
    }
}


Tips:网上很多Gradle插件开发教程还要另外配置一个 properties 文件,如:


src/main/resources/META-INF/gradle-plugins/cn.coderpig.plugins.greeting.properties


文件内容如下:


implementation-class=cn.coderpig.plugins.CpPluginPlugin

实际上,在build.gradle中声明了gradlePlugin就可以了,无需另外再配置一遍!


2. 插件本地发布


使用插件可以使用上面的buildSrc方式引入,也可以先打成jar包,自用就发布到本地,分享给别人用就发布到Maven或者JCenter仓库。先试试发布到本地吧,需要添加Maven相关的配置:


plugins {
    // 添加maven插件
    id 'maven'
}
uploadArchives {
    repositories.mavenDeployer {
        repository(url: uri('C:\\Users\\用户名\\Maven\\repo'))   // 本地仓库路径
        pom.groupId = "cn.coderpig.plugins"// 唯一标识(通常为模块包名,也可以任意)
        pom.artifactId = "CpPluginPlugin" // 项目名称(通常为类库模块名称,也可以任意)
        pom.version = "0.0.1"      // 版本号
    }
}


配置完Sync Now重新构建下项目,在Gradle窗口就会多出一个uploda目录,里面的 uploadArchives 就是将插件类库发布到仓库的Task:


网络异常,图片无法展示
|


双击执行此task,在 C:\Users\用户名\Maven\repo 下生成下述文件:


网络异常,图片无法展示
|


发布到本地Maven后,就可以在另一个项目中引用验证插件效果,先修改根目录的 build.gradle


buildscript {
    repositories {
        ...
        // 本地Maven地址
        maven { url 'C:\\Users\\用户名\\Maven\\repo' }
    }
    dependencies {
        ...
        // 插件依赖
        classpath "cn.coderpig.plugins:cpplugin:0.0.1"
    }
}


app目录或module目录的 build.gradle 引用此插件:


相关文章
|
7月前
|
SQL 人工智能 移动开发
Android Studio插件版本与Gradle 版本对应关系
Android Studio插件版本与Gradle 版本对应关系
Android Studio插件版本与Gradle 版本对应关系
|
7月前
|
Java 开发工具 Android开发
Cocos Creator 2.4.6 Android Gradle 版本升级为 6.5.1(插件4.1.0)
Cocos Creator 2.4.6 Android Gradle 版本升级为 6.5.1(插件4.1.0)
200 1
|
5天前
|
Java Android开发
Android零基础入门(二)gradle的安装和详解
Android零基础入门(二)gradle的安装和详解
14 0
|
2月前
|
Java 开发工具 Android开发
Android Studio Gradle文件解释其作用
Android Studio Gradle文件解释其作用
28 2
|
5月前
|
开发工具 Android开发 开发者
Android 项目编译 Gradle 配置说明
Android 项目编译 Gradle 配置说明
160 0
|
5月前
|
存储 缓存 Java
Gradle笔记 八 Gradle 插件(二)
Gradle笔记 八 Gradle 插件
72 0
|
5月前
|
Java
Gradle笔记 八 Gradle 插件(一)
Gradle笔记 八 Gradle 插件
81 0
|
6月前
|
Java Maven Android开发
android之gradle配置仓库与引入依赖
android之gradle配置仓库与引入依赖
283 0
|
10天前
|
存储 安全 Android开发
安卓应用开发:构建一个高效的用户登录系统
【5月更文挑战第3天】在移动应用开发中,用户登录系统的设计与实现是至关重要的一环。对于安卓平台而言,一个高效、安全且用户体验友好的登录系统能够显著提升应用的用户留存率和市场竞争力。本文将探讨在安卓平台上实现用户登录系统的最佳实践,包括对最新身份验证技术的应用、安全性考量以及性能优化策略。
|
13天前
|
前端开发 Android开发 iOS开发
【Flutter前端技术开发专栏】Flutter在Android与iOS上的性能对比
【4月更文挑战第30天】Flutter 框架实现跨平台移动应用,通过一致的 UI 渲染(Skia 引擎)、热重载功能和响应式框架提高开发效率和用户体验。然而,Android 和 iOS 的系统差异、渲染机制及编译过程影响性能。性能对比显示,iOS 可能因硬件优化提供更流畅体验,而 Android 更具灵活性和广泛硬件支持。开发者可采用代码、资源优化和特定平台优化策略,利用性能分析工具提升应用性能。
【Flutter前端技术开发专栏】Flutter在Android与iOS上的性能对比