背景:
在开发,一些在jar包或底层库封装的一些常量参数有时需要根据环境的切换而改变,如在jar中的使用的baseUrl,一般都是通过向外暴露一个set()方法,由外部注入。但若在底层库在多个模块引用,又不能避免其他模块对参数的修改时,特别是在大项目若一些管理混乱的项目中,就会出现多个地方set不同的值,不能保证参数set()入口的唯一性。这时便可以考虑不向外暴露set()方法。并将原参数定义为 private static final ,这样外面就不能随便修改该参数值。但我们如何去动态修改该参数呢?
google了一圈,没有找到合适的工具。索性自己写一个gradle的插件,利用class文件编辑利器ASM和Android提供的Transform动态修改jar包中的class文件。即可实现上述动态修改私有的静态常量。另外还提供了对Java源代码的字符串替换方法。
github地址:ClassPlaceholder
插件创建参考这篇:
使用:
- 引入插件
buildscript {
repositories {
maven { url 'https://plugins.gradle.org/m2/' }
}
dependencies {
classpath 'gradle.plugin.me.xp.gradle:placeholder:1.0.1'
}
}
- 在要替换的类中使用占位符预埋好要替换要常量,如:
public static final String TEST_PUBLIC = "${public}";
private static final String TEST_PRIVATE = "${private}";
3.在主项目的build.gradle文件中添加placeholder插件,定义在替换的值及文件名,如:
apply plugin: 'me.xp.gradle.placeholder.PlaceholderPlugin'
placeholders {
addholder {
//is modify source java file
isModifyJava = true
//modify file name
classFile = "me/xp/gradle/classplaceholder/AppConfig.java"
//replace name and value
values = ['public' : 'AppConfigPubic',
'private': 'AppConfigPrivate',
'field' : 'AppConfigField']
}
addholder {
isModifyJava = false
classFile = "me/xp/gradle/jarlibrary/JarConfig.class"
values = ['config': 'JarConfigPubic']
}
}
- 添加后,若修改替换值,需要先执行clean命令,再build即可在jar包展开的class文件中看到替换后的值。