Gradle学习8——依赖管理

学习本系列前可以下载相关的github项目gradleLearnDemo
地址:https://github.com/sososeen09/gradleLearnDemo

依赖管理是Gradle非常棒的一个功能,很多情况下,你只需要在构建文件中添加一行代码,Gradle就会从远程仓库中下载依赖,在项目中就可以使用依赖中的类。如果你所依赖的这个库本身也有它自己的依赖,Gradle会处理并解决这些问题,这些依赖中的依赖,被称作传递性依赖。

Gradle使用 dependencies 这个DSL来定义构建所依赖的类库,使用repositories 来告诉构建从哪里获取依赖,当你配置好后,Gradle会自动下载依赖,并存储在本地缓存中,在构建中使用它们,一个特定版本的依赖只会在你的机器上下载一次。
例如:

repositories {
    mavenCentral()
}

dependencies {
    compile 'org.jsoup:jsoup:1.9.2'
}

Gradle支持三种不同的依赖仓库:Maven、Ivy和静态文件或文件夹。一个依赖通常由三种元素定义的,可以称呼它们为依赖属性。

  • group:通常标识一个组织、公司或者项目。如org.jsoup
  • name:一个工件的名称唯一的描述了依赖。如::jsoup
  • version:一个类库的版本号。如1.9.2

上面的dependencies,也可以使用map形式包含group、name、version属性。例如:

dependencies {
    compile group:'org.jsoup', name:'jsoup', version:'1.9.2'
}

对于依赖来说,唯一需要的字段是name。group和version都是可选的元素。尽管如此,为了表述清楚,建议添加group,而version可确保依赖库不会自动更新。

1 使用和配置仓库

为了方便,Gradle预定义了三个Maven仓库:

  • Jcenter
  • Maven Central
  • 本地Maven仓库

Gradle使用Maven Central仓库就是调用mavenCentral()方法,其它两个仓库的使用也类似。为了在构建脚本中包含它们,你需要这么做:

repositories {
    jcenter()
    mavenCentral()
    mavenLocal()
}

Maven Central 和JCenter是两个有名的远程仓库,一般不同时使用它们,通常推荐使用JCenter,它是Maven Central的超集,其也是Android Studio创建Android项目时的默认依赖仓库,而且JCenter还支持HTTPS。

本地Maven仓库是你已经使用了的所有依赖的本地缓存,你也可以自己添加依赖。默认情况下,依赖仓库可以在一个名为.m2目录文件夹的主目录中找到。在Linux或Mac OS X上,该路径是~/.m2,在Windows上路径是%UserProfile%/.m2。
除了这些预定义的依赖仓库,你也可以添加其它的公有或私有仓库,可以指定一个任意的Maven或者Ivy仓库的URL并且配置来使用身份验证,或者可以使用简单的文件系统仓库来解决依赖关系。

在项目中定义仓库的关键是RepositoryHandler接口,它提供了添加各种类型仓库的方法。从项目上看,这些方法在repositories配置块中被调用。

可以声明多个仓库,下载依赖的时候按照声明的顺序来检查仓库,仓库提供了依赖优先原则,对于特定的依赖后续的仓库声明不会被进一步检查。

repositories {
    mavenLocal()
    jcenter()
    maven { url "https://jitpack.io" }
    flatDir {
        dirs 'libs'
    }
}

Gradle API 支持两种方式来配置一个自定义仓库:maven()和mavenRepo()。

repositories {
    maven {
        name 'Custom Maven Repository'
        url 'http://repo.acmp.com/release/'
    }
}

也可以使用Ivy仓库,

repositories {
    ivy {
        url 'http://repo.acmp.com/release/'
    }
}

有些Maven仓库的访问需要凭证,那么可以这样:

repositories {
    maven {
        url 'http://repo.acmp.com/release/'
        credentials{
            username 'user'
            password 'secretPassword'
        }
    }
}

不建议在构建配置文件中存储凭证,最好是在本地一个单独的未纳入版本控制系统的属性文件存储凭证

扁平的目录仓库
flat目录是最简单和最基本的仓库形式。在文件系统中它是一个单独的目录,只包含jar文件或者Android 库中的aar类型的文件,没有maven元数据。
当声明依赖时,你只能使用name和versin属性,不能使用group属性,因为它会导致产生不明确的依赖关系。

dependencies {
    compile name: 'jsoup', version: '1.9.2'
}

repositories {
    flatDir{
        dirs 'flatlibs'
    }
}

2 本地依赖

某些情况下,你可能仍然需要使用手动下载的jar文件或原生库。
你可以使用Gradle提供的files方法来添加jar文件作为一个依赖,例如:

dependencies{
    compile files('libs/jsoup.jar')
}

如果jar文件很多,我们一个一个的这样依赖太繁琐,就可以一次添加一个完成的文件夹:

dependencies{
    compile fileTree('libs')
}

在Android Studio中创建Android项目的时候,新建的Android项目会有一个libs文件夹,其会被声明为依赖的文件夹,并且通过过滤只依赖jar文件,而不是所有的文件:

dependencies{
    compile fileTree(include: ['*.jar'], dir: 'libs')
}

原生依赖
如果想要使用C或C++编译的原生依赖库.so文件,需要指明jniLibs的目录。假设.so文件也都放置在libs目录下,如图:

《Gradle学习8——依赖管理》 image.png

在脚本文件中就需要这么配置:

android {
    sourceSets {
        main {
            jniLibs.srcDirs = ['libs']
        }
    }
}

依赖项目
如果在项目中创建了一个模块作为依赖项目,那么需要在settings.gradle中添加该模块,然后在应用模块中使用它作为依赖。比如,在Android项目中,app模块是我们的主模块,library模块是依赖模块,也称作依赖库。
settings.gradle 中添加:

include ':app' ,' : library'

app模块下的build.gradle中添加:

dependencies{
    compile project(':library')
}

使用.aar文件
当你已经把aar文件放置在libs目录下或者其他的扁平文件目录下,添加aar文件作为依赖可以这么操作:

compile(name: 'libraryname', ext: 'aar')

这样就告知Gradle查找具有特定名称切扩展名为.aar的依赖库

3 依赖配置

前面我们讲了添加依赖库的时候,前面都要有一个compile。其实这个compile就是一个配置Configuration。
Gradle根据配置对依赖进行分组,比如编译Java时使用的是这组依赖,运行Java时又可以使用另一组依赖。每一组依赖称为一个Configuration,在声明依赖时,我们实际上是在设置不同的Configuration。
Java插件提供了6个现成的配置:compile、runtime、testCompile、testRuntime、archives、default。
而在Android中的插件也提供了几个标准配置:compile、apk、provided、testCompile、androidTestCompile。
compile 是默认的配置,在编译主应用时包含所有的依赖,不禁会将依赖添加至类路径,还会生成对应的apk。
如果依赖使用apk配置,则该依赖只会被打包到apk,而不会被添加到编译类路径。
provided配置与apk配置相反,只在编译的时候用到,其依赖不会被打包进apk。
testCompile、androidTestCompile配置会添加用于测试的额外依赖库,在运行测试相关的任务时会被用到。比如添加JUnit或者Espresso测试框架。

要自定义一个配置Configuration,我们可以这样:

configurations {
    myConfiguration {
        description = 'this is  my configuration'
        visible = false
    }
}

我们在自定义配置的时候,同时定义了该配置的一些属性,description表示的是该配置的描述信息,visiable表示该配置是否可以在该Project之外可见,默认是true。还可以定义其它的属性,具体可参考Configuration这个类。当然,你也可以什么都不写。configurations对应的Gradle的Api中ConfigurationContainer
这个类。

以上只是定义了一个名为myConfiguration的配置,我们并未向其中加入依赖。可以通过dependencies()方法向myConfiguration中加入实际的依赖项:

dependencies {
   myConfiguration 'org.jsoup:jsoup:1.9.2'
}

repositories {
    mavenCentral()
}

运行gradle dependencies 这个帮助task,会显示当前的依赖树。此时可以看到我们在myConfiguration这个配置中依赖的库:

myConfiguration - this is  my configuration
\--- org.jsoup:jsoup:1.9.2

由于我们只依赖了一个库,所以依赖树看着很简洁。如果依赖很多库,而这些依赖库又都有传递性依赖,就有可能发生依赖冲突。如果存在依赖冲突,在默认情况下,Gradle会选择最新版本,这和Maven是不同的,Maven会选择离依赖树最近的版本。如果你需要更改默认的冲突解决策略,可以自行搜索相关内容,本文就不多做介绍了。

使用Gradle API可以找到Gradle依赖的缓存文件放置的位置。

task printDependencies << {
    configurations.getByName('myConfiguration').each { dependency ->
        println dependency
    }
}

执行gradle printDependencies 命令,可以看到打印结果:

> Task :printDependencies
/Users/jason/.gradle/caches/modules-2/files-2.1/org.jsoup/jsoup/1.9.2/5e3bda828a80c7a21dfbe2308d1755759c2fd7b4/jsoup-1.9.2.jar

4 动态版本声明

如果想使用最新版本的依赖,可以使用占位符 latest.integration 。例如 :

org.jsoup:jsoup:latest-integration

或者,声明版本属性,通过使用一个加号(+) 标定它来动态改变:

org.jsoup:jsoup:1.+

当然了,我们最好是少用或者不用动态版本声明。

下一篇,我们开始学习Gradle中的多项目构建。

    原文作者:sososeen09
    原文地址: https://www.jianshu.com/p/e01d647b1c75
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞