【Android Gradle 插件】自定义 Gradle 插件模块 ⑤ ( 完整总结 ) ★★★

最新推荐文章于 2024-04-14 15:40:28 发布
最新推荐文章于 2024-04-14 15:40:28 发布
阅读量1.7k 收藏 6
点赞数 1
分类专栏： Android Gradle 插件 文章标签： android android studio gradle
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-NC-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/shulianghan/article/details/127322543
版权

文章目录

Android Plugin DSL Reference 参考文档 :





一、创建自定义插件类型模块 ( Java or Kotlin Library )


选择 " 菜单栏 / New / New Module… " 选项 ,

在这里插入图片描述

在 " Create New Module " 对话框中 , 选择 创建 " Java or Kotlin Library " 类型的依赖库 ;

在这里插入图片描述





二、手动导入相关依赖 ( Java | Groovy | Gradle )


在 buildSrc 目录 下 , 会自动引入 Java / Groovy / Gradle 的依赖 , 但是在自己创建的 Java Library 类型的依赖库 中 , 需要将其 手动引入 , 在 该 Module 模块的 build.gradle 构建脚本中引入上述依赖 ;

plugins {
    id 'java-library'
    id 'kotlin'
    id 'groovy'
}

java {
    sourceCompatibility = JavaVersion.VERSION_1_7
    targetCompatibility = JavaVersion.VERSION_1_7
}

dependencies {
    implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
    implementation gradleApi()
    implementation localGroovy()
    implementation fileTree(dir: 'libs', includes: ['*.jar'])
}

在这里插入图片描述





三、在 Java or Kotlin Library 模块中定义插件


在插件模块中的 src/main 目录 下创建 groovy 目录 , 用于存放 Groovy 代码 , 在其中定义包名以及包名下的源码 :

在这里插入图片描述

代码示例如下 :

package kim.hsl.plugin

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

class Plugin4 implements Plugin<Project> {

    @Override
    void apply(Project project) {
        println 'Plugin4'
    }
}

注意 : 此时的 自定义 Gradle 插件是无法在其它 Module 中引入的 ;





四、配置自定义 Gradle 插件发布选项


如果想要将 插件上传到 远程仓库 或者 本地仓库 中 , 需要引入一个 maven-publish 插件 ;

// 用于将 插件上传到 远程仓库 或者 本地仓库 中
apply plugin: 'maven-publish'

然后 , 创建 publishing 扩展 , 在该扩展中 , 可以在其中的 publications 脚本块 中为插件传入参数 ;
注意 : publications 中的 plugin 函数是任意命名的 ;

// 发布到 远程/本地仓库 相关配置
publishing {
    publications {
        // plugin 函数是随意命名的函数
        plugin(MavenPublication) {
            // 配置上传内容
            // components.java 是打包的 jar 包
            from components.java
        }
    }
}

在 Android Studio 工程根目录中的 build.gradle 构建脚本中 , 引入插件代码如下 :

buildscript {
    dependencies {
        classpath "com.android.tools.build:gradle:4.2.1"
    }
}




五、配置 Group 分组、插件名称、插件版本号


引入自定义 Gradle 插件的 “com.android.tools.build:gradle:4.2.1” 代码中

  • " com.android.tools.build " 是 Group 分组
  • " gradle " 是 插件名称
  • " 4.2.1 " 是 插件的版本号

上述 3 3 3 个元素使用 " : " 英文冒号 隔开 ;


因此 , 在自定义 Gradle 插件模块中 , 也可以指定

  • Group 分组
  • 插件名称
  • 插件版本号

这 3 3 3 个信息 ;


通过 Project#setGroup 方法 , 指定 Gradle 插件分组 ;

// 指定自定义 Gradle 插件的分组
group 'kim.hsl.plugin'

通过 Project#setVersion 方法 , 指定 Gradle 插件的版本号

// 指定自定义 Gradle 插件的版本号
version '0.1'

自定义 Gradle 插件的名称 , 默认为工程名 , 也可以在 publishing / publications / xxx / artifactId 配置中 自己指定 插件名称 ;

// 用于将 插件上传到 远程仓库 或者 本地仓库 中
apply plugin: 'maven-publish'

// 发布到 远程/本地仓库 相关配置
publishing {
    publications {
        // plugin 函数是随意命名的函数
        plugin(MavenPublication) {
            // 配置上传内容
            // components.java 是打包的 jar 包
            from components.java

            // 指定自定义 Gradle 插件名称
            artifactId 'plugin'
        }
    }
}

相关代码如下 :

// 指定自定义 Gradle 插件的分组
group 'kim.hsl.plugin'

// 指定自定义 Gradle 插件的版本号
version '0.1'

// 自定义 Gradle 插件的名称 , 默认为工程名
// 也可以在 publishing / publications 脚本块中 自己指定


// 用于将 插件上传到 远程仓库 或者 本地仓库 中
apply plugin: 'maven-publish'

// 发布到 远程/本地仓库 相关配置
publishing {
    publications {
        // plugin 函数是随意命名的函数
        plugin(MavenPublication) {
            // 配置上传内容
            // components.java 是打包的 jar 包
            from components.java

            // 指定自定义 Gradle 插件名称
            artifactId 'plugin'
        }
    }
}




六、自定义 Gradle 插件发布配置


在上一篇博客 【Android Gradle 插件】自定义 Gradle 插件模块 ② ( 在模块中定义插件 | 引入自定义 Gradle 插件模块 | 配置 Gradle 插件上传选项 | 配置分组名称版本号 ) 中 , 定义完插件后 , 在 自定义 Gradle 插件模块 的 build.gradle 构建脚本中 , 添加了 插件上传仓库的 配置 , 为插件指定了 分组 , 版本号 , 名称 配置 ;

// 指定自定义 Gradle 插件的分组
group 'kim.hsl.plugin'

// 指定自定义 Gradle 插件的版本号
version '0.1'

// 自定义 Gradle 插件的名称 , 默认为工程名
// 也可以在 publishing / publications 脚本块中 自己指定


// 用于将 插件上传到 远程仓库 或者 本地仓库 中
apply plugin: 'maven-publish'

// 发布到 远程/本地仓库 相关配置
publishing {
    publications {
        // plugin 函数是随意命名的函数
        plugin(MavenPublication) {
            // 配置上传内容
            // components.java 是打包的 jar 包
            from components.java

            // 指定自定义 Gradle 插件名称
            artifactId 'plugin'
        }
    }
}

首次编译执行 , 可以在 自定义 Gradle 插件的 Module 模块 下 , 看到 publishing 分组的 Gradle 任务 , 如下图红色矩形框中的内容 ;

  • generatePomFileForPluginPublication 任务的作用是 生成 Pom 文件 , 该文件是 Maven 仓库的描述文件 ;

  • publishPluginPublicationToMavenLocal 任务的作用是将 Gradle 插件 上传到本地 Maven 仓库中 ;

在这里插入图片描述





七、META-INF 中声明自定义插件的核心类


参考 Android Gradle 插件内容 , 将 Android Studio 的 Project 面板中的 External Libraries 展开 ,

在这里插入图片描述

在 Android Gradle 插件中 , 需要在 META-INF/gradle-plugins/插件组名.插件名.properties 文件中 ,
在这里插入图片描述

声明该 自定义插件的

implementation-class=org.gradle.api.plugins.antlr.AntlrPlugin

在自己的自定义插件中 , 也需要进行上述配置 ;

在 " src/main " 目录下 , 创建 " resources\META-INF\gradle-plugins " 目录 , 在该目录下创建 " kim.hsl.plugin.properties " 配置文件 , 内容为 :

implementation-class=kim.hsl.plugin.Plugin4

在这里插入图片描述

上述配置完毕后 , 重新执行 publishPluginPublicationToMavenLocal 任务 ;

在这里插入图片描述





八、将插件上传到本地 Maven 仓库


执行 Gradle 面板中的 publishPluginPublicationToMavenLocal 任务 , 即可将该 Module 生成的 jar 包上传到本地 Maven 仓库中 ;

在这里插入图片描述
然后再查看本地 Maven 仓库中的内容 , 发现 " C:\Users\octop.m2\repository " 目录中 多了一个 kim 目录 :

在这里插入图片描述

进入到 " C:\Users\octop.m2\repository\kim\hsl\plugin\plugin " 目录中 , 内容如下 :
在这里插入图片描述
进入到 " C:\Users\octop.m2\repository\kim\hsl\plugin\plugin\0.1 " 目录中 , 内容如下 :

在这里插入图片描述





九、在应用中依赖本地 Maven 仓库中的自定义 Gradle 插件


依赖本地 Maven 仓库 , 并导入 自定义 Gradle 插件 依赖 ;

buildscript {
    repositories {
        mavenLocal()    // 依赖本地 Maven 仓库
    }
    dependencies {
        classpath "kim.hsl.plugin:plugin:0.1" // 依赖本地 Maven 仓库下的自定义 Gradle 插件
    }
}

引入 自定义 Gradle 插件 ;

apply plugin: 'kim.hsl.plugin'




十、完整代码示例


自定义 Gradle 插件 - GitHub 地址 : https://github.com/han1202012/Android_UI


自定义插件代码

package kim.hsl.plugin

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

class Plugin4 implements Plugin<Project> {

    @Override
    void apply(Project project) {
        println 'Plugin4'
    }
}

自定义插件 Gradle 构建脚本

plugins {
    id 'java-library'
    id 'kotlin'
    id 'groovy'
}

java {
    sourceCompatibility = JavaVersion.VERSION_1_7
    targetCompatibility = JavaVersion.VERSION_1_7
}

dependencies {
    implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
    implementation gradleApi()
    implementation localGroovy()
    implementation fileTree(dir: 'libs', includes: ['*.jar'])
}

// 指定自定义 Gradle 插件的分组
group 'kim.hsl.plugin'

// 指定自定义 Gradle 插件的版本号
version '0.1'

// 自定义 Gradle 插件的名称 , 默认为工程名
// 也可以在 publishing / publications 脚本块中 自己指定


// 用于将 插件上传到 远程仓库 或者 本地仓库 中
apply plugin: 'maven-publish'

// 发布到 远程/本地仓库 相关配置
publishing {
    publications {
        // plugin 函数是随意命名的函数
        plugin(MavenPublication) {
            // 配置上传内容
            // components.java 是打包的 jar 包
            from components.java

            // 指定自定义 Gradle 插件名称
            artifactId 'plugin'
        }
    }
}

自定义插件插件类配置

implementation-class=kim.hsl.plugin.Plugin4

根目录 build.gradle 构建脚本

// Top-level build file where you can add configuration options common to all sub-projects/modules.
buildscript {
    ext.kotlin_version = "1.5.0"
    repositories {
        google()
        mavenCentral()
    }
    dependencies {
        classpath "com.android.tools.build:gradle:4.2.1"
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"

        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
    }
}

allprojects {
    repositories {
        google()
        mavenCentral()
        jcenter() // Warning: this repository is going to shut down soon
    }
}

task clean(type: Delete) {
    delete rootProject.buildDir
}

// 定义扩展属性 , 其中的变量对所有子项目可见
ext {
    hello1 = 'Hello World1!'
    hello2 = 'Hello World2!'
}


gradle.addBuildListener(new BuildListener() {
    @Override
    void buildStarted(Gradle gradle) {
        // 构建开始时回调该函数
    }

    @Override
    void settingsEvaluated(Settings settings) {
        // 分析 settings.gradle 函数完成后回调该函数
    }

    @Override
    void projectsLoaded(Gradle gradle) {

    }

    @Override
    void projectsEvaluated(Gradle gradle) {

    }

    @Override
    void buildFinished(BuildResult buildResult) {
        // 构建完成时回调的函数
    }
})

app 模块目录下 build.gradle 构建脚本

核心代码 :

buildscript {
    repositories {
        mavenLocal()    // 依赖本地 Maven 仓库
    }
    dependencies {
        classpath "kim.hsl.plugin:plugin:0.1" // 依赖本地 Maven 仓库下的插件
    }
}

apply plugin: 'kim.hsl.plugin'

完整代码 :

buildscript {
    repositories {
        mavenLocal()    // 依赖本地 Maven 仓库
    }
    dependencies {
        classpath "kim.hsl.plugin:plugin:0.1" // 依赖本地 Maven 仓库下的插件
    }
}

plugins {
    id 'com.android.application'
    id 'kotlin-android'
}

apply plugin: 'kim.hsl.plugin'


android {
    compileSdkVersion 31
    buildToolsVersion "30.0.3"

    defaultConfig {
        applicationId "kim.hsl.android_ui"
        minSdkVersion 18
        targetSdkVersion 31
        versionCode 1
        versionName "1.0"

        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }

    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
    kotlinOptions {
        jvmTarget = '1.8'
    }
    // 定义扩展属性 , 其中的变量对所有子项目可见
    /*ext {
        hello3 = 'Hello World1!3'
    }*/
}

dependencies {

    implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
    implementation 'androidx.core:core-ktx:1.6.0'
    implementation 'androidx.appcompat:appcompat:1.4.1'
    implementation 'com.google.android.material:material:1.5.0'
    implementation 'androidx.constraintlayout:constraintlayout:2.1.3'
    testImplementation 'junit:junit:4.+'
    androidTestImplementation 'androidx.test.ext:junit:1.1.3'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
}

apply plugin: MyPlugin

myplugin {
    name 'Tom'
    age 18

    // 调用在扩展中定义的方法
    // 打印 'MyPluginExtensions extensionFun'
    extensionFun()

    // 调用 扩展中 带参数的方法
    extensionFun 'Hello'

    mypluginextension {
        name 'Jerry'
        age 19
    }
}

// 在 build.gradle 中定义 Gradle 插件
class MyPlugin2 implements Plugin<Project> {

    @Override
    void apply(Project project) {
        println 'MyPlugin2'
    }
}

// 引入在本文件中定义的 Gradle 插件
apply plugin: MyPlugin2

// 该操作相当于将 plugin.gradle 文件拷贝到此处
apply from: 'plugin.gradle'
韩曙亮
关注
  • 1
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
AndroidStudio自定义Gradle插件
07-02
在AndroidStudio中自定义Gradle插件
Android 自定义gradle插件
mick-米克 的博客
03-31 3918
android自定义gradle插件的步骤 1.首先我们新建一个android项目 2.然后新建一个android module a.删除一些不需要的文件目录，然后新建groovy，resources文件目录，最终文件目录如下 b.修改module下的build.gradle文件如下： apply plugin: 'groovy' apply plugin: 'maven-publish' dependencies { implementation gradleApi()
Android Gradle插件对应的Gradle所需版本
2401_84132204的博客
04-14 1219
总而言之，Android开发行业变化太快，作为技术人员就要保持终生学习的态度，让学习力成为核心竞争力，所谓“活到老学到老”只有不断的学习，不断的提升自己，才能跟紧行业的步伐，才能不被时代所淘汰。在这里我分享一份自己收录整理上述技术体系图相关的几十套腾讯、头条、阿里、美团等公司20年的面试题，把技术点整理成了视频和PDF（实际上比预期多花了不少精力），包含知识脉络 + 诸多细节，由于篇幅有限，这里以图片的形式给大家展示一部分。
Gradle系列之Android Gradle插件
躬行之
05-17 614
通过前面几篇文章学习了 Gradle 基础知识以及 Gradle 插件相关的知识，关于 Gradle 及其插件相关知识请先阅读下面几篇文章： Gradle系列之初识Gradle Gradle之Groovy基础篇 Gradle系列之构建脚本基础 Gradle系列之Gradle插件 Gradle系列之Java Gradle插件 学习 Gradle 的目的主要是为了更好的在 Android 开发中使...
Android Gradle自定义插件
weixin_43298955的博客
02-04 2300
一、Gradle插件介绍 Android Gradle插件中，包含了一些task可以帮我们做一些编译、引入依赖、打包等工作，比如assembleBuild,clean等等。 二、Gradle编写 1、新建一个Android Library，命名为demo-plugin，然后删掉之前的java文件夹，并创建一个Groovy文件夹，因为，我们是使用Groovy来编写Gradle 插件的。 2、将子项目的build.gralde文件，修改为如下。因为...
Android之gradle自定义插件实现
热爱技术
11-27 3391
Build script 脚本 —— 把插件写在build.gradle文件中，一般用于简单的逻辑，只在该build.grade文件可见 buildSrc目录 —— 将插件源代码放在buildSrc/src/main中，只对该项目可见 独立项目 |—— 一个独立的Java项目/模块，可以将文件包发布到仓库（Jecenter,Maven）,使其他项目方便引入
Android-Kotlin-MVI-CleanArchitecture：Android + Kotlin +模块化+ Gradle Depedency管理+用Kotlin DSL编写的Gradle +自定义Gradle插件+ MVVM + MVI +清洁架构+存储库模式+协程+流程+ Koin + Retrofit2 + ROOM + Kotlin- Android扩展+ KtLints
02-03
Android-Kotlin-MVI-CleanArchitecture：Android + Kotlin +模块化+ Gradle Depedency管理+用Kotlin DSL编写的Gradle +自定义Gradle插件+ MVVM + MVI +清洁架构+存储库模式+协程+流程+ Koin + Retrofit2 + ROOM + ...
gradle-maven-publication：Gradle Maven工件使用“ maven”，“ maven-publish”，“ android-maven” gradle插件发布漫游。 该项目同时包含脚本和自定义gradle插件，旨在使发布作业更加简单和正确。 当然，java和android项目都受支持！
02-04
该插件将是一个自定义的gradle插件，它将使工作流程更加简单。 当然，脚本/插件旨在与java和android project一起使用。项目结构示范项目描述应用程式演示应用模块的lib-android 演示android库模块lib-android-sub ...
BettererNaming:Gradle插件，可将Android工件自动重命名为更有用的功能
05-21
更好的命名更好的命名是Gradle插件，用于使Android发布工件的命名更好。 带有gradle的Android发布应用程序和库的默认命名为<module>-<status>.<apk> 。 此插件将默认名称更改为<module>-<status>-<version>-<git>-...
GrabVer：Gradle自动构建版本控制插件-一个简单的Gradle插件，遵循semver.org规则自动生成补丁程序版本，内部版本号和代码版本，而主要，次要和预发布后缀仍在我们的控制之下
02-02
一个遵循规则的简单Gradle插件可以自动生成补丁程序版本，内部版本号和代码版本，而Major ， Minor和Pre-Release后缀仍在我们的控制之下。 我看到很多需要长时间配置和不断调整才能更新这些数字的插件，如果需要的话...
安卓Android法律论坛设计可以导入Studio源码案例设计.zip
最新发布
05-05
它们是使用 Android Gradle 插件提供的元素以 Kotlin 或 Groovy 语法配置 build 的纯文本文件。每个项目都有一个用于整个项目的顶级 build 文件，以及用于各模块的单独模块级 build 文件。在导入现有项目时，Android...
Android Gradle 插件中文指南
03-06
google推出了全新的Android Studio集成开发环境，其中Android项目的结构与Eclipse的Android项目结构有很大的区别，原因就在于两开发环境使用的构建工具不同。 Android Studio使用Gradle构建工具，Eclipse的ADT插件使用的是Ant构建工具。因为两个构建工具的区别，导致习惯了Eclipse开发环境的开发者刚开始比较难适应Android Studio。如果要迁移到Android Studio，建议最好了解下Gradle构建工具。Gradle构建工具是任务驱动型的构建工具，并且可以通过各种Plugin插件扩展功能以适应各种构建任务。对应Android项目的Gradle插件就是Android Gradle Plugin。
【Android】自定义Gradle插件——实现云端配置项目依赖
devnn的专栏
06-18 2454
这篇文章讲解如何自定义一个Gradle插件，实现功能是将项目的sdk依赖dependencies{...}配置部分交给插件，将插件上传到maven仓库，通过云端来配置项目的依赖。
Android Gralde插件平台开发系列三：自定义gradle plugin
u011630465的博客
08-29 1114
自定义gradle plugin
Android自定义Gradle插件
ming54ming的博客
03-13 199
一、Gradle介绍 gradle是Android Studio默认的构建工具，它不仅继承了maven中仓库，坐标，依赖这些核心概念，还继承了ant中target的概念，可定义自己的任务task。在build.gradle文件中我们可以看到下面的代码： apply plugin: 'com.android.application' 'com.android.application' 就是插...
Android 新建自定义Gradle插件
朱豪凯的博客
06-18 504
首先，我们新建一个项目，然后新建一个Android Library。 我们将library取名为myplugin 然后，我们要删除myplugin/src目录下所有的文件，然后按照下图创建相关的路径。 在这里插入图片描述 添加依赖关系 修改myplugin/build.gradle apply plugin: 'groovy' repositories { mavenCentral() } dependencies { implementation gradleApi() //gra
Android Gradle （一）Gradle的Android插件入门
Android进阶三部曲 - 刘望舒
04-05 2848
相关文章 Gradle核心思想（一）为什么现在要用Gradle？ Gradle核心思想（二）Gradle入门前奏 Gradle核心思想（三）Groovy快速入门指南 Gradle核心思想（四）看似无用，实则重要的Gradle Wrapper Gradle核心思想（五）通俗易懂的Gradle插件讲解 Gradle核心思想（六）自定义Gradle插件的三种方式 前言 在Gradle核心思想这个系列中...
自定义gradle插件
悠悠吾心的专栏
12-05 1242
自定义gradle插件通过这个内容，我们能够解释一些在平时android开发中的一些困惑1.我们每次用到的android域从何而来？2.为什么在android域内设置一些属性，会在项目中生效 首先，因为用到gradle的大部分都是android开发者，我们来看一个project中的gradle脚本apply plugin: 'com.android.application'android {
Android Gradle
08-09
Android Gradle 插件是用于构建和打包 Android 应用程序的工具。它与 Gradle 构建系统集成，为开发者提供了许多功能和配置选项来管理项目的构建过程。 Android Gradle 插件提供了以下功能： 1. 构建变体管理：允许开发者根据不同的构建变体（如不同的产品风味、构建类型、渠道等）定制构建过程和配置选项。 2. 依赖管理：可以通过 Gradle 的依赖配置来管理应用程序的依赖关系，包括引用库模块、第三方库和 Android 框架组件等。 3. 打包和签名：提供了打包 APK 文件的功能，可以指定不同的签名配置和变体，以生成适用于发布的 APK 包。 4. 构建任务和生命周期：通过定义 Gradle 任务和钩子函数，可以在构建过程的不同阶段执行自定义逻辑和操作。 5. 构建类型和产品风味：可以通过定义不同的构建类型（如 debug、release）和产品风味（如开发版、生产版）来管理应用程序的变体配置和行为。 6. 构建优化：通过使用增量

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值