使用gradle-maven-publish-plugin发布到自定义Maven仓库指南

使用gradle-maven-publish-plugin发布到自定义Maven仓库指南

插件概述

gradle-maven-publish-plugin是一个功能强大的Gradle插件，它简化了将项目发布到Maven仓库的过程。无论是发布到内部私有仓库还是第三方托管仓库，该插件都能提供便捷的配置方式。本文将详细介绍如何配置插件以发布到任意Maven仓库。

插件应用

要在Gradle项目中使用该插件，首先需要在构建脚本中添加插件依赖：

plugins {
  id "com.vanniktech.maven.publish" version "<最新版本>"
}

或者使用Kotlin DSL：

plugins {
  id("com.vanniktech.maven.publish") version "<最新版本>"
}

发布内容配置

插件能够自动检测项目中应用的其他插件（如Android Gradle插件或Kotlin Gradle插件），并据此自动配置发布内容。默认情况下，插件会：

1. 发布主构件（如JAR或AAR文件）
2. 自动生成并发布源码包（sources jar）
3. 自动生成并发布文档包（javadoc jar），优先使用Dokka（如果已应用）

如果需要自定义发布内容，可以使用configure方法：

mavenPublishing {
  configure(...)
}

仓库配置

配置自定义Maven仓库非常简单，以下是几种常见场景的配置示例：

基础配置

publishing {
    repositories {
        maven {
            name = "myRepo"
            url = layout.buildDirectory.dir('repo')  // 发布到本地目录
            // 或者发布到远程仓库
            url = "http://my.org/repo"
        }
    }
}

区分快照和正式版本

publishing {
    repositories {
        maven {
            name = "myRepo"
            url = uri(if (version.toString().endsWith("SNAPSHOT")) 
                "http://my.org/repos/snapshots" 
                else "http://my.org/repos/releases")
        }
    }
}

认证配置示例

对于需要认证的仓库，可以这样配置：

publishing {
    repositories {
        maven {
            name = "secureRepo"
            url = "https://secure.repo.example.com"
            credentials {
                username = project.findProperty("repoUser") ?: ""
                password = project.findProperty("repoPassword") ?: ""
            }
        }
    }
}

POM文件配置

POM文件是Maven仓库中存储项目元数据的重要文件。插件提供了灵活的POM配置方式：

基础坐标配置

mavenPublishing {
  coordinates("com.example.mylibrary", "library-name", "1.0.3-SNAPSHOT")
}

完整POM配置示例

mavenPublishing {
  coordinates("com.example.mylibrary", "library-name", "1.0.3-SNAPSHOT")

  pom {
    name.set("My Library")
    description.set("库功能描述")
    inceptionYear.set("2020")
    url.set("https://example.com/mylibrary/")
    
    licenses {
      license {
        name.set("The Apache License, Version 2.0")
        url.set("http://www.apache.org/licenses/LICENSE-2.0.txt")
      }
    }
    
    developers {
      developer {
        id.set("devId")
        name.set("开发者姓名")
      }
    }
    
    scm {
      url.set("https://example.com/mylibrary/")
      connection.set("scm:git:git://example.com/mylibrary.git")
    }
  }
}

使用gradle.properties配置

也可以在gradle.properties文件中定义POM属性：

GROUP=com.test.mylibrary
POM_ARTIFACT_ID=mylibrary-runtime
VERSION_NAME=3.0.5

POM_NAME=My Library
POM_DESCRIPTION=库描述信息
POM_INCEPTION_YEAR=2020

执行发布

配置完成后，执行发布任务：

./gradlew publishAllPublicationsToMyRepoRepository

其中MyRepo需要替换为你在仓库配置中设置的name属性值。

最佳实践建议

1. 版本管理：遵循语义化版本控制规范，使用-SNAPSHOT后缀标识开发中的版本
2. 安全存储凭证：避免在构建脚本中硬编码凭证，使用Gradle属性或环境变量
3. 多模块项目：对于多模块项目，可以在根项目中统一配置POM信息
4. 持续集成：将发布任务集成到CI/CD流程中，实现自动化发布

通过合理配置gradle-maven-publish-plugin，开发者可以轻松实现项目构件向各类Maven仓库的发布，无论是内部私有仓库还是公共托管服务。