OkHttp之okhttp-bom模块的分析

一、okhttp - bom 作用

okhttp - bom（Bill of Materials，物料清单）主要用于管理 OkHttp 及其相关依赖库的版本，它在多模块项目或者依赖众多的项目里能发挥重要作用，具体作用如下：

1. 统一版本管理 ：在一个大型项目中，可能会依赖 OkHttp 及其多个子模块，如 okhttp、okhttp - logging - interceptor 等。okhttp - bom 能确保所有 OkHttp 相关依赖使用相同的版本，避免因版本不一致引发的兼容性问题。
2. 简化依赖声明 ：开发者无需在每个依赖项中指定版本号，只需引入 okhttp - bom 并指定版本，项目里所有 OkHttp 相关依赖就会自动使用该版本，减少了版本号重复声明的工作量。
3. 提高可维护性 ：当需要升级 OkHttp 版本时，只需更新 okhttp - bom 的版本，所有依赖项会自动更新到对应版本，降低了手动更新每个依赖版本时出错的风险。

实现方式

Maven 项目

在 Maven 项目中，okhttp - bom 以 <dependencyManagement> 标签的形式引入。示例如下：

xml
Apply
<project>
    <!-- ... 已有代码 ... -->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>com.squareup.okhttp3</groupId>
                <artifactId>okhttp-bom</artifactId>
                <version>4.11.0</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <dependencies>
        <dependency>
            <groupId>com.squareup.okhttp3</groupId>
            <artifactId>okhttp</artifactId>
        </dependency>
        <dependency>
            <groupId>com.squareup.okhttp3</groupId>
            <artifactId>logging-interceptor</artifactId>
        </dependency>
    </dependencies>
    <!-- ... 已有代码 ... -->
</project>

在上述代码中，<dependencyManagement> 里引入了 okhttp - bom 并指定版本。在 <dependencies> 中声明 OkHttp 相关依赖时，无需指定版本号，Maven 会自动从 okhttp - bom 中获取对应版本。

Gradle 项目

在 Gradle 项目中，okhttp - bom 借助 platform 关键字引入。示例如下：

build.gradle
Apply
plugins {
    id 'java'
}

repositories {
    mavenCentral()
}

dependencies {
    implementation platform('com.squareup.okhttp3:okhttp-bom:4.11.0')
    implementation 'com.squareup.okhttp3:okhttp'
    implementation 'com.squareup.okhttp3:logging-interceptor'
}

plugins {
    java
}

repositories {
    mavenCentral()
}

dependencies {
    implementation(platform("com.squareup.okhttp3:okhttp-bom:4.11.0"))
    implementation("com.squareup.okhttp3:okhttp")
    implementation("com.squareup.okhttp3:logging-interceptor")
}

在 Gradle 配置里，使用 platform 引入 okhttp - bom 并指定版本，后续声明 OkHttp 相关依赖时也无需指定版本号，Gradle 会从 okhttp - bom 中获取对应版本。

二、如何做到的？

1. okhttp - bom 构建文件实现

当前编辑的 build.gradle.kts 文件定义了 okhttp - bom 模块的构建逻辑，代码如下：

plugins {
  id("com.vanniktech.maven.publish.base")
  id("java-platform")
}

dependencies {
  constraints {
    project.rootProject.subprojects.forEach { subproject ->
      if (subproject.name != "okhttp-bom") {
        api(subproject)
      }
    }
  }
}

publishing {
  publications.create<MavenPublication>("maven") {
    from(project.components["javaPlatform"])
  }
}

下面逐步解释代码的关键部分。

应用插件

plugins {
  id("com.vanniktech.maven.publish.base")
  id("java-platform")
}

• com.vanniktech.maven.publish.base：该插件简化了项目发布到 Maven 仓库的流程，确保 okhttp - bom 模块能正确发布。
• java-platform：这是 Gradle 内置插件，用于定义 Java 平台模块。Java 平台模块能集中管理依赖版本，让其他项目可以引用这个平台模块来统一依赖版本。

定义依赖约束

dependencies {
  constraints {
    project.rootProject.subprojects.forEach { subproject ->
      if (subproject.name != "okhttp-bom") {
        api(subproject)
      }
    }
  }
}

• constraints 块：用于定义依赖约束。依赖约束不会直接引入依赖，而是告诉 Gradle 在解析依赖时，应该使用指定的版本。
• project.rootProject.subprojects.forEach：遍历根项目的所有子项目，将除 okhttp - bom 自身外的所有子项目添加到依赖约束中。api 表示这些子项目的依赖信息会暴露给依赖 okhttp - bom 的项目。

配置发布信息

publishing {
  publications.create<MavenPublication>("maven") {
    from(project.components["javaPlatform"])
  }
}

• publishing 块：配置项目的发布信息。
• MavenPublication：将项目发布为 Maven 格式的构件。
• from(project.components["javaPlatform"])：从 javaPlatform 组件中获取发布所需的信息，确保发布的是一个 Java 平台模块。

2. 其他项目如何使用 okhttp - bom

在其他项目中，可以通过 platform 关键字引入 okhttp - bom，示例如下：

plugins {
    java
}

repositories {
    mavenCentral()
}

dependencies {
    implementation(platform("com.squareup.okhttp3:okhttp-bom:4.11.0"))
    implementation("com.squareup.okhttp3:okhttp")
    implementation("com.squareup.okhttp3:logging-interceptor")
}

• implementation(platform("com.squareup.okhttp3:okhttp-bom:4.11.0"))：引入 okhttp - bom 平台模块，并指定版本号。
• implementation("com.squareup.okhttp3:okhttp") 和 implementation("com.squareup.okhttp3:logging-interceptor")：声明 OkHttp 相关依赖，无需指定版本号，Gradle 会从 okhttp - bom 中获取对应版本。

3. 总结

okhttp - bom 通过以下方式实现其功能：

• 使用 java-platform 插件定义 Java 平台模块，集中管理依赖版本。
• 通过 constraints 块定义依赖约束，确保所有 OkHttp 相关子项目使用统一版本。
• 将项目发布为 Maven 构件，供其他项目引用。
• 其他项目引入 okhttp - bom 平台模块后，声明 OkHttp 相关依赖时无需指定版本号，从而简化依赖声明，提高可维护性。