阅读 1722

关于Android Gradle你需要知道这些(3)

前言

通过上两篇文章,我们大概知道了Groovy,Gradle在Android项目构建中的一些基本的配置和其作用,接下来就是我们真正实践的时刻,我们通过一个简单的插件的实现,来将前两篇中的点串起来,再次回顾熟悉Groovy语言,通过一个简单的demo跑通这个插件实现流程。创建一个插件,并发布到本地maven仓库。然后在我们的项目中运用我们的插件,调用相关的task。

Gradle插件Hello World

之前在自己学习gradle的时候,网上的资料本身相对较少,再就有些博主略过了一些细节,导致了很多博客中给出的例子,当我们自己实际去实践的时候,自己反倒无法跑起来,这里对于创建一个简单的gradle插件,进行了步骤的切分,对于每一个步骤进行较为详细的讲解。

  • Task

在Gradle文件中,我们可以根据自己的需求写一些task,其后的参数为task指定相应的名称

task("Test") {
    println("Hello world")
}
复制代码
  • Plugin

在Build文件中,我们可以实现一个简单的Gradle插件,通过实现Plugin接口,并实现其apply方法,这里在apply方法中打印出一个Hello world

class MyPlugin implements Plugin<Project> {
    @Override
    void apply(Project target) {
        println("Hello world")
    }
}
复制代码

在Build文件中写,显然无法让其复用,如果复用,我们就需要将其独立出来,如何来将其写成一个独立的插件呢?我们可以通过AndroidStudio来进行插件的开发,但是由于AndroidStudio没有给予很好的支持,因此,可能需要我们去手动的删除一些文件,然后按照正常的插件目录重新建立项目。

1. 创建一个Java Library Module

这里,我们新建一个Module,并取名firstplugin。

默认目录结构

2. 删除部分文件目录

将Java文件名称改为groovy (因为,我们的demo项目中不需要Java代码,因此,可以将其替换为groovy。)。删除libs目录

删除文件后

3. 构建配置

原build文件

apply plugin: 'java'

dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
}

sourceCompatibility = "1.7"
targetCompatibility = "1.7"

复制代码

因为我们要支持对于Groovy的编译支持,所以要添加一些Groovy相关的内容。

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

dependencies {
    compile gradleApi()
    compile localGroovy()
}

repositories {
    mavenCentral()
}

复制代码

执行build文件后,我们在进行开发的时候,就可以进行自动提示帮助我们提升开发效率。

4. HelloWorld插件开发

建立Groovy文件,进行插件代码的开发。这里我们命名为FirstPlugin .

package com.example;
import org.gradle.api.Plugin
import org.gradle.api.Project

class FirstPlugin implements Plugin<Project> {
    @Override
    void apply(Project target) {
        target.task("TestTask") {
            println("Hello world")
        }
    }
}
复制代码

当前目录状况

5. 配置插件信息

在Src目录下添加resources文件夹,创建一级目录,META-INF,在其下创建二级目录,grale-plugins,然后创建一个文件。命名方式,插件名称+properties后缀。

这里我们的文件名是com.example.firstplugin.properties

implementation-class=com.example.FirstPlugin
复制代码

里面用来指定我们的插件实现类。

当前目录结构

6. 发布到本地仓库

在Build文件中添加传至本地mavenCentral的代码

//根据自己需求来配置
group = 'com.jensen.plugin'
//版本信息
version = '1.0.0'

uploadArchives {
    repositories {
        mavenDeployer {
            //本地仓库地址
            repository(url: uri('/Users/chenjensen/Desktop/repo'))
        }
    }
}
复制代码

在Gradle task中执行uploadArchives,即可看到在本地的repo中产生的依赖。

执行该task

7. 应用到项目中

在Project的build文件中添加

    repositories {
        jcenter()
        //配置maven地址
        maven {
            url uri('/Users/chenjensen/Desktop/repo')
        }

    }
    dependencies {
        classpath 'com.android.tools.build:gradle:2.3.3'
        //指定插件的路径
        classpath 'com.jensen.plugin:firstplugin:1.0.0'
    }
复制代码

在我们的app的project中应用我们的插件

apply plugin: 'com.example.firstplugin'
TestTask
复制代码

执行控制台打印出执行信息.

Hello world
复制代码

总结

通过这一个流程,我们可以写出来一个简单的Gradle插件,对于具体更深入的功能,我们可以自己来根据自己的需求定制自己的插件,去写相应的task。通过本篇,主要是熟悉流程,接下来的第四篇,将会着重于如何写一个功能更丰富的插件,并发布到Jcenter中,应用到我们的项目之中。

关注下面的标签,发现更多相似文章
评论