littletank‘s studio.

使用AS开发gradle插件 (一)

gradle插件
字数统计: 652阅读时长: 2 min
2018/07/05 Share

0X00 前言

Gradle是一个使用Groovy语言实现的用于构建项目的框架。构建项目时真正起作用的是基于gradle框架使用Groovy实现的各种gradle插件。Gradle默认提供了很多插件，如Java-Plugin、Maven-Plugin等。Android Studio使用的是Android-Gradle-Plugin，由Google自主开发。在Android项目中，一个build.gradle文件，其实就是一个Groovy类。

0X01 在项目中使用Android gradle插件

配置插件路径，在Project目录中的build.gradle添加

1
2
3
dependencies {
    classpath 'com.android.tools.build:gradle:3.0.0'
}

使用具体插件，在主Module目录中的build.gradle添加

1
apply plugin: 'com.android.application'

0X02 自定义插件

我们可以利用Android Studio进行gradle插件开发，使用Groovy语言。简单步骤如下，
1.新建一个Module，选择Android Library。
2.删除src文件夹下的mian文件夹、删除build.gradle账文件中的所有内容。
3.在src目录下创建 groovy和resources目录，resouces目录下创建META-INF/gradle-plugins目录。创建完后的文件目录结构如下图：
QQ截图20170123114005
4.修改Module中的 build.gradle文件，引入groovy和maven相关依赖

1
2
3
4
5
6
7
apply plugin: 'groovy'
apply plugin: 'maven'

dependencies {
    compile gradleApi()
    compile localGroovy()
}

5.创建插件类TimeImpl.groovy，继承 Plugin<Project>，实现apply方法。

1
2
3
4
5
6
7
public class TimeImpl implements Plugin<Project> {

    @Override
    void apply(Project project) {
        project.gradle.addListener(new TimeListener())
    }
}

在gradle-plugins文件夹下创建properties文件，文件名就是以后插件的名字。配置插件类

1
implementation-class = com.thp.plugin.TimeImpl

QQ截图20170123114005

6.在build.gradle配置插件版本和发布到本地仓库

1
2
3
4
5
6
7
8
9
10
group = 'com.thp.plugin'
version = '1.0.0'

uploadArchives {
    repositories {
        mavenDeployer {
            repository(url: uri('../repo'))
        }
    }
}

这时候，右侧的gradle Toolbar就会在module下多出一个task

QQ截图20170123114005

点击uploadArchives，项目目录多出repo文件夹，打开可以看到生成的gradle插件

QQ截图20170123114005

0X03 项目中引用插件

在app module的build.gradle上添加

1
2
3
4
5
6
7
8
9
10
11
12
13
14
buildscript {
    repositories {
        jcenter()
        maven {
            url uri('../repo')
        }
    }

    dependencies {
        classpath 'com.thp.plugin:gradletime:1.0.0'
    }
}

apply plugin: 'gradle.time'

以上，就是一个自定义插件的开发和引用流程。在这里，我们是引用本地生成的插件文件，下一篇将介绍如何上传到jcenter上，方便引用。

中文文档

外籍文档

原文作者：HuanPei Tan

原文链接：https://tanhuanpei.github.io/2018/07/05/使用AS开发gradle插件入门/

发表日期：July 5th 2018, 7:45:51 pm

更新日期：December 18th 2018, 3:55:18 pm

版权声明：本文采用知识共享署名-非商业性使用 4.0 国际许可协议进行许可

CATALOG
  1. 1. 0X00 前言
  2. 2. 0X01 在项目中使用Android gradle插件
  3. 3. 0X02 自定义插件
  4. 4. 0X03 项目中引用插件
  5. 5. 中文文档
  6. 6. 外籍文档
Total : 11
2019
2018
性能优化 源码分析 白屏优化 gradle插件 APT 进阶 AspectJ 进阶 HTTPS 优化 面试