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") {
            //插件id
            id = '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> {

    @Override
    public 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 = group
            artifactId = 'MyPlugin'
            version = version

            from components.java
        }
    }*/
    publishing {
        // 配置仓库地址
        repositories {
            maven {
                url = uri('../repo')
            }
        }
    }
}

build.gradle的完整代码如下

plugins {
    id 'java-gradle-plugin'
    id 'maven-publish'
}

gradlePlugin {
    plugins {
        //MyTestPlugin { //这种方式也行
        create("MyTestPlugin") {
            //插件id
            id = '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 = group
            artifactId = 'MyPlugin'
            version = version

            from 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> {

    @Override
    public 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") {
            //插件id
            id = '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.myplugin

import org.gradle.api.Plugin
import org.gradle.api.Project


class 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") {
            //插件id
            id = '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)

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

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

机器学习（五） -- 监督学习（1） -- 线性回归

机器学习（五） -- 监督学习（1） -- 线性回归

系列文章目录 机器学习&#xff08;一&#xff09; -- 概述 机器学习&#xff08;二&#xff09; -- 数据预处理&#xff08;1-3&#xff09; 机器学习&#xff08;三&#xff09; -- 特征工程&#xff08;1-2&#xff09; 机器学习&#xff08;四&#xff09; -- 模型评估…
阅读更多...
批量提取PDF指定区域内容到 Excel 以及根据PDF里面第一页的标题来批量重命名-附思路和代码实现

批量提取PDF指定区域内容到 Excel 以及根据PDF里面第一页的标题来批量重命名-附思路和代码实现

首先说明下&#xff0c;PDF需要是电子版本的&#xff0c;不能是图片或者无法选中的那种。 需求1&#xff1a;假如我有一批数量比较多的同样格式的PDF电子文档&#xff0c;需要把特定多个区域的数字或者文字提取出来 需求2&#xff1a;我有一批PDF文档&#xff0c;但是文件的名…
阅读更多...
使用VBA快速梳理多层级族谱（组织架构）

使用VBA快速梳理多层级族谱（组织架构）

实例需求&#xff1a;族谱&#xff08;或者公司组织架构等&#xff09;都是典型的带有层级关系数据&#xff0c;例如下图中左侧表格所示。 A列为层级&#xff08;准确的讲是B列成员的层级&#xff09;&#xff0c;从一开始递增B列和C列为成员直接的父&#xff08;/母&#xff…
阅读更多...
美术馆预约小程序|基于微信小程序的美术馆预约平台设计与实现(源码+数据库+文档)

美术馆预约小程序|基于微信小程序的美术馆预约平台设计与实现(源码+数据库+文档)

美术馆预约小程序目录 目录 基于微信小程序的美术馆预约平台设计与实现 一、前言 二、系统设计 三、系统功能设计 1、用户信息管理 2、展品信息管理 3、美术馆信息管理 4、论坛信息管理 四、数据库设计 五、核心代码 七、最新计算机毕设选题推荐 八、源码获取&am…
阅读更多...
谷歌BigQuery推出新玩意儿，向量搜索登场啦！

谷歌BigQuery推出新玩意儿，向量搜索登场啦！

每周跟踪AI热点新闻动向和震撼发展 想要探索生成式人工智能的前沿进展吗&#xff1f;订阅我们的简报&#xff0c;深入解析最新的技术突破、实际应用案例和未来的趋势。与全球数同行一同&#xff0c;从行业内部的深度分析和实用指南中受益。不要错过这个机会&#xff0c;成为AI领…
阅读更多...
AIGC: 2 语音转换新纪元-Whisper技术在全球客服领域的创新运用

AIGC: 2 语音转换新纪元-Whisper技术在全球客服领域的创新运用

背景 现实世界&#xff0c;人跟人的沟通相当一部分是语音沟通&#xff0c;比如打电话&#xff0c;聊天中发送语音消息。 而在程序的世界&#xff0c;大部分以处理字符串为主。 所以&#xff0c;把语音转换成文字就成为了编程世界非常普遍的需求。 Whisper 是由 OpenAI 开发…
阅读更多...
【神经网络与深度学习】深度神经网络（DNN）

【神经网络与深度学习】深度神经网络（DNN）

概述 深度神经网络&#xff08;Deep Neural Networks&#xff0c;DNN&#xff09;是一种由多个隐藏层组成的神经网络模型。每个隐藏层由多个神经元组成&#xff0c;这些神经元通过权重和激活函数进行信息传递和计算。 深度神经网络通过多层的非线性变换&#xff0c;可以学习到…
阅读更多...
vue中实现3d词云效果（已封装组件）

vue中实现3d词云效果（已封装组件）

<!--* Description: 词云组件 页面* Date: 2024/3/10 23:39 --> <template><div:style"{display: flex,justifyContent: center,border: 1px solid red,}"><svg:width"width":height"height"mousemove"listener($even…
阅读更多...
Linux动态追踪——ftrace

Linux动态追踪——ftrace

目录 摘要 1 初识 1.1 tracefs 1.2 文件描述 2 函数跟踪 2.1 函数的调用栈 2.2 函数调用栈 2.3 函数的子调用 3 事件跟踪 4 简化命令行工具 5 总结 摘要 Linux下有多种动态追踪的机制&#xff0c;常用的有 ftrace、perf、eBPF 等&#xff0c;每种机制适应于不同的场…
阅读更多...
ES分页查询的最佳实践：三种方案

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

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

Autosar Crypto Driver学习笔记（一）

文章目录 Crypto DriverPre-ConfigurationCryptographic capabilities加密能力Available Keys可用密钥 General BehaviorNormal OperationFunctional RequirementsSynchronous Job ProcessingAsynchronous Job Processing Design NotesPriority-dependent Job Queue基于优先级的…
阅读更多...
docker安装jenkins并实现CICD流程

docker安装jenkins并实现CICD流程

docker安装jenkins并实现CICD流程 本文目录 docker安装jenkins并实现CICD流程安装命令初始化设置更新jenkins及插件更新jenkins版本更新插件 创建第一个任务修改配置插件更新中心时区设置 安装命令 官方安装参考&#xff1a;https://www.jenkins.io/zh/doc/book/installing/ …
阅读更多...
Docker安装tomcat

Docker安装tomcat

目录 一、安装Docker 二、Docker安装tomcat 三、安装tomcat 一、安装Docker 安装docker阅读 Docker整理之安装(1)-CSDN博客https://blog.csdn.net/ywanju/article/details/135442406 二、Docker安装tomcat 本案例安装的tomcat最新版本 搜(dockerhub搜索镜像版本) 拉(拉…
阅读更多...
十二要素应用: 云原生应用最佳实践

十二要素应用: 云原生应用最佳实践

本文介绍了开发部署云原生应用的一套最佳实践&#xff0c;通过这套最佳实践&#xff0c;可以最大限度利用云原生的能力&#xff0c;创建灵活、健壮、易管理的现代云原生应用程序。原文: The Twelve-Factor App: Best Practices for Cloud-Native Applications[1] 导言 软件如今…
阅读更多...
爬虫与DataFrame对象小小结合

爬虫与DataFrame对象小小结合

import pandas as pd import requests from lxml import etree #数据请求 url"https://www.maigoo.com/brand/list_1715.html" headers{User-Agent:Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.5735.289 Safari…
阅读更多...
【实验报告】C语言实现猜单词的小游戏

【实验报告】C语言实现猜单词的小游戏

之前帮别人写的一个简单的报告&#xff0c;无偿分享给大家~代码在后面&#xff0c;有一些图片出于懒惰没有上传。比较简单&#xff0c;喜欢的话关注我~&#xff0c;请勿商用~ 1 系统功能模块结构图 该程序主要思路&#xff1a; 头文件设计&#xff0c;存储结构设计&#xff0…
阅读更多...
Jmeter+Ant+Git/SVN+Jenkins实现持续集成接口测试，一文精通（一）

Jmeter+Ant+Git/SVN+Jenkins实现持续集成接口测试，一文精通（一）

前言 Jmeter&#xff0c;Postman一些基本大家相比都懂。那么真实在项目中去使用&#xff0c;又是如何使用的呢&#xff1f;本文将一文详解jmeter接口测试 一、接口测试分类 二、目前接口架构设计 三、市面上的接口测试工具 四、Jmeter简介&#xff0c;安装&#xff0c;环境…
阅读更多...
计算机网络—OSPF单区域配置

计算机网络—OSPF单区域配置

目录 目录 1.实验环境准备 2.配置 OSPF 3.验证 OSPF 配置 4.修改 OSPF hello 和 dead 时间参数 5.OSPF缺省路由发布及验证 6.控制 OSPF DR/BDR 的选举 7.配置文件 拓扑图&#xff1a; 1.实验环境准备 基本配置以及IP编址。 <Huawei>system-view Enter system vi…
阅读更多...
YOLOv8改进 | 注意力篇 | 利用YOLO-Face提出的SEAM注意力机制优化物体遮挡检测（附代码 + 修改教程）

YOLOv8改进 | 注意力篇 | 利用YOLO-Face提出的SEAM注意力机制优化物体遮挡检测（附代码 + 修改教程）

一、本文介绍 本文给大家带来的改进机制是由YOLO-Face提出能够改善物体遮挡检测的注意力机制SEAM&#xff0c;SEAM&#xff08;Spatially Enhanced Attention Module&#xff09;注意力网络模块旨在补偿被遮挡面部的响应损失&#xff0c;通过增强未遮挡面部的响应来实现这一目…
阅读更多...
【JAVA】CSS定位与CSS3属性、渐变、CSS3字体、2D变换

【JAVA】CSS定位与CSS3属性、渐变、CSS3字体、2D变换

1 定位 1.1 相对定位 相对定位没有脱离文档流 定位元素的显示层级比普通元素高 定位元素可以通过margin&#xff0c;float调整位置&#xff0c;但不推荐 包含块&#xff1a;父元素 left和right同时写&#xff0c;右失效 上下同时写&#xff0c;下失效 <head><s…
阅读更多...
最新文章

Copyright @ 2022~2023