AAR依赖和module源码动态切换

痛点

壳工程通过implementation 'com.alibaba:fastjson:1.2.76'的形式引入aar文件,而aar使用一个单独的业务工程开发,这种形式开发模式常见于组件化的工程中。这样做可以隔离代码,深度解耦,业务复用,节省编译时间。然而有时候我们需要在壳工程中进行aar联调,这时候我们就需要把aar工程的源码引入到壳工程中,在壳工程中做法如下:

  1. settings.gradle文件中添加如下配置

    include ":moduleName"
    project(":moduleName").projectDir = file("源码路径")
    
  2. 在app??橥ü?code>implementation project(":moduleName")方式引入

  3. 调试好后移除上面配置,发布版本。

这样做虽然能达到目的,但不够优雅,存在忘记恢复导致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即可。

注意事项

  1. org.gradle.configureondemand=true的配置,会导致在调试aar源码时,找不到对应的module。所以需要关闭这个配置
最后编辑于
?著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,100评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,308评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事?!?“怎么了?”我有些...
    开封第一讲书人阅读 159,718评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,275评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,376评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,454评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,464评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,248评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,686评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,974评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,150评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,817评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,484评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,140评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,374评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,012评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,041评论 2 351

推荐阅读更多精彩内容