Android-如何使用‘foreach’添加gradle依赖

原文地址:https://hackernoon.com/android-how-to-add-gradle-dependencies-using-foreach-c4cbcc070458#.mqxce4ehy

如果一个大的android项目中有几个modules并且有多个Gradle文件需要配置的话,是一个神烦的任务,通常要做的是向每个模块添加依赖项,在本篇文章中将介绍如何使用一个Gradle文件来控制所有模块的依赖项。

我们的目标是将如下的文件:

dependencies {
compile ‘com.android.support:appcompat-v7:24.2.0’
compile ‘com.google.dagger:dagger:2.7’
apt ‘com.google.dagger:dagger-compile:2.7’
compile ‘io.reactivex:rxjava:1.2.0’
compile ‘io.reactivex:rxandroid:1.2.1’
compile ‘com.squareup.okhttp3:okhttp:3.4.1’
compile ‘com.google.code.gson:gson:2.7’
testCompile ‘junit:junit:4.12’
}

转换成如下:

dependencies {
    rootProject.appDependencies.each {
        add(it.configuration, it.dependency, it.options)
    }
}

Dependencies File

为了完成这个转换,首先创建一个文件来管理项目依赖

创建一个文件denpendencies.gradle在项目的根目录下,然后定义所有用到的library的版本号。

ext{
    def versionAndroidSDK = '24.2.0'
    def versionDagger = '2.7'
    def versionRxJava = '1.2.0'
    def versionRxAndroid = '1.2.1'
    def versionOkHttp = '3.4.1'
    def versionGson = '2.7'
    def versionJUnit = '4.12'
}

一旦完成,让我们创建依赖映射,为了使文件尽量有组织,将定义三个map,一个用于Android官方库,一个用于第三方库,最后一个用于测试库。
看一下文件的样子:

ext {
//...
///
/// LIBS
///

  def androidLibs = [
    appCompat : [group: 'com.android.support', name: 'appcompat-v7', version: versionAndroidSDK]
  ]

  def libs = [
    dagger: [group: 'com.google.dagger', name: 'dagger', version:versionDagger],

    daggerCompiler: [group: 'com.google.dagger', name: 'dagger-compiler', version:versionDagger],

    rxAndroid: [group: 'io.reactivex', name: 'rxandroid', version: versionRxAndroid],

    rxJava: [group: 'io.reactivex', name: 'rxjava', version: versionRxJava],

    rxOkHttp: [group: 'com.squareup.okhttp3', name: 'okhttp', version: versionOkHttp],

    gson: [group: 'com.google.code.gson', name: 'gson', version: versionGson],

  ]

  def testLibs = [
    junit: [group: 'junit', name: 'junit', version: versionJUnit]
  ]
}

现在每个模块都需要包含一个所有依赖项的列表。
作为一个示例,app模块将会使用到所定义的AppCompat,Dagger,RxJava
和RxAndroid,如下列表所示:

ext {
  // Versions
  /// Libs
  /// Modules dependencies
  appDependencies = [
    [configuration: "compile", dependency: androidLibs.appCompat],
    [configuration: "compile", dependency: libs.dagger],
    [configuration: "apt", dependency: libs.daggerCompiler],
    [configuration: "compile", dependency: libs.rxAndroid],
    [configuration: "compile", dependency: libs.rxJava],
  ]
}

列表中的每一个对象,都包含一个定义依赖关系的映射及其配置,在这个例子中使用了compileapt配置,但是还有很多,如“provided”,“testCompile”,“androidTestCompile”,等等。

现在打开app模块的gradle文件,并且使用如下代码:

dependencies{
  rootProject.appDependencies.each{
    add(it.configuration,it.dependency)
  }
}

这是如何工作的?

通常我们添加一个依赖项如下所示:

compile 'com.google.code.gson:gson:2.7'

DependencyHandle对象添加方法会被直接调用,让我们看一下这个添加方法:

add(String configurationName,Object dependencyNotation)
向给定配置添加依赖关系

这两个方法接受两个参数,第一个是配置名称(compile,testCompile,androidTestCompile),第二个参数是依赖本身。

Dependency可以按照常规方式定义为一个String变量。

 'com.google.code.gson:gson:2.7'

如果使用最新的gradle版本的话,可以被定义成一个Map。

[group:'com.google.code.gson',name:'gson',version:'2.7']

回到代码:

 dependencies{
  rootProject.appDependencies.each{
    add(it.configuration,it.dependency)
  }
}

appdependencies列表在迭代之前创建,每次迭代都添加一个依赖项及其配置,it表示在迭代中表示当前元素。

这个过程需要在每个build.gradle文件中重复进行,这样当需要新的依赖时只需要把依赖添加到依赖文件中相应的集合中,这样,所有的依赖关系只用控制这一个文件中,此文件将可以在其他Android项目中重复使用。

模块之间的依赖

可以用于添加模块之间的依赖项
要这样做,需要在dependencies.gradle文件中定义所有模块,比如,app、data和domain模块。

{
  /// Versions
  /// Libs
  /// Module dependencies
  ///
  /// Modules
  ///
  def modules = [
  app: ':app',
  data: ':data',
  domain: ':domain'
  ]
}

如果app模块要使用domain模块的话,那么dependency需要按如下方式添加:

 ext {
  // Versions
  /// Libs
  /// Modules dependencies
  appDependencies = [
    [configuration: "compile", dependency: androidLibs.appCompat],
    [configuration: "compile", dependency: libs.dagger],
    [configuration: "apt", dependency: libs.daggerCompiler],
    [configuration: "compile", dependency: libs.rxAndroid],
    [configuration: "compile", dependency: libs.rxJava],
    // Domain dependency
    [configuration: "compile", dependency: project(modules.domain)],
  ]
}

可选项

如果需要任何其他选项,例如排除模块或使用可传递,常规的方法是:

androidTestCompile ('com.android.support.test:runner:0.5'){
  exclude module:'support-annotations'
}

首先要做的是,在依赖中添加一个额外的键值来表示选项。让我们看一个例子:

// Exclude example
[configuration: "androidTestCompiler", dependency: testRunner,
options: { exclude module: 'support-annotations'}]

现在app模块中的build.gradle文件中需要修改并且更改add方法,因此他添加一个闭包作为一个额外的参数以添加选项:

add(String configurationName,Object dependencyNotation,Closure configurationClosure)

向给定配置添加依赖关系,并使用给定的闭包配置依赖关系。

build.gradle文件看起来如下:

dependencies{
  rootProject.addDependencies.each{
    add(it.configuration, it.dependency, it.options)
  }
}

插件

有了这个过程,我们也可以管理,我们在每个模块中使用的插件,并通过dependencies.gradle文件来控制所有的插件,让我们看一个例子:

 apply plugin:'com.neebedankt.android-apt'
 apply plugin:'realm-android'
 apply plugin:'com.tatarka.retrolambda'

可以用如下替换:

rootProject.appPlugins.each{
  apply plugin.it
}

只需要创建一个列表,该插件将有dependencies.gradle文件中的模块使用。

ext {
  /// Versions
  /// Libs
  /// Modules Dependencies
  /// Modules
  /// Plugins
  appPlugins = [
    'com.neenbedankt.android-apt',
    'realm-android',
    'me.tatarka.retrolambda'
  ]
}

调用dependencies.gradle

以上所有过程得以调用完全依赖于在项目根路径下的build.gradle文件中调用dependencies.gradle文件

apply from: 'dependencies.gradle'

缺点

在这个过程中并非一切都是完美的,这种添加管理依赖的方式使得Android Studio在库过时的时候得到通知。

为了解决这个问题,可以使用常规方法和此方法共同管理,Android原生库使用常规方法管理以便在过时的时候接收到通知。

dependencies {
  compile "com.android.support:appcompat-v7:$rootProject.versionAndroidSDK"

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,072评论 25 707
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,803评论 6 342
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,651评论 18 139
  • 转载注明出处:http://www.jianshu.com/p/5255b100930e 0. 前言 完全由个人翻...
    王三的猫阿德阅读 2,514评论 0 4
  • 之后 任务拆解,比如思维导图的训练。我目前遇到的困难第一中心图案,不知道画什么,没有积累比较多的简笔画素材。自己也...
    思思培阅读 268评论 0 0