前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >一文彻底搞清Gradle依赖

一文彻底搞清Gradle依赖

作者头像
用户1269200
发布2018-12-18 15:58:19
4.9K0
发布2018-12-18 15:58:19
举报
文章被收录于专栏:刘望舒

作者:曾是放牛娃 https://www.jianshu.com/p/59fd653a54d2

之前对Android Gradle构建的依赖一直傻傻分不清,这段时间正好接入集团的一个二方库,踩了很多坑,也顺带把Gradle依赖这块搞清楚了,主要整理了下Gradle依赖的类型、依赖配置、如何查看依赖、依赖冲突如何解决。

依赖类型

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

代码语言:javascript
复制
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模块依赖

代码语言:javascript
复制
implementation project(":mylibrary")

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

本地二进制依赖

代码语言:javascript
复制
implementation fileTree(dir: 'libs', include: ['*.jar'])

这种依赖方式是依赖工程中的 module_name/libs/目录下的Jar文件(注意Gradle的路径是相对于build.gradle文件来读取的,所以上面是这样的相对路径)。 如果只想依赖单个特定本地二进制库,可以如下配置:

代码语言:javascript
复制
implementation files('libs/foo.jar', 'libs/bar.jar')

远程二进制依赖

代码语言:javascript
复制
implementation 'com.example.android:app-magic:12.3'

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

代码语言:javascript
复制
implementation group: 'com.example.android', name: 'app-magic', version: '12.3'

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

依赖配置

目前Gradle版本支持的依赖配置有:implementation、api、compileOnly、runtimeOnly和annotationProcessor,已经废弃的配置有:compile、provided、apk、providedCompile。此外依赖配置还可以加一些配置项,例如AndroidTestImplementation、debugApi等等。

常用的是implementation、api、compileOnly三个依赖配置,含义如下:

implementation 与compile对应,会添加依赖到编译路径,并且会将依赖打包到输出(aar或apk),但是在编译时不会将依赖的实现暴露给其他module,也就是只有在运行时其他module才能访问这个依赖中的实现。使用这个配置,可以显著提升构建时间,因为它可以减少重新编译的module的数量。建议,尽量使用这个依赖配置。 api 与compile对应,功能完全一样,会添加依赖到编译路径,并且会将依赖打包到输出(aar或apk),与implementation不同,这个依赖可以传递,其他module无论在编译时和运行时都可以访问这个依赖的实现,也就是会泄漏一些不应该不使用的实现。举个例子,A依赖B,B依赖C,如果都是使用api配置的话,A可以直接使用C中的类(编译时和运行时),而如果是使用implementation配置的话,在编译时,A是无法访问C中的类的。 compileOnly 与provided对应,Gradle把依赖加到编译路径,编译时使用,不会打包到输出(aar或apk)。这可以减少输出的体积,在只在编译时需要,在运行时可选的情况,很有用。 runtimeOnly 与apk对应,gradle添加依赖只打包到APK,运行时使用,但不会添加到编译路径。这个没有使用过。 annotationProcessor 与compile对应,用于注解处理器的依赖配置,这个没用过。

查看依赖树

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

  1. View -> Tools Windows -> Gradle(或者点击右侧的Gradle栏);
  2. 展开 AppName -> Tasks -> android,然后双击运行AndroidDependencies。运行完,就会在Run窗口打出依赖树了。
依赖冲突解决

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

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

代码语言:javascript
复制
Program type already present com.example.MyClass

通过查找类的方式(command + O)定位到冲突的依赖,进行排除。

如何排除依赖

1.dependencies中排除(细粒度)

代码语言:javascript
复制
compile('com.taobao.android:accs-huawei:1.1.2@aar') {
        transitive = true
        exclude group: 'com.taobao.android', module: 'accs_sdk_taobao'
}

2.全局配置排除

代码语言:javascript
复制
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'
}

3.禁用依赖传递

代码语言:javascript
复制
compile('com.zhyea:ar4j:1.0') {
    transitive = false
}

configurations.all {
    transitive = false
}

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

代码语言:javascript
复制
compile 'com.zhyea:ar4j:1.0@jar'

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

代码语言:javascript
复制
compile('com.zhyea:ar4j:1.0') {
    force = true
}

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

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

代码语言:javascript
复制
task zip(type: Zip) {
    into('lib') {
        from(configurations.runtime) {
            exclude '*unwanted*', '*log*'
        }
    }
    into('') {
        from jar
        from 'doc'
    }
}

代码表示在打zip包的时候会过滤掉名称中包含“unwanted”和“log”的jar包。这里调用的exclude方法的参数和前面的例子不太一样,前面的参数多是map结构,这里则是一个正则表达式字符串。 也可以使用在打包时调用include方法选择只打包某些需要的依赖项:

代码语言:javascript
复制
task zip(type: Zip) {
    into('lib') {
        from(configurations.runtime) {
            include '*ar4j*', '*spring*'
        }
    }
    into('') {
        from jar
        from 'doc'
    }
}

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

— — — END — — —

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2018-11-23,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 刘望舒 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 依赖类型
  • 依赖配置
  • 查看依赖树
  • 依赖冲突解决
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档