Android Stuido 自界说 Gradle7.0 插件

本文包括以下三个部分:

1. 运用android stuido 界说一个自界说gradle 插件
2. 发布插件到本地
3. 运用插件

如何运用Android stuido 创立一个插件

1、新建Android 工程

2、创立 Android Library

这里咱们创立了一个名为plugin的module

此时plugin module 好只是一个android library，要让它成为gradle 插件模块还需要做些改造。

修正 build.gradle文件

plugins {
    id 'groovy'
}
dependencies {
    //gradle sdk
    implementation gradleApi()
    //groovy sdk
    implementation localGroovy()
}

修正build文件后编译

配置plugin的目录结构

1. 删去不必要的文件和目录只保存build.gradle 和 src/main
2. 在src/main 目录下新建 groovy 目录，插件代码保存在此处
3. 在src/main 目录下新建 src/main/resources/META-INF/gradle-plugins 目录，插件声明在此处
4. 创立插件代码，在groovy 目录下创立自界说包，在包中创立一个MyPlugin.java重命名文件为MyPlugin.groovy 简略输出一句话。

package com.custom.plugin
import org.gradle.api.Plugin
import org.gradle.api.Project;
class MyPlugin implements Plugin<Project> {
    @Override
    void apply(Project project) {
        println "hello, this is my custom plugin!"
    }
}

6. 声明插件 在刚刚创立的gradle-plugins文件目录下创立插件声明文件custom-gradle-plugin.properties 文件中需要描绘插件的类路径。

implementation-class=com.custom.plugin.MyPlugin

留意这里的文件名将是你在引证此插件时的插件名称。

好了到这里插件就创立完成了， 咱们来看下插件的目录结构。

接下来咱们将学习如何发布插件和运用插件

如何发布插件到本地

配置gradle 文件

需要配置发布信息，这里只发布到本地。如何发布到远端自行google,这里发布到了项目目录下repo目录中。

plugins {
    id 'groovy'
    id 'maven-publish'
}
dependencies {
    //gradle sdk
    implementation gradleApi()
    //groovy sdk
    implementation localGroovy()
}
publishing {
    // 界说发布什么
    publications {
        plugin(MavenPublication) {
            groupId = "com.custom.plugin"
            artifactId = 'Myplugin'
            version = '1.0.0'
            from components.java
        }
    }
    repositories {
        maven {
            name = 'repo'
            url = "../repo"
        }
    }
}

插件就发布到本地库房了，咱们来看下项目结构

到这里插件就算发布完成了。接下来咱们继续学习如何运用插件。

如何运用插件

引入本地库房

在项目的setting.gradle文件中增加本地库房

maven {
    allowInsecureProtocol(true)
    url uri('./repo')
}

终究如下

pluginManagement {
    repositories {
        gradlePluginPortal()
        google()
        mavenCentral()
        //增加本地库房
        maven {
            allowInsecureProtocol(true)
            url uri('./repo')
        }
    }
}
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        //增加本地库房
        maven {
            allowInsecureProtocol(true)
            url uri('./repo')
        }
    }
}
rootProject.name = "GradleCustomPlugin"
include ':app'
include ':plugin'

引证插件

在项目的buid.gadle 文件中增加

buildscript {
    dependencies {
        classpath('com.custom.plugin:Myplugin:1.0.0')
    }
}

终究如下

buildscript {
    dependencies {
        classpath('com.custom.plugin:Myplugin:1.0.0')
    }
}
// Top-level build file where you can add configuration options common to all sub-projects/modules.
plugins {
    id 'com.android.application' version '7.3.0' apply false
    id 'com.android.library' version '7.3.0' apply false
}

在主模块下运用插件

在app 模块下的build.gradle 文件中增加插件

plugins {
    id 'com.android.application'
    // 增加插件
    id 'custom-gradle-plugin'
}

检查是否成功

编译引证插件的模块。会看到咱们在MyPlugin.groovy 中打印的提示 hello, this is my custom plugin!