Gradle基础(二):依赖

笔记 专栏收录该内容
35 篇文章 0 订阅

如何理解Gradle依赖?

什么是依赖管理?

通俗来讲,依赖管理由如下两部分组成。首先,Gradle 需要知道项目构建或运行所需要的一些文件,以便于找到这些需要的文件。我们称这些输入的文件为项目的依赖。其次,你可能需要构建完成后自动上传到某个地方。我们称这些输出为发布

依赖

大部分工程都不太可能完全自给自足,一般你都会用到其他工程的文件。比如使用Retrofit库就得把它的类库加进来。这些文件就是工程的依赖

依赖解决

Gradle 需要你告诉它工程的依赖是什么,它们在哪,然后帮你加入构建中。依赖可能需要去远程库下载,比如Maven或者 Retrofit 库。也可以是本地库,甚至可能是另一个工程。我们称这个过程叫依赖解决

依赖传递

通常,依赖的自身也有依赖。例如,Hibernate 核心类库就依赖于一些其他的类库。所以,当 Gradle 构建你的工程时,会去找到这些依赖。我们称之为依赖传递

发布

大部分工程构建的主要目的是脱离工程使用。例如,生成aar包,包括源代码、文档等,然后发布出去。

这些输出的文件构成了项目的发布内容。Gradle 也会为你分担这些工作。你声明了发布到哪,Gradle 就会发布到哪。“发布”的意思就是你想做什么。比如,复制到某个目录,上传到 Maven 或 Ivy 仓库。或者在其它项目里使用,这些都可以称之为发布

有哪些依赖

依赖类型

dependencies DSL标签是标准Gradle API中的一部分,而不是Android Gradle插件的特性,所以它不属于android标签
依赖有三种方式,如下面的例子:

apply plugin: 'com.android.application'

android { ... }

dependencies {
    // Dependency on a local library module
    implementation project(":mylibrary")

    // Dependency on local binaries
    implementation fileTree(dir: 'libs', include: ['*.jar'])

    // Dependency on a remote binary
    implementation 'com.example.android:app-magic:12.3'
}

本地library模块依赖

implementation project(":mylibrary")

这种依赖方式是直接依赖本地库工程代码的(需要注意的是,mylibrary的名字必须匹配在settings.gradleinclude标签下定义的模块名字)。

本地依赖

implementation fileTree(dir: 'libs', include: ['*.jar'])

这种依赖方式是依赖工程中的 module_name/libs/目录下的jar/aar文件(注意Gradle的路径是相对于build.gradle文件来读取的,所以上面是这样的相对路径)。

如果只想依赖单个特定本地库,可以如下配置:

implementation files('libs/foo.jar', 'libs/bar.jar')

远程依赖

implementation 'com.example.android:app-magic:12.3'

上面是简写的方式,这种依赖完整的写法如下:

implementation group: 'com.example.android', name: 'app-magic', version: '12.3'

groupnameversion共同定位一个远程依赖库。需要注意的点是,version最好不要写成"12.3+"这种方式,除非有明确的预期,因为非预期的版本更新会带来构建问题。远程依赖需要在repositories标签下声明远程仓库,例如jcenter()google()maven仓库等。

依赖配置

目前Gradle版本支持的依赖配置有:implementationapicompileOnlyruntimeOnlyannotationProcessor,已经废弃的配置有:compile、provided、apk、providedCompile。此外依赖配置还可以加一些配置项,例如AndroidTestImplementationdebugApi等等。

常用的是implementationapicompileOnly三个依赖配置,含义如下:

implementation

添加依赖到编译路径,并且会将依赖打包到输出(aarapk),但是在编译时不会将依赖的实现暴露给其他module,也就是只有在运行时其他module才能访问这个依赖中的实现。使用这个配置,可以显著提升构建时间,因为它可以减少重新编译的module的数量。建议,尽量使用这个依赖配置。

api

implementation类似的是添加依赖到编译路径,并且会将依赖打包到输出(aarapk),不同点在于,api可以传递这个依赖,其他module无论在编译时和运行时都可以访问这个依赖的实现,也就是会泄漏一些不应该不使用的实现

举个例子,A依赖B,B依赖C,如果都是使用api配置的话,A可以直接使用C中的类(编译时和运行时),而如果是使用implementation配置的话,在编译时,A是无法访问C中的类的。

compileOnly

Gradle把依赖加到编译路径,编译时使用,不会打包到输出(aarapk。这可以减少输出的体积,在只在编译时需要,在运行时可选的情况,很有用。

runtimeOnly

gradle添加依赖只打包到APK,运行时使用,但不会添加到编译路径。

annotationProcessor

用于注解处理器的依赖配置

查看依赖树

可以查看单个module或者这个project的依赖,通过运行依赖的Gradle任务,如下:

View->Tools Windows -> Gradle(或者点击右侧的Gradle栏);

展开AppName -> Tasks -> android,然后双击运行AndroidDependencies。运行完,就会在Run窗口打出依赖树了。

依赖冲突解决

随着很多依赖加入到项目中,难免会出现依赖冲突,出现依赖冲突如何解决?

定位冲突

依赖冲突可能会报类似下面的错误:

Program type already present com.example.MyClass
通过查找类的方式(command + O)定位到冲突的依赖,进行排除。

如何排除依赖

dependencies中排除(细粒度)
implementation('com.taobao.android:accs-huawei:1.1.2@aar') {
        transitive = true
        exclude group: 'com.taobao.android', module: 'accs_sdk_taobao'
}
全局配置排除
configurations {
    compile.exclude module: 'cglib'
    //全局排除原有的tnet jar包与so包分离的配置,统一使用aar包中的内容
    all*.exclude group: 'com.taobao.android', module: 'tnet-jni'
    all*.exclude group: 'com.taobao.android', module: 'tnet-so'
}
禁用依赖传递
implementation('com.zhyea:ar4j:1.0') {
    transitive = false
}

configurations.all {
    transitive = false
}

此外,还可以在单个依赖项中使用@jar标识符忽略传递依赖:

implementation 'com.zhyea:ar4j:1.0@jar'

强制使用某个版本

如果某个依赖项是必需的,而又存在依赖冲突时,此时没必要逐个进行排除,可以使用force属性标识进行依赖统一。
当然这也是可以全局配置的:

compile('com.zhyea:ar4j:1.0') {
    force = true
}

configurations.all {
    resolutionStrategy {
        force 'org.hamcrest:hamcrest-core:1.3'
    }
}

在打包时排除依赖
先看一个示例:

task zip(type: Zip) {
    into('lib') {
        from(configurations.runtime) {
            exclude '*unwanted*', '*log*'
        }
    }
    into('') {
        from jar
        from 'doc'
    }
}

代码表示在打zip包的时候会过滤掉名称中包含“unwanted”和“log”的jar包。这里调用的exclude方法的参数和前面的例子不太一样,前面的参数多是map结构,这里则是一个正则表达式字符串。

也可以使用在打包时调用include方法选择只打包某些需要的依赖项:

task zip(type: Zip) {
    into('lib') {
        from(configurations.runtime) {
            include '*ar4j*', '*spring*'
        }
    }
    into('') {
        from jar
        from 'doc'
    }
}

主要是使用dependencies中排除和全局配置排除。

参考资料:
Gradle依赖管理基础
一文彻底搞清 Gradle 依赖

  • 0
    点赞
  • 0
    评论
  • 3
    收藏
  • 打赏
    打赏
  • 扫一扫,分享海报

©️2022 CSDN 皮肤主题:黑客帝国 设计师:我叫白小胖 返回首页

打赏作者

WayneSun729

你的鼓励将是我创作的最大动力

¥2 ¥4 ¥6 ¥10 ¥20
输入1-500的整数
余额支付 (余额:-- )
扫码支付
扫码支付:¥2
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、C币套餐、付费专栏及课程。

余额充值