如何使用Android Studio 开发Gradle插件

一、如何使用Android Studio 开发Gradle插件

1、Gradle插件是使用Groovy进行开发的，而Groovy其实是可以兼容Java的。AndroidStudio其实除了开发Android App外，完全可以胜任开发Gradle插件这一工作，下面来讲讲具体如何开发。

2、之后，新建一个Android Module项目，类型选择Android Library。

3、将新建的Module中除了build.gradle文件外的其余文件全都删除，然后删除build.gradle文件中的所有内容。

4、在新建的module中新建文件夹src，接着在src文件目录下新建main文件夹，在main目录下新建groovy目录，这时候groovy文件夹会被Android识别为groovy源码目录。除了在main目录下新建groovy目录外，你还要在main目录下新建resources目录，同理resources目录会被自动识别为资源文件夹。在groovy目录下新建项目包名，就像Java包名那样。resources目录下新建文件夹META-INF，META-INF文件夹下新建gradle-plugins文件夹。这样，就完成了gradle插件的项目的整体搭建，之后就是小细节了。目前，项目的结构是这样的。

5、打开Module下的build.gradle文件，输入

6、下面我们在包名下新建一个文件，命名为PluginImpl.groovy，注意有groovy后缀，然后在里面输入，注意包名替换为你自己的包名。

7、public class PluginImpl implements Plugin<Project>{

8、project.task('testTask')<<{

9、}123456789101112123456789101112

10、然后在resources/META-INF/gradle-plugins目录下新建一个properties文件，注意该文件的命名就是你只有使用插件的名字，这里命名为plugin.test.properties，在里面输入

11、implementation-class=cn.edu.zafu.gradle.PluginImpl11

12、注意包名需要替换为你自己的包名。

13、这样就完成了最简单的一个gradle插件，里面有一个叫testTask的Task，执行该task后会输出一段文字，就像当初我们输出HelloWorld一样。

二、如何编写自己的android插件

目前plugin-x中定义了4个协议：ProtocolAds, ProtocolAnalytics, ProtocolIAP, ProtocolSocial。编写自己的插件，不需要写任何的c++/jni代码或者javascript绑定代码。我们已经在plugin-x的核心层实现了这些，开发者所要做的就是：

请确保你的plugin文件夹结构类似下图：

proj.android:插件的android工程文件夹.

注意：pulish.sh工具的实现会依赖这样的文件夹结构。

在Eclipse中导入plugin protocol的安卓工程

build.xml: publish.sh脚本使用它，可以从其他插件工程拷贝过来，注意要修改工程名。

ForManifest.xml: gameDevGuide.sh使用它.如果你的插件在AndroidManifest.xml开启了一些额外的权限，需要把他们添加到这个文件中。

sdk:把第三方SDK的jar包放在这里。

src:把你的插件实现代码放在这里。

这个类应该有一个带有Context参数的构造函数，例如：

public class AnalyticsFlurry implements InterfaceAnalytics{

public AnalyticsFlurry(Context context){

你可以覆盖接口中的方法，或者定义自己的方法，例如：

public String getSDKVersion(){

protected void setUserId(String userId){

final String curUser= userId;

PluginWrapper.runOnMainThread(new Runnable(){

FlurryAgent.setUserId(curUser);

LogE("Exception in setUserId", e);

目前plugin-x只支持传递int, float, boolean, String, JSONObject类型的参数，返回值类型只可以是int, float, boolean, String。

三、如何使用Android Studio开发Gradle插件

使用Android Studio开发Gradle插件的步骤：

AndroidStudio中是没有新建类似Gradle Plugin这样的选项的，那我们如何在AndroidStudio中编写Gradle插件，并打包出来呢？

(1)首先，你得新建一个Android Project

(2)然后再新建一个Module，这个Module用于开发Gradle插件，同样，Module里面没有gradle plugin给你选，但是我们只是需要一个“容器”来容纳我们写的插件，因此，你可以随便选择一个Module类型（如Phone&Tablet Module或Android Librarty）,因为接下来一步我们是将里面的大部分内容删除，所以选择哪个类型的Module不重要。

(3)将Module里面的内容删除，只保留build.gradle文件和src/main目录。

由于gradle是基于groovy，因此，我们开发的gradle插件相当于一个groovy项目。所以需要在main目录下新建groovy目录

(4) groovy又是基于Java，因此，接下来创建groovy的过程跟创建java很类似。在groovy新建包名，如：com.hc.plugin，然后在该包下新建groovy文件，通过new->file->MyPlugin.groovy来新建名为MyPlugin的groovy文件。

(5)为了让我们的groovy类申明为gradle的插件，新建的groovy需要实现org.gradle.api.Plugin接口。如下所示：

public class MyPlugin implements Plugin<project>{</project>

System.out.println("========================");

System.out.println("hello gradle plugin!");

System.out.println("========================");

因为我本人对groovy也不是特别熟悉，所以我尽可能的用Java语言，使用System.out.println而不是用groovy的pintln""，我们的代码里面啥也没做，就打印信息。

(6)现在，我们已经定义好了自己的gradle插件类，接下来就是告诉gradle，哪一个是我们自定义的插件类，因此，需要在main目录下新建resources目录，然后在resources目录里面再新建META-INF目录，再在META-INF里面新建gradle-plugins目录。最后在gradle-plugins目录里面新建properties文件，注意这个文件的命名，你可以随意取名，但是后面使用这个插件的时候，会用到这个名字。比如，你取名为com.hc.gradle.properties，而在其他build.gradle文件中使用自定义的插件时候则需写成：

apply plugin:'com.hc.gradle'

然后在com.hc.gradle.properties文件里面指明你自定义的类

implementation-class=com.hc.plugin.MyPlugin

(7)因为我们要用到groovy以及后面打包要用到maven,所以在我们自定义的Module下的build.gradle需要添加如下代码：

前面我们已经自定义好了插件，接下来就是要打包到Maven库里面去了，你可以选择打包到本地，或者是远程服务器中。在我们自定义Module目录下的build.gradle添加如下代码：

repository(url: uri('D:/repos'))

其中，group和version后面会用到，我们后面再讲。虽然我们已经定义好了打包地址以及打包相关配置，但是还需要我们让这个打包task执行。点击AndroidStudio右侧的gradle工具，如下图所示：

可以看到有uploadArchives这个Task,双击uploadArchives就会执行打包上传啦！执行完成后，去我们的Maven本地仓库查看一下：

其中，com/hc/plugin这几层目录是由我们的group指定，myplugin是模块的名称，1.0.0是版本号（version指定）。