Android Gradle 开发与应用 (五) : 基于Gradle 8.2，创建Gradle插件

1. 前言

本文介绍在Android中，如何基于Gradle 8.2，创建Gradle插件。

1.1 本文环境

  • Android Studio 版本 : Android Studio Hedgehog | 2023.1.1
  • Gralde版本 : gradle 8.2

使用 Android Gradle 插件升级助理
Android Gradle 插件版本说明

1.2 为什么要写插件

可以将相关代码抽取出来，而不是耦合在build.gradle中，成为通用性的插件，可以在多个项目中复用。
比如com.android.application就是我们最为熟悉的Android插件。

plugins {id 'com.android.application'
}

2. 创建插件

2.1 新建项目

新建MyGradlePluginTest项目，这里选择Groovy DSL。

在这里插入图片描述

2.2 新建Gradle插件Module

这里选择Java or Kotlin Library，也可以选择Android Library
在这里插入图片描述

2.3 修改build.gradle

plugins {id 'java-gradle-plugin'
}gradlePlugin {plugins {//MyTestPlugin { //这种方式也行create("MyTestPlugin") {//插件idid = 'com.heiko.myplugin'//插件的包名+类名implementationClass = 'com.heiko.myplugin.MyPlugin'}}
}

2.4 新建插件类

对应implementationClass中的路径，新建插件类 MyPlugin

package com.heiko.myplugin;import org.gradle.api.Plugin;
import org.gradle.api.Project;class MyPlugin implements Plugin<Project> {@Overridepublic void apply(Project project) {System.out.println("这是我的第一个插件!");}
}

3. 发布插件

3.1 依赖maven-publish

在build.gradle中，添加maven-publish插件，然后配置发布插件的信息和仓库信息。
这里的maven仓库配置的是本地的，仅用作演示。实际项目中，应该使用真实的maven仓库服务器更合理些。
关于maven仓库更多的操作，详见我的另一篇文章 : Android Module上传到Maven仓库 及 实现同时上传到多个Maven仓库

plugins {//...省略了代码...id 'maven-publish'
}//...省略了代码...println("原本的version:" + version)
println("原本的group:" + group)//设置group
group = 'com.heiko.group'
//设置版本号
version = "1.0.0"println("设置后的group:" + group)
println("设置后的version:" + version)afterEvaluate {/*这部分代码不需要配置，会根据gradlePlugin中的进行生成除非使用老版本的插件依赖方式(classpath):需要指定artifactId的情况下，才需要使用publications {maven(MavenPublication) {groupId = groupartifactId = 'MyPlugin'version = versionfrom components.java}}*/publishing {// 配置仓库地址repositories {maven {url = uri('../repo')}}}
}

build.gradle的完整代码如下

plugins {id 'java-gradle-plugin'id 'maven-publish'
}gradlePlugin {plugins {//MyTestPlugin { //这种方式也行create("MyTestPlugin") {//插件idid = 'com.heiko.plugin.myplugin'//插件的包名+类名implementationClass = 'com.heiko.myplugin.MyPlugin'}}
}println("原本的version:" + version)
println("原本的group:" + group)//设置group
group = 'com.heiko.group'
//设置版本号
version = "1.0.0"println("设置后的group:" + group)
println("设置后的version:" + version)afterEvaluate {/*这部分代码不需要配置，会根据gradlePlugin中的进行生成除非使用老版本的插件依赖方式(classpath):需要指定artifactId的情况下，才需要使用publications {maven(MavenPublication) {groupId = groupartifactId = 'MyPlugin'version = versionfrom components.java}}*/publishing {// 配置仓库地址repositories {maven {url = uri('../repo')}}}
}

发布插件

这个时候，点击下Sync同步下代码，然后可以在右侧Gradle的Tab中，找到publishing，里面有publish选项，我们双击它，就开始执行发布插件的操作了。

在这里插入图片描述
上传插件成功后，可以看到如下信息
在这里插入图片描述

4. 使用插件

4.1 添加Maven仓库

pluginManagement {repositories {//省略了其他仓库...maven {url 'repo'}}
}

4.2 依赖插件

在更目录下的build.gradle中，依赖插件

plugins {id 'com.android.application' version '8.2.0' apply false//省略了其他插件代码id 'com.heiko.plugin.myplugin' version '1.0.0' apply false
}

通常默认配置会 立马 解析（resolve） 并 应用（apply） 插件。
而 apply 设为 false, 表示 不应用插件到 根项目。目的是 提前解析 插件，保持一样的版本。

4.3 应用插件

在app目录下的build.gradle中，应用插件

plugins {id 'com.android.application'id 'org.jetbrains.kotlin.android'//应用插件id 'com.heiko.plugin.myplugin'
}

4.4 同步项目

点击Sync同步下项目，可以看到我们的插件打印的日志了

在这里插入图片描述

5. 使用Groovy编写插件

上文中我们是使用java语言来编写的插件，那么如果使用Groovy语言来编写插件，需要怎么操作呢 ?

5.1 添加groovy插件

为了识别groovy语言，我们需要在MyPlugin目录下的build.gradle中添加groovy插件

plugins {id 'java-gradle-plugin'//添加groovy插件id 'groovy'id 'maven-publish'
}

5.2 新建groovy目录

在和java同级别的目录下，新建groovy目录，groovy目录下需要和原java目录一样
在这里插入图片描述

5.3 新建MyPluginGroovy.groovy

在groovy目录下，要把MyPlugin.java改为MyPlugin.groovy ，这里我为了方便区分，把名称改为了MyPluginGroovy.groovy 。

package com.heiko.myplugin;import org.gradle.api.Plugin;
import org.gradle.api.Project;class MyPluginGroovy implements Plugin<Project> {@Overridepublic void apply(Project project) {println "这是我的第一个Groovy插件!"}
}

5.4 修改implementationClass

修改MyPlugin目录下的build.gradle文件中的implementationClass ，修改为groovy目录下对应的插件类的包名+类名，注意没有文件后缀。

implementationClass = 'com.heiko.myplugin.MyPluginGroovy'

完整的build.gradle文件

plugins {id 'java-gradle-plugin'id 'groovy'id 'maven-publish'
}gradlePlugin {plugins {create("MyTestPlugin") {//插件idid = 'com.heiko.plugin.myplugin'//插件的包名+类名implementationClass = 'com.heiko.myplugin.MyPluginGroovy'}}
}//设置group
group = 'com.heiko.group'
//设置版本号
version = "1.0.1"afterEvaluate {publishing {// 配置仓库地址repositories {maven {url = uri('../repo')}}}
}

5.5 重新发布插件

将版本号version改为1.0.1，双击publish，重新发布插件

5.6 依赖插件

修改项目根目录下的build.gradle，将我们的com.heiko.plugin.myplugin插件版本号修改为1.0.1。
重新运行项目，可以看到打印的插件日志变成了

这是我的第一个Groovy插件!

6. 使用Kotlin编写插件

除了使用Java或Groovy编写插件，我们还可以使用Kotlin来编写插件，使用kotlin对于Android开发者来说会更友好。

6.1 添加java插件

为了识别kotlin语言，我们需要在MyPlugin目录下的build.gradle中添加kotlin插件

plugins {id 'java-gradle-plugin'//添加Kotlin插件id "org.jetbrains.kotlin.jvm"id 'maven-publish'
}

6.2 新建kotlin目录

在和java同级别的目录下，新建kotlin目录，kotlin目录下需要和原java目录一样

在这里插入图片描述

6.3 新建MyPluginKotlin.kt

在kotlin目录下，要把MyPlugin.java改为MyPlugin.kt ，这里我为了方便区分，把名称改为了MyPluginKotlin.groovy 。

package com.heiko.mypluginimport org.gradle.api.Plugin
import org.gradle.api.Projectclass MyPluginKotlin : Plugin<Project> {override fun apply(project: Project) {println("这是我的第一个Kotlin插件!")}
}

6.4 修改implementationClass

修改MyPlugin目录下的build.gradle文件中的implementationClass ，修改为groovy目录下对应的插件类的包名+类名，注意没有文件后缀。

implementationClass = 'com.heiko.myplugin.MyPluginKotlin'

完整的build.gradle文件

plugins {id 'java-gradle-plugin'id "org.jetbrains.kotlin.jvm"id 'maven-publish'
}gradlePlugin {plugins {create("MyTestPlugin") {//插件idid = 'com.heiko.plugin.myplugin'//插件的包名+类名implementationClass = 'com.heiko.myplugin.MyPluginKotlin'}}
}//设置group
group = 'com.heiko.group'
//设置版本号
version = "1.0.2"afterEvaluate {publishing {// 配置仓库地址repositories {maven {url = uri('../repo')}}}
}

6.5 重新发布插件

将版本号version改为1.0.2，双击publish，重新发布插件

6.6 依赖插件

修改项目根目录下的build.gradle，将我们的com.heiko.plugin.myplugin插件版本号修改为1.0.2。
重新运行项目，可以看到打印的插件日志变成了

这是我的第一个Kotlin插件!

7. Android Gradle系列文章

Android Gradle 开发与应用 (一) : Gradle基础-氦客-CSDN博客
Android Gradle开发与应用 (二) : Groovy基础语法-CSDN博客
Android Gradle开发与应用 (三) : Groovy语法概念与闭包-CSDN博客
Android Gradle开发与应用 (四) : Gradle构建与生命周期-CSDN博客
Android Gradle开发与应用 (五): 基于Gradle 8.2，创建Gradle插件-CSDN博客
Android Gradle 开发与应用 (六) : 创建buildSrc插件和使用命令行创建Gradle插件-CSDN博客

8. 参考文章

Using Plugins (gradle.org)
Gradle用户手册 - Gradle8.1.1中文文档 - API参考文档 - 全栈行动派 (qzxdp.cn)
编写 Gradle 插件 | Android Studio | Android Developers (google.cn)
Android Gradle8.0版本新建Gradle插件 - 掘金 (juejin.cn)
Gradle基础到进阶 - yechaoa的专栏 - 掘金 (juejin.cn)
【Gradle-8】Gradle插件开发指南 - 掘金 (juejin.cn)
【Gradle-9】Gradle插件发布指南 - 掘金 (juejin.cn)
Gradle自定义插件实践与总结 - 掘金 (juejin.cn)
创建Gradle插件记录 - 掘金 (juejin.cn)

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/734544.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

蓝桥杯递推与递归法|斐波那契数列|数字三角形|42点问题|数的计算|数的划分(C++)

蓝桥杯递推与递归法|斐波那契数列|数字三角形|42点问题|数的计算|数的划分(C++)

递归是用来做dfs&#xff0c;是搜索算法的基础 递推是用来做dp部分&#xff0c;及部分其他算法&#xff0c;复杂度较低&#xff0c;不会出现爆栈问题递推法&#xff1a; 递推法是一种在数学和其他领域广泛应用的重要方法&#xff0c;它在计算机科学中被用作一种关键的数值求解…
阅读更多...
无源元器件-电阻电容磁珠电感选型参数总

无源元器件-电阻电容磁珠电感选型参数总

🏡《总目录》 目录 1，概述2，电阻选型参数2，电容选型参数3，磁珠选型参数4，电感选型参数1，概述 无源器件（电阻、电容、电感）的选型时，需要考虑的参数多种多样，这些参数的选择会直接影响到电路的性能、稳定性、成本等多个方面。本文对电阻电容磁珠电感的参数进行详细介…
阅读更多...
LLM 推理优化探微 (3) ：如何有效控制 KV 缓存的内存占用，优化推理速度？

LLM 推理优化探微 (3) ：如何有效控制 KV 缓存的内存占用，优化推理速度？

编者按&#xff1a; 随着 LLM 赋能越来越多需要实时决策和响应的应用场景&#xff0c;以及用户体验不佳、成本过高、资源受限等问题的出现&#xff0c;大模型高效推理已成为一个重要的研究课题。为此&#xff0c;Baihai IDP 推出 Pierre Lienhart 的系列文章&#xff0c;从多个…
阅读更多...
C/C++指针详解

C/C++指针详解

接下来我们来介绍一下什么是指针&#xff1f; 指针其实就是元素存放地址&#xff0c;更加形象的比喻&#xff1a;在酒店中如果你想要去注必须去付费不然不能住&#xff0c;在计算机也同样如此&#xff08;但是不需要付费哦&#xff09;每当我们使用一个变量或其他需要申请空间…
阅读更多...
Linux centos6安装rz、sz命令

Linux centos6安装rz、sz命令

centos6传文件提示command not found # yum install lrzsz 提示错误 wget http://www.ohse.de/uwe/releases/lrzsz-0.12.20.tar.gz 下载离线包 https://www.ohse.de/uwe/software/lrzsz.html 下载最新版本 [rootnode1 ~]# tar -zxvf lrzsz-0.12.20.tar.gz …
阅读更多...
理论学习 消融实验

理论学习 消融实验

消融实验的目的在于移除系统中的特定的部分&#xff0c;来控制变量式的研究这个部分对于系统整体的影响。如果去除这一部分后系统的性能没有太大损失&#xff0c;那么说明这一部分对于整个系统而言并不具有太大的重要性&#xff1b;如果去除之后系统性能明显的下降&#xff0c;…
阅读更多...
天啊，腾讯云轻量服务器流量用完了怎么办？

天啊，腾讯云轻量服务器流量用完了怎么办？

腾讯云轻量服务器流量用完了怎么办&#xff1f;超额部分的流量另外支付流量费&#xff0c;流量价格为0.8元/GB&#xff0c;会自动扣你的腾讯云余额&#xff0c;如果你的腾讯云账号余额不足&#xff0c;那么你的轻量应用服务器会面临停机&#xff0c;停机后外网无法访问&#xf…
阅读更多...
系统学习Python——装饰器：“私有“和“公有“属性案例-[装饰器参数、状态保持和外层作用域]

系统学习Python——装饰器：“私有“和“公有“属性案例-[装饰器参数、状态保持和外层作用域]

分类目录&#xff1a;《系统学习Python》总目录 文章《系统学习Python——装饰器&#xff1a;“私有“和“公有“属性案例-[实现私有属性]》中的代码中__setattr__方法依赖于一个实例对象的__dict__属性命名空间字典&#xff0c;以设置onlnstance自己的wrapped属性。正如我们在…
阅读更多...
RAG综述 《Retrieval-Augmented Generation for Large Language Models: A Survey》笔记

RAG综述 《Retrieval-Augmented Generation for Large Language Models: A Survey》笔记

文章目录 概述RAG 的定义RAG的框架Naive RAGAdvanced RAGpre-retrieval processRetrievalpost-retrieval process Modular RAG RetrievalEnhancing Semantic Representationschunk 优化 微调向量模型Aligning Queries and DocumentsAligning Retriever and LLM GenerationAugme…
阅读更多...
ES分页查询的最佳实践：三种方案

ES分页查询的最佳实践：三种方案

Elasticsearch&#xff08;ES&#xff09;中进行分页查询时&#xff0c;最佳实践取决于具体的使用场景和需求。 以下是对每种分页方法的简要分析以及它们适用的情况&#xff1a; 1. From Size 最常见且直观的方法&#xff0c;通过from参数指定跳过多少条记录&#xff0c;si…
阅读更多...
07 数据结构之图

07 数据结构之图

# Makefile CCgcc CFLAGS -g -Wall SRCStest.c graph.c link_queue.c OBJS$(SRCS:.c.o) #variable replace APPtestall:$(OBJS) #指定一个目标&#xff0c; 不然默认目标不会检查依赖文件的时间戳$(CC) $(SRCS) -o $(APP) .PH…
阅读更多...
MySQL中常用的操作语句已汇总

MySQL中常用的操作语句已汇总

目录 一、库语句 1.查询现有数据库 2.创建数据库 3.选中数据库 ​编辑 4.删除数据库 二、初阶表操作 1.查看数据库现有表 2.查看表结构 3.创建表 4.删除表 5.全列查询 6.删除表2 7.修改操作 三、插入操作 1.全列插入 2.指定列插入 3.一次插入多组数据 4.插入…
阅读更多...
【AI视野·今日NLP 自然语言处理论文速览 第八十二期】Tue, 5 Mar 2024

【AI视野·今日NLP 自然语言处理论文速览 第八十二期】Tue, 5 Mar 2024

AI视野今日CS.NLP 自然语言处理论文速览 Tue, 5 Mar 2024 (showing first 100 of 175 entries) Totally 100 papers &#x1f449;上期速览✈更多精彩请移步主页 Daily Computation and Language Papers Key-Point-Driven Data Synthesis with its Enhancement on Mathematica…
阅读更多...
微服务---Eureka注册中心

微服务---Eureka注册中心

目录 一、服务中的提供者与消费者 二、Eureka工作流程 三、搭建Eureka服务 四、服务拉取 五、总结 1.搭建EurekaServer 2.服务注册 3.服务发现 一、服务中的提供者与消费者 服务提供者&#xff1a;一次业务中&#xff0c;被其他微服务调用的服务。即提供接口给其他微服务。…
阅读更多...
Golang + Redis解决缓存击穿（双层缓存）

Golang + Redis解决缓存击穿（双层缓存）

Golang Redis解决缓存穿透&#xff08;双层缓存&#xff09; 代码地址&#xff1a; https://github.com/ziyifast/ziyifast-code_instruction/tree/main/redis_demo/cache_breakdown 1 概念 目前主流方案是在数据库前加一层缓存。类似于DB的防弹衣。 缓存击穿&#xff1a;Re…
阅读更多...
chromedriverUnable to obtain driver for chrome using ,selenium找不到chromedriver

chromedriverUnable to obtain driver for chrome using ,selenium找不到chromedriver

1、下载chromedriver chromedriver下载网址&#xff1a;CNPM Binaries Mirror 老版本在&#xff1a;chromedriver/ 较新版本在&#xff1a;chrome-for-testing/ 2、设置了环境变量还是找不到chromedriverUnable to obtain driver for chrome using NoSuchDriverException:…
阅读更多...
使用Tesseract-OCR对PDF等图片文件进行文字识别

使用Tesseract-OCR对PDF等图片文件进行文字识别

安装 用 Homebrew 来安装 Tesseract brew install tesseract 2. 完成 tessearact 的安装后&#xff0c;还需要安装中文数据包&#xff0c;执行以下两个操作&#xff0c; brew info tesseract 执行这个指令的目的&#xff0c;是找到 Homebrew 把 tesseract 安装在文件夹内&am…
阅读更多...
SRS(Simple Realtime Server)

SRS(Simple Realtime Server)

SRS(Simple Realtime Server - github) SRS 中文官网 docker安装srs ##&#xff08;安全组放开1935端口、8080端口&#xff09; docker run --rm -it -p 1935:1935 -p 1985:1985 -p 8080:8080 -p 8000:8000/udp -p 10080:10080/udp ossrs/srs:5推流 ## 不需要加端口 ffmpeg…
阅读更多...
黑白名单方案

黑白名单方案

通用黑白名单方案 背景 设计一套灵活的黑白名单机制&#xff0c;要求无需修改代码即可修改黑白名单逻辑的切换。使用场景如下&#xff0c;比如原先一个新功能上线&#xff0c;我们期望给部分企业使用&#xff1b;等功能成熟后&#xff0c;我们一般会开放给所有的企业一起使用…
阅读更多...
【C++】6-10 输出最大值 分数 10

【C++】6-10 输出最大值 分数 10

6-10 输出最大值 分数 10 全屏浏览 切换布局 作者 范鹏程 单位 内蒙古师范大学 根据给定的程序&#xff0c;写成相关的成员函数&#xff0c;完成指定功能。 函数接口定义&#xff1a; 定义max函数&#xff0c;实现输出最高成绩对应的学号以及最高成绩值。 裁判测试程序样…
阅读更多...
最新文章

Copyright @ 2022~2023