Gradle子模块依赖为什么需要区分api和implementation

老辰大大_5984

老辰大大_5984

2026-10-26

487人浏览

原创

子模块编译失败大概率是api/implementation用反了:implementation依赖不传递,仅当前模块可见;若类型出现在public api(如方法参数、返回值、继承类)中,必须用api,否则下游模块编译期找不到该类。

gradle子模块依赖为什么需要区分api和implementation

子模块编译失败却找不到原因,大概率是api/implementation用反了

Gradle 多模块项目里,一个子模块(比如 common-utils)被其他模块(比如 app 或 feature-login)依赖时,如果 app 编译报错说“找不到 com.google.gson.Gson”,但你在 common-utils 的 build.gradle 里明明写了 implementation 'com.google.code.gson:gson:2.10.1'——这说明问题不在没加依赖,而在于依赖没“透出去”。

根本原因就一条:
implementation 声明的依赖只对当前模块可见;它不会出现在该模块生成的编译类路径(compile classpath)中,也不会写进发布后的 pom.xml 或 module.json。下游模块在编译期完全“看不见”它。

什么时候必须用api而不是implementation

不是看“这个库重不重要”,而是看“它的类型是否出现在你模块的 public API 里”。

  • common-utils 提供了一个公共方法:public static User parseJson(String json, Class<user> cls)</user>,内部用了 Gson
    → cls 是调用方传入的,User 类型来自外部,但 Gson 的类型(如 TypeToken、JsonDeserializer)如果出现在方法签名或 public 类的字段/继承关系中,就必须用 api

  • network-core 暴露了 ApiResponse<t></t>,而这个泛型类继承自 Retrofit.Response<t></t>
    → Retrofit.Response 是 public API 的一部分,必须用 api 'com.squareup.retrofit2:retrofit:2.9.0'

  • 你写了 public interface DataRepository extends RoomDatabase
    → RoomDatabase 来自 androidx.room:room-runtime,只要它出现在接口定义里,就得用 api,否则下游模块连编译都过不去

implementation误标为api的真实代价

这不是“写错一行配置”的小问题,而是会扩散成构建链路上的雪崩:

  • app 模块每次编译都要重新解析所有 api 依赖的 transitive 依赖树,哪怕只改了一行日志
  • 本地修改 utils 模块里的私有工具方法,feature-cart 和 feature-profile 也会被强制重新编译(因为它们依赖了 utils 的 api 依赖)
  • 发布到 Maven 仓库后,下游项目 pom.xml 里会多出一堆本不该出现的 <scope>compile</scope> 依赖,比如把 postgresql 驱动塞进一个纯前端 SDK 的依赖列表
  • 更隐蔽的是 IDE 行为:Android Studio 可能缓存了错误的 classpath,导致“明明改了 api 却还报找不到类”,clean + rebuild 也不管用,必须 invalidate caches

怎么快速检查自己有没有用错

最直接的办法是看模块产出物:

  • 运行 ./gradlew :common-utils:generateMetadata(Java Library 插件)或 ./gradlew :common-utils:publishToMavenLocal
  • 打开 ~/.m2/repository/xxx/common-utils/1.0/common-utils-1.0.pom
  • 搜索你关心的依赖,比如 gson:
    • 如果是 <scope>compile</scope> → 它被声明为 api
    • 如果是 <scope>runtime</scope> 或压根没出现 → 它是 implementation(或被优化掉了)

另一个验证方式是临时在下游模块写一行代码:

import com.google.gson.Gson; // 如果这行不报红,说明 Gson 已被传递 → 你用了 api

真正容易被忽略的点是:API 边界不是由你“想不想暴露”决定的,而是由你写的 public 方法签名、继承关系、注解处理器输入等客观语法结构决定的。哪怕你主观上认为“这只是个内部工具”,只要它的类型泄漏到了 public 接口里,Gradle 就必须把它当作 API 依赖处理。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

11217

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

8342

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

7192

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1204

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

968

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1436

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2949

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20211

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1295

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Gradle 9 主版本升级指南
Gradle 9 主版本升级指南

共0课时 | 0人学习

Gradle 安全最佳实践
Gradle 安全最佳实践

共0课时 | 0人学习

Gradle 依赖校验手册
Gradle 依赖校验手册

共0课时 | 0人学习