自定义Gradle插件(一)

本文详细介绍如何从零开始创建并使用自定义的Gradle插件,包括插件类的编写、配置文件的设置、任务定义及插件的编译与部署过程。

自定义Gradle插件(一)

自定义Gradle插件(二)

Google已经建议Android开发全部转向Android Studio开发,Android Studio 是使用gradle编译、打包的,那么问题来了,gradle可是有一堆东西...,为了测底了解gradle,今天就来学习下如何写自己的gradle插件(当然插件源码是使用groovy写的),先看如下代码目录:


如上图所示,plugin目录是插件源码目录,sample是用来测试插件的。


1、在目录plugin/src/main/groovy/com/micky/gradle/下新建插件类MyCustomPlugin.groovy

package com.micky.gradle;

import org.gradle.api.*;

class MyCustomPlugin implements Plugin<Project> {
	void apply(Project project) {
		project.task('myTask') << {
			println "Hi this is micky's plugin"
		}
	}
}

看看Plugin的源码,其实就是一接口

public interface Plugin<T> {
    /**
     * Apply this plugin to the given target object.
     *
     * @param target The target object
     */
    void apply(T target);
}


2、在目录plugin/src/main/resources/META-INF/gradle-plugins/下创建文件com.micky.mycustom.properties用来指定插件实现类

implementation-class=com.micky.gradle.MyCustomPlugin

   特别注意下:文件名“com.micky.mycustom”即是以后我们在使用插件时的apply plugin 'java' 的java,这里我也是折腾了半天才得出的结果,坑啊。


3、一般情况下,我们还需要指定插件项目名称,在plugin目录下新建settings.gradle

rootProject.name='gradle-micky'

4、万事具备,就差编译了,编译需要在plugin目录下新建build.gradle

apply plugin: 'groovy'
apply plugin: 'maven'

dependencies {
	compile gradleApi()
	compile localGroovy()
}

repositories {
	mavenCentral()
}

group='com.micky'
version='1.0.0'

uploadArchives {
	repositories {
		mavenDeployer {
			repository(url: uri('../repo'))
		}
	}
}
在这个脚本里使用groovy插件编译groovy源码,声明gradleAPI作为即时编译依赖,apply plugin: 'maven' 是用来创建一个插件jar文件并且存储在本地maven库里,本地maven库即我们在脚本里创建的"../repo"目录

执行命令:   gradle uploadArchives



5、以上4个步骤已经编译插件并上传到了本地库中,接下来就看看怎么使用插件,在sample目录下,新建build.gradle

buildscript {
	repositories {
		maven {
			url uri('../repo')
		}
	}

	dependencies {
		classpath group: 'com.micky',
			name: 'gradle-micky',
			version: '1.0.0'
	}
}

apply plugin: 'com.micky.mycustom'

6、执行命令


myTask即我们在MyCustomPlugin.groovy代码中创建的任务,下一编我们将来自定义Gradle 的Task。


源码地址:https://github.com/mickyliu945/GradleCustomPlugin

在Android Studio中编写自定义Gradle插件,可按以下步骤进行: 1. **创建Gradle Module**:这是编写自定义Gradle插件的起始步骤,需要手动创建相关目录,虽然相较于IDEA缺少开发插件辅助创建文件和目录,但手动创建的目录并不多且不复杂 [^1][^2]。 2. **配置开发语言**:在`build.gradle`中引用`apply plugin:'groovy'`,Groovy是自定义插件的开发语言,其中包含了各种功能类 [^3]。 3. **发布配置**: - 指定自定义Gradle插件的分组,如`group 'kim.hsl.plugin'`。 - 指定自定义Gradle插件的版本号,如`version '0.1'`。 - 自定义Gradle插件的名称,默认为工程名,也可在`publishing / publications`脚本块中自己指定。 - 应用`maven - publish`插件,用于将插件上传到远程仓库或者本地仓库中。 - 配置发布到远程/本地仓库的相关内容,示例代码如下: ```groovy // 指定自定义 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' } } } ``` [^4]
评论 5
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值