android多个项目使用独立gradle缓存的办法

android多个项目使用独立gradle缓存的办法

背景

所在项目组做android开发，为了提高编译速度和代码解耦，把部分模块的代码打包成aar形式发布到maven上，每次开发拉取主干代码后，首次编译利用gradle的参数–refresh-dependencies从maven仓拉取更新aar文件，从而达到减少代码量和提高编译速度的目的。

问题场景

开发有时候需要在本地下载多份代码，我们设为项目A和项目B，A、B的代码基本是一致的，而依赖的aar是一样的，开发操作如下：

1. 下载A代码，gradle编译apk时，首次带上了–refresh-dependencies，编译成功
2. A代码增量编译，不再带–refresh-dependencies来更新aar，编译成功
3. 下载B代码，gradle编译apk时，首次带上了–refresh-dependencies，编译成功
4. 重新切回A代码，不带–refresh-dependencie，编译失败

问题原因

为什么4中会编译失败呢？查了一下资料，aar的缓存是存在了gradle.user.home的目录下面了，如果用户不手动设置目录，就会使用默认的C://user/.gradle目录。

所以实际上，同一台电脑上多个项目，都是用的同一份缓存。
问题场景3中，B代码重新refresh-dependencies，有可能此时某个aar的对外接口已经变更了，而变更后的aar存在了C://user/.gradle目录下，这个是A代码也要使用的，所以当B代码重新refresh-dependencies后，A代码就有编译失败的风险。此时A的主干代码依赖了高版本的aar代码。

解决尝试

我们可以修改在C://user/.gradle目录下的gradle.properties文件，增加一句gradle.user.home=D:\Android\.gradle来设置路径，但这个是类似于环境变量一样的东西，修改后就是全电脑生效，所以实际上就是换了个地方失败而已，不过可以解决缓存过大导致C盘爆满的问题

最终方案

因为所在项目下载代码时，会同时把gradlew脚本也下载，然后执行./gradlew assembleDebug来编译，然后点开gradlew脚本研究了下，在最后面有几行代码

eval "set -- $(
        printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
        xargs -n1 |
        sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
        tr '\n' ' '
    )" '"$@"'

exec "$JAVACMD" "$@"

这里exec是最终执行gradle代码的地方，$@是命令行传进来的参数，同时查看gradle文档发现利用-g参数可以执行gradle.user.home的路径，所以我们可以改成

eval "set -- $(
        printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
        xargs -n1 |
        sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
        tr '\n' ' '
    )" '"$@"'

exec "$JAVACMD" "$@" "-g" "gradle_cache"

通过默认配置-g参数，我们把gradle缓存存到了项目所在路径下的gradle_cache文件夹，这样就避免了多个项目共用一套缓存的问题

优缺点

1. 优点：每个项目使用单独缓存，避免缓存冲突导致编译失败的问题。
2. 缺点:首次编译时需要重新下载gradle的zip包，导致首次编译时间会变长。同时会导致磁盘占用变大，不过这个可以通过删除整个项目解决（久远的不用的项目）

总结

一个项目在本地电脑可能有多个备份工程，这些备份默认都是用的同一套gradle缓存，如果缓存的向前兼容性差，容易出现一个工程更新缓存后其他项目无法编译的问题，这个可以通过修改gradlew或者gradlew.bat，为每个项目指定一个单独缓存路径来解决。