前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >【Android Gradle 插件】自定义 Gradle 插件模块 ⑤ ( 完整总结 ) ★★★

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

作者头像
韩曙亮
发布2023-03-30 17:17:38
1.3K0
发布2023-03-30 17:17:38
举报
文章被收录于专栏:韩曙亮的移动开发专栏

文章目录

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 构建脚本中引入上述依赖 ;

代码语言:javascript
复制
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 代码 , 在其中定义包名以及包名下的源码 :

在这里插入图片描述
在这里插入图片描述

代码示例如下 :

代码语言:javascript
复制
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 插件 ;

代码语言:javascript
复制
// 用于将 插件上传到 远程仓库 或者 本地仓库 中
apply plugin: 'maven-publish'

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

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

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

代码语言:javascript
复制
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 个元素使用 " : " 英文冒号 隔开 ;

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

  • Group 分组
  • 插件名称
  • 插件版本号这 3 个信息 ;

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

代码语言:javascript
复制
// 指定自定义 Gradle 插件的分组
group 'kim.hsl.plugin'

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

代码语言:javascript
复制
// 指定自定义 Gradle 插件的版本号
version '0.1'

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

代码语言:javascript
复制
// 用于将 插件上传到 远程仓库 或者 本地仓库 中
apply plugin: 'maven-publish'

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

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

相关代码如下 :

代码语言:javascript
复制
// 指定自定义 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 构建脚本中 , 添加了 插件上传仓库的 配置 , 为插件指定了 分组 , 版本号 , 名称 配置 ;

代码语言:javascript
复制
// 指定自定义 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 文件中 ,

在这里插入图片描述
在这里插入图片描述

声明该 自定义插件的

代码语言:javascript
复制
implementation-class=org.gradle.api.plugins.antlr.AntlrPlugin

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

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

代码语言:javascript
复制
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 插件 依赖 ;

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

引入 自定义 Gradle 插件 ;

代码语言:javascript
复制
apply plugin: 'kim.hsl.plugin'

十、完整代码示例


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

自定义插件代码

代码语言:javascript
复制
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 构建脚本

代码语言:javascript
复制
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'
        }
    }
}

自定义插件插件类配置

代码语言:javascript
复制
implementation-class=kim.hsl.plugin.Plugin4

根目录 build.gradle 构建脚本

代码语言:javascript
复制
// 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 构建脚本

核心代码 :

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

apply plugin: 'kim.hsl.plugin'

完整代码 :

代码语言:javascript
复制
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'
本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2022-10-14,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 文章目录
  • 一、创建自定义插件类型模块 ( Java or Kotlin Library )
  • 二、手动导入相关依赖 ( Java | Groovy | Gradle )
  • 三、在 Java or Kotlin Library 模块中定义插件
  • 四、配置自定义 Gradle 插件发布选项
  • 五、配置 Group 分组、插件名称、插件版本号
  • 六、自定义 Gradle 插件发布配置
  • 七、META-INF 中声明自定义插件的核心类
  • 八、将插件上传到本地 Maven 仓库
  • 九、在应用中依赖本地 Maven 仓库中的自定义 Gradle 插件
  • 十、完整代码示例
    • 自定义插件代码
      • 自定义插件 Gradle 构建脚本
        • 自定义插件插件类配置
          • 根目录 build.gradle 构建脚本
            • app 模块目录下 build.gradle 构建脚本
            相关产品与服务
            容器服务
            腾讯云容器服务(Tencent Kubernetes Engine, TKE)基于原生 kubernetes 提供以容器为核心的、高度可扩展的高性能容器管理服务,覆盖 Serverless、边缘计算、分布式云等多种业务部署场景,业内首创单个集群兼容多种计算节点的容器资源管理模式。同时产品作为云原生 Finops 领先布道者,主导开源项目Crane,全面助力客户实现资源优化、成本控制。
            领券
            问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档