Implementation vs. API: Android Gradle Plugin 3.0 Unveils a Tale of Love and Hate

2023-11-17 10:25:32

Android Gradle Plugin 3.0：implementation 和 api 之间的爱恨情仇

随着 Android Gradle Plugin 3.0 及更高版本的发展，compile 被废弃，取而代之的是 implementation 和 api。这一转变对于 Android 开发人员来说意义重大，它标志着 Android 依赖管理的一次关键变革。为了深入理解 implementation 和 api 之间的差异，让我们一起来探索它们的含义。

理解 implementation 和 api

要全面掌握 implementation 和 api 之间的差异，我们不妨考虑以下场景：

dependencies {
  implementation 'com.example.library:library:1.0.0'
  api 'com.example.library:library-api:1.0.0'
}

implementation：

implementation 用于编译时所需的依赖项，但这些依赖项不属于模块的公开 API。
这些依赖项只能在声明它们的模块内访问。
它们不会暴露给依赖于该模块的其他模块。

api：

api 用于编译时所需的依赖项，并且作为模块的公开 API 的一部分。
这些依赖项可供依赖于该模块的其他模块访问。
它们定义了其他模块可以交互的接口。

爱恨交织的关系

implementation 和 api 之间的关系可以用爱恨交织来形容。

相爱：

implementation 和 api 明确区分了编译时依赖项和公开 API 依赖项。
这种区分提高了代码库的模块化和可维护性。
它允许控制内部依赖项的暴露，避免不必要的耦合。

相恨：

implementation 和 api 的引入可能会造成混淆，特别是对于习惯于 compile 的简洁性的开发人员。
它需要转变思维方式，深入理解依赖管理的概念。
将现有项目迁移到使用 implementation 和 api 可能是一个耗时且容易出错的过程。

把握 implementation 和 api

为了有效驾驭 implementation 和 api，请考虑以下准则：

使用 implementation 用于仅在模块内部所需的依赖项。
使用 api 用于模块所需的依赖项，并且暴露给其他模块。
如果一个库同时包含 implementation 和 api 构件，请将 implementation 用于主依赖项，将 api 用于 API 依赖项。
在同一个模块中混合使用 implementation 和 api 依赖项时要小心，因为它可能导致依赖项冲突。

总结

implementation 和 api 是强大的工具，可以增强 Android 项目的模块化和可维护性。通过拥抱这些概念，可以实现对依赖管理更结构化、更可控的方法。虽然从 compile 过渡到 implementation 和 api 可能需要一些努力，但其带来的好处值得投入。

常见问题解答

什么是 compile，为什么它被废弃？
compile 是以前用于编译时依赖项的关键字，现在已被 implementation 和 api 取代。
implementation 和 api 有什么区别？
implementation 用于模块内部使用的依赖项，而 api 用于公开的依赖项，其他模块可以使用。
为什么需要区分 implementation 和 api？
区分 implementation 和 api 提高了代码的可维护性和模块化，并有助于防止不必要的耦合。
如何将现有项目迁移到使用 implementation 和 api？
首先，识别每个依赖项的用途，然后根据其用途使用 implementation 或 api。
在模块中使用 implementation 和 api 有什么注意事项？
谨慎混合使用 implementation 和 api，因为这可能导致依赖项冲突。