Skip to content

Latest commit

 

History

History
147 lines (115 loc) · 3.74 KB

README_CN.md

File metadata and controls

147 lines (115 loc) · 3.74 KB

gradle-java-preprocessor-plugin

Build Status Download

特点

将Antenna的Preprocess功能适配到gradle的插件中,可以在Android项目中使用宏修改Java代码.

  • 可以灵活自定义处理java代码的任务
  • 插件拓展productFlavors,在build的时候自动执行任务

安装

在build.gradle中加入以下配置

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'wang.dannyhe.tools:plugin:latest.release' //使用最新版本
    }
}
apply plugin: 'com.android.application' //'com.android.library'
apply plugin: 'wang.dannyhe.tools.preprocessor' //一定要在插件用用后再应用这个插件

使用

配置(v0.0.6及后续版本变动)

全局配置必须设置,sourceDir和targetDir只能通过preprocessor设置

preprocessor {
    verbose true
    sourceDir file("src/main/java") //必须设置
    targetDir file("src/main/java") //必须设置
    symbols "GLOBAL","GLOBAL_2" //修改类型为String[],全局设置的`symbols`会和`productFlavors`取并集,不存在productFlavors时，项目完全使用全局宏定义
}

配置productFlavors和flavorDimensions

flavorDimensions "money", "channel"
    productFlavors {

        xiaomi {
            processor.symbols "XIAOMI"
            dimension "money"
        }

        huawei {
            processor.symbols "HUAWEI"
            dimension "channel"
        }

        free {
            // uncomment to test process.
            // processor.symbols "FREE","PRINT"
            // processor.symbols "FREE","VERSION=1"
            processor.symbols "FREE","VERSION=5" //同样参数变为String[]
            dimension "channel"
        }
        VIP {
            processor.symbols "VIP"
            dimension "channel"
        }
    }

配置(v0.0.5及以下版本)

全局配置,这个是可选的.

// global setting
preprocessor {
    verbose true //是否打印日志
    sourceDir file("src/main/java") //Java源码所在根目录
    targetDir file("src/main/java") //生成的Java的根目录
    groupName 'preprocessor' //插件根据productFlavors生成的任务所在的分组名
}

配置productFlavors

productFlavors {
	free {
	    processor.symbols "FREE_VERSION" //定义宏,其他设置会继承preprocessor中的全局配置
	}
	normal {
	    processor.symbols "NFREE_VERSION"
	    processor.sourceDir file("src/main/java") //如果全局配置中存在sourceDir配置,这里会覆盖
	    processor.targetDir file("src/main/java") //如果全局配置中存在targetDir配置,这里会覆盖
	}
}

Java中使用宏

比如在MainActivity.java中使用

//#ifdef FREE_VERSION
	Log.i("sample","I am Free Version");
//#else
	Log.i("sample","I am not Free Version");
//#endif

执行任务

执行构建任务便会自动执行Java源码的修改,当然我们也可以手动执行任务.如:

gradle preprocessFreeRelease

最终Java代码会变成:

//#ifdef FREE_VERSION
	Log.i("sample","I am Free Version");
//#else
//@		Log.i("sample","I am not Free Version");
//#endif

可以看见FREE_VERSION已经生效并自动修改了Java源码

拓展使用

自定义任务:

// custom task
task customProcessJavaTask(type:wang.dannyhe.tools.PreprocessorTask) {
    sourceDir file("src/main/java")
    targetDir file("src/main/java")
    symbols "FREE_VERSION,PRINT"
    verbose true
}