在aar库中传递参数

在aar库中传递参数

aar是Android Studio提供的一个依赖库系统,可以很方便的让主项目来使用库项目的代码、资源。

但如何来给一个aar库传递编译参数呢(传递代码配置是很方便的,通过接口即可,但编译参数是不行的)?这个场景还是非常常见的,例如下面的这样一个项目:

├── app
│   ├── build.gradle
│   ├── libs
│   └── src
├── build.gradle
├── gradle.properties
└── testlibrary
    ├── build.gradle
    ├── libs
    └── src

这个示例来自公司对推送SDK的封装,我们都知道,第三方的推送SDK需要配置很多AppKey,这些都是在编译时就需要指定的,鄙司对第三方的推送SDK又做了一层封装,抽出了一个aar库,因此,需要在编译时将AppKey传递给aar。

爆栈上实际上已经有这个提问了,但很遗憾没有人回答,http://stackoverflow.com/questions/32955764/how-to-keep-placeholders-in-an-aars-manifest/32955888

app是我们的主项目,依赖testlibrary这样一个aar库项目(上面的目录中是以源码依赖的,但实际上我们是以aar的方式依赖)。这时候主项目依赖testlibrary的时候,需要给testlibrary传一个key,那么考虑将key写在gradle.properties中,通过manifestPlaceholders来进行引用,也就是这样:

testlibrary AndroidMainifest.xml:

<meta-data
    android:name="APP_KEY"
    android:value="${APP_KEY}"/>

testlibrary build.gradle:

manifestPlaceholders = [
        "APP_KEY" : app_key
]

其中app_key就是写在gradle.properties中的参数。

貌似这种方式就可以解决这种问题,但实际上,编译成aar后,你就会发现,在编译aar的时候,你在AndroidMainifest.xml中申明的manifestPlaceholders就已经被替换调了!而且,不管你怎么做,不替换调manifestPlaceholders的值,是肯定编译不过的。那么是不是意味着manifestPlaceholders这条路是行不通的呢?

我们先来仔细分析下问题的原因,我们在编写aar代码的时候,希望aar能够接收外界传来的编译参数,但是,在编译aar的时候,需要提供具体的值来替换这些manifestPlaceholders,否则,则编译不过,貌似整个过程就陷入了一个死循环。。。

解决办法自然是有的,比如,使用一个特殊的标志符,例如xxxxx_abc这样的标志,在主项目中,通过Task来进行Mainifest的替换,但是,这肯定不是我们想要的,因为,Gradle没有这么Low啊!!!解决的方法就是对Gradle文档进行阅读理解!!!地址如下:

http://tools.android.com/tech-docs/new-build-system/user-guide/manifest-merger#TOC-Placeholder-support

我们定位到Android Manifest file merging,好好理解其中的每一句话,只到我们读到这句话:

The syntax for placeholder values is ${name} since @ is reserved for links. After the last file merging occurred, and before the resulting merged android manifest file is written out, all values with a placeholder will be swapped with injected values. A build breakage will be generated if a variable name is unknown.

有点意思吧,除了我们常用的${}的manifestPlaceholders写法,实际上,还有一种以@开头的写法!!!

OK,这种写法的含义就是,通过@开头来指定manifestPlaceholders的Key的时候,表示当前编译不执行manifestPlaceholders的替换!!!那么通过这种方式,我们就可以生成带manifestPlaceholders的aar库,从而解决我们前面提到的这个问题。

具体的解决方式如下:

testlibrary AndroidMainifest.xml:

<meta-data
    android:name="APP_KEY"
    android:value="${APP_KEY}"/>

testlibrary build.gradle:

manifestPlaceholders = [
        "@APP_KEY" : ""
]

是的,你没有看错,前面加一个@就可以了,这样你在编译aar的时候,就会保留本库中的manifestPlaceholders而不做任何替换!!!通过这样的设置,你就可以在主项目引用的时候再进行manifestPlaceholders的替换,从而实现编译参数传递。

在主项目中,配置manifestPlaceholders即可。

app build.gradle:

manifestPlaceholders = [
        "APP_KEY" : app_key
]

这里的app_key就是写在gradle.properties中的参数。

So easy,一个字符解决了所有问题。

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

推荐阅读更多精彩内容