这篇文章主要是在前几篇文章的基础上实现一个Android打包的插件,所以没看过前几篇文章的朋友可以先查看:
Gradle插件学习笔记(一)
Gradle插件学习笔记(二)
Gradle插件学习笔记(三)
本来想将写的插件上传到maven提供给大家使用,但是后来还是决定以开源库的形式提供给大家,主要是因为
- 网上关于Gradle功能性插件的开源工程很少,很难找到学习资料,这个库可以方便开发者入门,学习
- 开发者打包需求各种各样,由于提供的接口不够,可能会影响开发者使用,所以,不如将源码提供给大家。
- 也希望大家多多star,有什么意见可以给我留言
demo地址
引入工程
由于并没有上传maven,只需要把demo工程中的buildSrc文件夹粘贴入自己的工程即可使用
有问题可以issues我,或者微信公众号给我留言:
我的公众号:
功能介绍
这个插件的主要功能分为三部分
打包apk
- 打包apk提供了输出到指定文件夹的功能
- 打包apk提供了修改apk名字的功能
- 打包apk提供了修改渠道或修改AndroidManifest指定字段的功能
使用方式
修改 apk module的build.gradle
apply plugin: 'deep.app'
deep{
name "{name}_{type}_{flavor}_deep.apk"
path "../out"
holder= [aaa:123,bbb:666]
}
参数 | 描述 |
---|---|
name | 输出的apk名字 |
path | 指定输出路径 |
holder | AndroidManifest指定替换的字段 如上述:将AndroidManifest中的aaa替换成123,bbb替换成666 |
需要注意的是如果想指定名字为普通名字直接输入字符串即可,如果需要与变异模式绑定,只需要加{}:
参数 | 描述 |
---|---|
{name} | 当前module的名字 |
{type} | 编译方式,debug release或其它自定义的模式 |
{flavor} | flavor,如果没有自定义就没有 |
效果如下:
特殊说明
可能有开发者会问,为什么没有提供选择打包文件的功能,即不同apk打包不同文件,如果有这种需求的朋友,建议使用flavor,android提供了flavor可以很方便设置打包出不同报名不同内容的apk,如果对flavor感兴趣的朋友可以给我留言,或者查看我之前的一片文章Android工程gradle详解
打包aar或jar
打包aar或jar提供了两种不同形式配置
- aar与apk类似,提供了替换Androidmanifest内容的功能
- aar 提供了指定输出路径或输出内容的功能,与apk打包一致
- jar提供了指定混淆,指定打入内容,指定去除内容,指定打入三方依赖库,指定输出的功能
使用方式
apply plugin: 'deep.library'
deep {
aar{
name "{name}_{type}_{flavor}_deep.aar"
path "../out/aar"
holder= [aaa:123,bbb:666]
}
jar{
name "{name}_{type}_{flavor}_deep.jar"
path "../out/jar"
excludeClass=['com/deep/test/exclude.class']
excludePackage=['exclude']
isProguard true
includeJar = ["libs/open_sdk_r5923_lite.jar"]
}
}
aar中参数说明:
参数 | 描述 | 备注 |
---|---|---|
name | 输出的aar名字 | 特殊参数与apk一致,这里不做赘述 |
path | 指定输出路径 | |
holder | AndroidManifest指定替换的字段 | 如上述:将AndroidManifest中的aaa替换成123,bbb替换成666 |
效果如下:
jar中参数说明:
参数 | 描述 | 备注 |
---|---|---|
name | 输出的jar名字 | 特殊参数与apk一致,这里不做赘述 |
excludeClass | 打成jar,不包含的文件 | |
excludePackage | 打成jar 不包含的package | |
isProguard | 是否混淆 | |
prpguardFile | 混淆文件 | 相对于module路径的,不设置,默认使用proguard-rules.pro |
includeJar | 需要打入的三方jar |
效果如下:
打包日志功能
有的时候,我们觉得gradle的打包日志都是英文很烦,没用页也看不懂,没关系,使用这个功能可以开关日志,或打印自己需要的日志。
选择使用的module,修改build.gradle
import com.deep.DeepLogger
import com.deep.DeepTimeListener
gradle.useLogger(new DeepLogger(true))
gradle.addListener(new DeepTimeListener(true))
如果不想使用,只需要将参数设置为false即可:
通过这个日志可以看出没有Task的耗时,以及对应任务的开始关闭。
在最后会有所有任务的耗时:
这些日志的提示内容都是可以设置:
只需要修改DeepLogger
文件,这里面有所有任务的生命周期,只需要插入你想要的log即可。
总结
今天将插件的所有功能介绍完毕了,如果有需求,也可以给我留言,我会再开一篇文章介绍一下代码,方便大家修改代码。