多模块Gradle项目如何将Jib配置迁移至独立模块实现解耦

核心思路 #

利用Gradle跨项目配置API，在独立的container模块中定位到对应业务模块，在项目配置阶段直接修改目标模块的Jib扩展属性、任务参数，完全不需要改动原有业务模块的build.gradle文件，即可实现Jib配置的集中管理。

具体实现步骤 #

• 第一步：先在根项目的settings.gradle中注册所有新增的container模块，确保Gradle能识别模块依赖关系

  // settings.gradle 示例
  include(":webapp", ":app1", ":app2") // 原有业务模块
  include(":container:tomcat", ":container:app1", ":container:app2") // 新增的Jib配置模块
  

• 第二步：编写对应container模块的build.gradle配置，以:container:tomcat对应webapp模块为例

  // :container:tomcat 模块的build.gradle
  // 声明依赖目标模块的配置结果，必须加这行避免配置时序问题
  evaluationDependsOn(':webapp')
  
  // 直接修改目标webapp模块的配置
  project(':webapp') {
      // 确保目标模块应用了Jib插件后再修改配置，不存在的话也可以在这里统一应用插件
      pluginManager.withPlugin('com.google.cloud.tools.jib') {
          // 配置webapp的Jib参数
          jib {
              from {
                  image = "tomcat:9.0-jre11-temurin"
              }
              to {
                  image = "my-registry/webapp:${project.version}"
                  tags = ["latest", "${project.version}"]
              }
              container {
                  ports = ["8080"]
                  user = "tomcat"
              }
          }
          // 也可以自定义Jib任务的执行逻辑
          tasks.named('jib') {
              onlyIf { project.hasProperty('pushImage') }
          }
      }
  }
  

• 第三步：命令行应用模块的Jib Jar配置同理，以:container:app1对应app1业务模块为例

  // :container:app1 模块的build.gradle
  evaluationDependsOn(':app1')
  
  project(':app1') {
      pluginManager.withPlugin('com.google.cloud.tools.jib') {
          jibJar {
              from {
                  image = "eclipse-temurin:17-jre-alpine"
              }
              to {
                  image = "my-registry/app1:${project.version}"
              }
              container {
                  mainClass = "com.xxx.app1.Startup"
                  jvmFlags = ["-Xms256m", "-Xmx512m"]
              }
          }
      }
  }
  

• 第四步：可选公共配置抽离，在:container父模块的build.gradle中定义所有Jib配置通用的参数，避免重复编写

  // :container 模块的build.gradle
  subprojects {
      // 定义通用Jib配置闭包
      ext.jibCommonConfig = {
          to {
              auth {
                  username = System.getenv('REGISTRY_USER')
                  password = System.getenv('REGISTRY_PWD')
              }
          }
      }
  }
  

  子container模块直接调用即可：jib.with jibCommonConfig或者jibJar.with jibCommonConfig

注意事项 #

• evaluationDependsOn为必填配置，确保目标业务模块先完成配置流程，再修改其Jib参数，避免出现找不到Jib扩展的异常
• 如果原有业务模块没有引入Jib插件，可以在project(':xxx')块中添加apply plugin: 'com.google.cloud.tools.jib'，完全不需要修改业务模块的配置文件
• 若使用Kotlin DSL，仅需将闭包写法替换为Kotlin lambda即可，API逻辑完全一致

内容的提问来源于stack exchange，提问作者Santi