自定义Gradle Plugin

Author: Ryze

.gitignore

@@ -0,0 +1,10 @@
+*.iml
+.gradle
+/local.properties
+/.idea/workspace.xml
+/.idea/libraries
+.DS_Store
+/build
+/captures
+.externalNativeBuild
+/.idea

README.md

@@ -1 +1,184 @@
-# Android-GradlePlugin-Demo
+## Android Gradle Plugin 
+
+### Android Gradle Plugin 有两种形式
+
+> 1. 直接在build.gradle/创建x.gradle中开发
+
+> 2. 实现`Plugin`重写build 过程
+
+这里讲解怎么开发自定义插件
+
+### 首先创建Gradle Plugin 工程
+
+* 为了方便测试先创建一个Android 工程，然后创建一个Android library Module工程
+
+![创建module](https://raw.githubusercontent.com/goodbranch/AndroidNote/master/note/gradle/module-1.png)
+
+* 删除如图中箭头所指目录和文件
+
+![删除无效目录](https://raw.githubusercontent.com/goodbranch/AndroidNote/master/note/gradle/module-2.png)
+
+* `build.gradle`中改成groovy方式
+
+
+		apply plugin: 'groovy'
+
+		dependencies {
+		    compile gradleApi()
+		    compile localGroovy()
+		}
+
+
+### 自定义Gradle Plugin，在main目录下创建groovy目录，这个目录下创建创建自己的代码
+
+#### 以删除log日志为例
+
+![Groovy 项目结构](https://raw.githubusercontent.com/goodbranch/AndroidNote/master/note/gradle/groovy-project.png)
+
+#### 1.继承 gradle`Plugin`，类的后缀不再是.java而是.groovy
+
+	class DelLogPlugin implements Plugin<Project> {
+	  @Override
+	  void apply(Project project) {
+
+
+	    project.extensions.create('dellogExtension', DelLogExtension);
+
+	    project.afterEvaluate {
+	      //在gradle 构建完之后执行
+	      project.logger.error("dellogExtension : " + project.dellogExtension.sourceDir);
+
+	      def rootDir = project.projectDir.toString().plus(project.dellogExtension.sourceDir);
+
+	      project.logger.error(rootDir);
+
+	      DelLogUtil.delLog(new File(rootDir));
+	    }
+
+	    project.task('dellog', {
+	      project.logger.error("dellogExtension : " + project.dellogExtension.sourceDir);
+
+	      def rootDir = project.projectDir.toString().plus(project.dellogExtension.sourceDir);
+
+	      project.logger.error(rootDir);
+
+	      DelLogUtil.delLog(new File(rootDir));
+
+	    })
+
+	  }
+	}
+
+
+`afterEvaluate`是在gradle构建完后自动执行的，但task需要手动执行
+一个插件中可以创建多个Task,如代码中的`dellog`，可以在控制台执行`gradle -q dellog`，也可以在gradle图形界面执行
+
+![图形界面执行task](https://raw.githubusercontent.com/goodbranch/AndroidNote/master/note/gradle/gradle-task-ui.png)
+
+#### 2. 创建可以输入的Gradle 插件
+
+> 很多时候我们需要输入参数，然后根据参数来做处理,处理如下：
+project.extensions.create(...,...); 前面是Name，后面是Model,model中在gralde script 中键对上就可以。
+
+	class DelLogExtension {
+
+	  String sourceDir;
+
+	}
+
+
+	class DelLogPlugin implements Plugin<Project> {
+	  @Override
+	  void apply(Project project) {
+
+
+	    project.extensions.create('dellogExtension', DelLogExtension);
+
+	    ......
+
+然后在app 下的build.gradle中
+
+	dellogExtension.sourceDir = '/src'
+
+或
+
+	dellogExtension {
+	  sourceDir = '/src'
+	}
+
+![使用输入](https://raw.githubusercontent.com/goodbranch/AndroidNote/master/note/gradle/use-extension.png)
+
+
+### 3. 在main下创建`resources`目录
+
+`src/main/resources/META-INF/gradle-plugins/com.branch.plugin.dellog.properties`
+
+`xxx.properties` 将来作为apply plugin: xxx 插件名称，这里的目录结构不能错，先有`META-INF`再有`gradle-plugins`
+
+内容：
+
+	`implementation-class=com.branch.dellog.DelLogPlugin(继承Plugin的类，插件的入口类)`
+
+### 4. 发布到本地仓库
+
+在当前lib项目build.gradle中增加maven支持
+
+	apply plugin: 'maven'
+
+	repositories {
+	  mavenCentral()
+	}
+
+然后增加对应的maven deployer
+
+	//设置maven deployer
+	uploadArchives {
+	  repositories {
+	    mavenDeployer {
+	      //设置插件的GAV参数
+	      pom.groupId = 'com.branch.plugin'
+	      pom.artifactId = 'dellog'
+	      pom.version = '1.0.0'
+	      //文件发布到下面目录
+	      repository(url: uri('../repo'))
+	    }
+	  }
+	}
+
+这里设置发布到上一个目录的`repo`中,同时可以查看gradle task中有一个名为uploadArchives的task
+
+![发布到本地task](https://raw.githubusercontent.com/goodbranch/AndroidNote/master/note/gradle/maven-local-task.png)
+
+执行就能在`repo`中查看到相应jar包
+
+![查看本地仓库](https://raw.githubusercontent.com/goodbranch/AndroidNote/master/note/gradle/maven-local-resuslt.png)
+
+### 5. 使用本地仓库
+
+在project 的build.gradle 中`buildscript`中增加本地仓库地址
+
+	buildscript {
+	  repositories {
+	    jcenter()
+	    maven {
+	      url uri("/repo")
+	    }
+	  }
+	  dependencies {
+	    classpath 'com.android.tools.build:gradle:2.2.2'
+	    classpath 'com.branch.plugin:dellog:1.0.0'
+
+	    // NOTE: Do not place your application dependencies here; they belong
+	    // in the individual module build.gradle files
+	  }
+	}
+
+然后在app 的build.gradle中增加plugin
+
+	apply plugin: 'com.branch.plugin.dellog'
+
+
+#### 所有这些配置正确后同步项目可在Gradle Console查看到日志
+
+
+#### [github demo](https://github.com/goodbranch/Android-GradlePlugin-Demo/tree/master)

app/.gitignore

@@ -0,0 +1 @@
+/build

app/build.gradle

@@ -0,0 +1,37 @@
+apply plugin: 'com.android.application'
+apply plugin: 'com.branch.plugin.dellog'
+
+android {
+  compileSdkVersion 25
+  buildToolsVersion "25.0.1"
+  defaultConfig {
+    applicationId "com.branch.www.dellogdemo"
+    minSdkVersion 11
+    targetSdkVersion 25
+    versionCode 1
+    versionName "1.0"
+    testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
+  }
+  buildTypes {
+    release {
+      minifyEnabled false
+      proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+    }
+  }
+
+}
+
+dependencies {
+  compile fileTree(dir: 'libs', include: ['*.jar'])
+  androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', {
+    exclude group: 'com.android.support', module: 'support-annotations'
+  })
+  compile 'com.android.support:appcompat-v7:25.1.0'
+  testCompile 'junit:junit:4.12'
+}
+
+//dellogExtension.sourceDir = '/src'
+
+dellogExtension {
+  sourceDir = '/src'
+}

app/proguard-rules.pro

@@ -0,0 +1,17 @@
+# Add project specific ProGuard rules here.
+# By default, the flags in this file are appended to flags specified
+# in E:\BaiduYunDownload\adt-bundle-windows-x86_64-20140702\sdk/tools/proguard/proguard-android.txt
+# You can edit the include path and order by changing the proguardFiles
+# directive in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# Add any project specific keep options here:
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}

app/src/androidTest/java/com/branch/www/dellogdemo/ExampleInstrumentedTest.java

@@ -0,0 +1,26 @@
+package com.branch.www.dellogdemo;
+
+import android.content.Context;
+import android.support.test.InstrumentationRegistry;
+import android.support.test.runner.AndroidJUnit4;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import static org.junit.Assert.*;
+
+/**
+ * Instrumentation test, which will execute on an Android device.
+ *
+ * @see <a href="http://d.android.com/tools/testing">Testing documentation</a>
+ */
+@RunWith(AndroidJUnit4.class)
+public class ExampleInstrumentedTest {
+  @Test
+  public void useAppContext() throws Exception {
+    // Context of the app under test.
+    Context appContext = InstrumentationRegistry.getTargetContext();
+
+    assertEquals("com.branch.www.dellogdemo", appContext.getPackageName());
+  }
+}

app/src/main/AndroidManifest.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+          package="com.branch.www.dellogdemo">
+
+  <application
+      android:allowBackup="true"
+      android:icon="@mipmap/ic_launcher"
+      android:label="@string/app_name"
+      android:supportsRtl="true"
+      android:theme="@style/AppTheme">
+    <activity android:name=".MainActivity">
+      <intent-filter>
+        <action android:name="android.intent.action.MAIN"/>
+
+        <category android:name="android.intent.category.LAUNCHER"/>
+      </intent-filter>
+    </activity>
+  </application>
+
+</manifest>

app/src/main/java/com/branch/www/dellogdemo/MainActivity.java

@@ -0,0 +1,20 @@
+package com.branch.www.dellogdemo;
+
+import android.os.Bundle;
+import android.support.v7.app.AppCompatActivity;
+import android.util.Log;
+
+public class MainActivity extends AppCompatActivity {
+
+  @Override
+  protected void onCreate(Bundle savedInstanceState) {
+    super.onCreate(savedInstanceState);
+    setContentView(R.layout.activity_main);
+
+;
+
+    ;
+
+
+  }
+}

app/src/main/java/com/branch/www/dellogdemo/TestDelLog.java

@@ -0,0 +1,21 @@
+package com.branch.www.dellogdemo;
+
+import android.util.Log;
+
+/**
+ * Created by Ryze on 2017-2-5.
+ */
+
+public class TestDelLog {
+
+  public static void test() {
+
+;
+
+;
+
+
+
+  }
+
+}

app/src/main/res/layout/activity_main.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="utf-8"?>
+<RelativeLayout
+    xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools"
+    android:id="@+id/activity_main"
+    android:layout_width="match_parent"
+    android:layout_height="match_parent"
+    android:paddingLeft="@dimen/activity_horizontal_margin"
+    android:paddingRight="@dimen/activity_horizontal_margin"
+    android:paddingTop="@dimen/activity_vertical_margin"
+    android:paddingBottom="@dimen/activity_vertical_margin"
+    tools:context="com.branch.www.dellogdemo.MainActivity">
+
+  <TextView
+      android:layout_width="wrap_content"
+      android:layout_height="wrap_content"
+      android:text="Hello World!"/>
+</RelativeLayout>

app/src/main/res/mipmap-hdpi/ic_launcher.png

@@ -0,0 +1,6 @@
+<resources>
+  <!-- Example customization of dimensions originally defined in res/values/dimens.xml
+         (such as screen margins) for screens with more than 820dp of available width. This
+         would include 7" and 10" devices in landscape (~960dp and ~1280dp respectively). -->
+  <dimen name="activity_horizontal_margin">64dp</dimen>
+</resources>

app/src/main/res/mipmap-mdpi/ic_launcher.png

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+  <color name="colorPrimary">#3F51B5</color>
+  <color name="colorPrimaryDark">#303F9F</color>
+  <color name="colorAccent">#FF4081</color>
+</resources>

app/src/main/res/mipmap-xhdpi/ic_launcher.png

@@ -0,0 +1,5 @@
+<resources>
+  <!-- Default screen margins, per the Android Design guidelines. -->
+  <dimen name="activity_horizontal_margin">16dp</dimen>
+  <dimen name="activity_vertical_margin">16dp</dimen>
+</resources>

app/src/main/res/mipmap-xxhdpi/ic_launcher.png

@@ -0,0 +1,3 @@
+<resources>
+  <string name="app_name">DelLogDemo</string>
+</resources>