痛点
壳工程通过implementation 'com.alibaba:fastjson:1.2.76'
的形式引入aar文件,而aar使用一个单独的业务工程开发,这种形式开发模式常见于组件化的工程中。这样做可以隔离代码,深度解耦,业务复用,节省编译时间。然而有时候我们需要在壳工程中进行aar联调,这时候我们就需要把aar工程的源码引入到壳工程中,在壳工程中做法如下:
-
在
settings.gradle
文件中添加如下配置include ":moduleName" project(":moduleName").projectDir = file("源码路径")
在app??橥ü?code>implementation project(":moduleName")方式引入
调试好后移除上面配置,发布版本。
这样做虽然能达到目的,但不够优雅,存在忘记恢复导致CI不能正确打包的可能性。下面我们进行优雅改造,文中所用的是AGP7.0+,AGP7.0改动挺大,7.0以下的自己修改即可。
步骤2可以使用gradle提供的替换apisubstitute module(dependenceName) with project(":moduleName")
,该api可以将原始依赖dependenceName(例如com.alibaba:fastjson,不包含版本号),替换成本地moduleName模块。
可以监听app??橄碌膅radle配置
configurations.all { config ->
config.resolutionStrategy.dependencySubstitution {
//使用substitute module api
}
}
这样就不用反复修改依赖了,但这样还不足够方便
优雅永不过时
在工程根目录下新增debug_aar.gradle
脚本,脚本内容如下。(AS提示import com.alibaba.fastjson.JSONArray错误,实际上是成功导入的,知道怎么消除的留言)
//https://docs.gradle.org/current/userguide/tutorial_using_tasks.html
buildscript {
//依赖仓库源
repositories {
maven { url 'https://maven.aliyun.com/nexus/content/repositories/google' }
maven { url 'https://maven.aliyun.com/nexus/content/groups/public' }
mavenCentral()
}
dependencies {
//为当前脚本添加解析gson的依赖
classpath "com.alibaba:fastjson:1.2.76"
}
}
//AS会提示找不到JSONArray,JSONObject直接忽略
import com.alibaba.fastjson.JSONArray
import com.alibaba.fastjson.JSONObject
List<ModuleSource> list = loadDebugConfig()
for (ModuleSource module : list) {
if (module.debug) {
include ":${module.moduleName}"
//gradle8弃用了/xx/xx相对路径的形式,所以用使用$绝对路径
project(":${module.moduleName}").projectDir = file("${module.sourceDir}")
println("debug外部??閇:${module.moduleName}],源码路径 ${module.sourceDir}")
}
}
if (list.size() > 0) {
gradle.addProjectEvaluationListener(new ProjectEvaluationListener() {
@Override
void beforeEvaluate(Project projectObj) {
}
@Override
void afterEvaluate(Project projectObj, ProjectState state) {
// boolean isAppModule = projectObj.plugins.hasPlugin('com.android.application')
// if (!isAppModule) {
// //只处理application???// return
// }
projectObj.configurations.all { config ->
config.resolutionStrategy.dependencySubstitution {
for (ModuleSource ms : list) {
if (ms.debug) {
substitute module(ms.dependenceName) with project(":${ms.moduleName}")
}
}
}
}
}
})
}
def loadDebugConfig() {
List<ModuleSource> list = new ArrayList<>()
String json = null
try {
json = file("debug_aar_config.json").getText()
} catch (ignored) {
println("根目录不存在debug_aar_config.json文件。(如果不需要debug aar源码忽略该信息)")
}
if (json == null) {
return list
}
//解析debug_source_config.json中的字段
JSONArray jsonArray = (JSONArray) JSONObject.parse(json)
for (int i = 0; i < jsonArray.size(); i++) {
JSONObject ob = (JSONObject) jsonArray.get(i)
boolean isDebug = ob.getBoolean("debug")
String moduleName = ob.getString("module_name")
String sourceDir = ob.getString("source_dir")
String dependenceName = ob.getString("dependence_name")
if (moduleName == null || sourceDir == null || dependenceName == null) {
println("数据[${moduleName},${sourceDir},${dependenceName}]异常,该配置被忽略!!")
continue
}
list.add(new ModuleSource(isDebug, moduleName, sourceDir, dependenceName))
}
return list
}
class ModuleSource {
/**是否调试aar*/
boolean debug = false
/**引入module名字*/
String moduleName = null
/**
* aar依赖,去掉版本号,例如引入aar依赖com.google.code.gson:gson:2.8.5
* 则dependenceName为com.google.code.gson:gson
*/
String dependenceName = null
/**绝对路径*/
String sourceDir = null
ModuleSource(boolean debug, String moduleName, String sourceDir, String dependenceName) {
this.debug = debug
this.moduleName = moduleName
this.dependenceName = dependenceName
this.sourceDir = sourceDir
}
}
使用
在settings.gradle
中引入上面的脚本,如下:
rootProject.name = "Test"
include ':app'
//引入脚本
try {
apply from: 'debug_aar.gradle'
} catch (ignored) {
}
让这个脚本工作起来还需要一个配置debug_aar_config.json
文件,这个文件应该被加入到git忽略文件,如果不存在这个json文件,我们的脚本是不工作的,这样就不影响CI的正式发版。
在根目录下创建debug_aar_config.json
文件,文件内容如下
[
{
"debug": true,
"module_name": "testModdule",
"source_dir": "D:\xxx\test",
"dependence_name": "com.alibaba:fastjson"
}
]
- debug:是否调试aar源码
- module_name:调试源码时??榈拿?/li>
- source_dir:源码路径,以根目录为起点的路径写法,所以一般需要用..返回到上级
- dependence_name:aar的远程依赖
json是个数组,可以增加或者删除,每次修改完json文件,需要sync工程通知修改。
可以看到只需修改json即可。
注意事项
- org.gradle.configureondemand=true的配置,会导致在调试aar源码时,找不到对应的module。所以需要关闭这个配置