Gradle配置implementation、api与compile的区别

时间:2021-10-28 16:51:45

自Gradle 3.4开始,compile被废弃,取而代之的是implementation和api两个配置项。

掌握这三者的区别实际上就是要清楚什么情况使用implementation替换compile,什么情况下使用api替换compile。

implementation替换compile

使用implementation配置依赖,对Gradle来说:

  • 编译时:不允许外部模块调用此依赖包,除非外部模块自己声明此依赖
  • 运行时:此依赖包只允许在运行时使用反射机制调用。

也就是说模块使用implementation屏蔽了外部模块直接调用它声明的依赖。

这样做有几个好处:(翻译自Gradle 文档

  • 依赖关系不会泄漏到消费者的编译类路径中,所以永远不会意外地依赖于传递依赖项
  • 由于减少的类路径大小编译更快
  • 当实现依赖关系发生变化时,重新编译会更少:消费者不需要重新编译
  • cleaner发布:当与新的maven-publish插件结合使用时,Java库会生成POM文件,这些文件可以精确地区分编译库所需的内容和运行时使用库所需的内容(换句话说,不要混合编译library本身所需的东西,以及编译library所需的东西)。

api替换compile

编译时与implementation相反,它允许外部模块不管在编译时还是运行时都可以调用api声明的依赖。和原来的compile很类似。

使用api声明依赖,如果依赖发生变化,所有访问到此依赖的模块都需要重新编译。因此它会增加模块的编译时间。

总结

大部分情况下都应该使用implementation替换compile,只有在一些库模块才考虑使用api替换compile。