【Gradle】maven-publish插件的使用

一、maven-publish介紹

　　在 Gradle 1.3 中，引入了一種新的發布機制。這種新機制引入了一些新概念和功能，這些功能使 Gradle 發布變得更加強大，現在已成為發布工件的首選選項。

二、maven-publish使用

1、在 build.gradle 聲明插件

plugins {
    id 'maven-publish'
}

2、使用publishing{}塊進行配置

group = 'org.example'
version = '1.0'

publishing {
    publications {
        myLibrary(MavenPublication) {
            from components.java
        }
    }

    repositories {
        mavenLocal()
    }
}

　　上面我們定義了一個名為myLibrary的publication，from components.java這句表明是一個java庫，也就是最終會以jar包的形式發布。還定義了一個本地maven倉庫，表明myLibrary的jar包最終會被發布到本地maven倉庫。components定義了發布的組件，支持三個值：components.java(由JavaPlugin添加)、components.web(由WarPlugin添加)、components.javaPlatform(由JavaPlatformPlugin添加)。如果我們需要將一個web項目打包成war包發布，則使用components.web。我們當前的例子為jar，則使用components.java。

　　Gradle使用與Maven相同的邏輯來標識本地Maven緩存的位置。如果在settings.xml中定義了本地Maven倉庫位置，那么Gradle將使用這個位置。USER_HOME/.m2下的settings.xml將會覆蓋M2_HOME/conf中的settings.xml。如果沒有可獲取的settings.xml，Gradle將默認使用USER_HOME/.m2/repository作為本地Maven倉庫位置。

3、maven-publish提供的tasks

　　maven-publish提供了如下tasks:

任務	描述
generatePomFileForPubNamePublication	創建需要發布的名為PubName的POM文件，填充已知的元數據，如項目名稱、項目版本和依賴項。POM文件的默認位置是build/publications/$pubName/pom-default.xml.
publishPubNamePublicationToRepoNameRepository	將PubName發布到名為RepoName的存儲庫。如果你有一個沒有顯式名稱的存儲庫定義，RepoName將是“Maven”。
publishPubNamePublicationToMavenLocal	將PubName發布復制到本地Maven緩存-通常是$USER_HOME/.m2/repository-以及發布的POM文件和其他元數據。
publish	將所有定義的publication發布到所有定義的存儲庫的聚合任務。它不包括將publication復制到本地Maven庫。
publishToMavenLocal	將所有定義的publication復制到本地 Maven 庫中，包括它們的元數據 (POM 文件等)

　　

4、執行任務

• 命令：gradle tasks

　　可以查看所有任務

　　

• 命令：gradle publishToMavenLocal

　　執行publishToMavenLocal任務，或者在idea的gradle窗口點擊任務名也可以

　　查看本地maven倉庫，即可發找到發布的jar包

三、發布class.jar和sources.jar及javadoc.jar 三種jar包

　　新建打包sourcesJar任務 和 打包javadocJar任務，然后進行發布，

　　新增的 sourcesJar任務 和 javadocJar任務 可以在idea的gradle窗口中other任務列表中看到

　　完整代碼如下：

// 聲明插件
plugins {
    id 'maven-publish'
}


// 項目group/artifact/version信息
group 'com.test.gradle'
// name 默認項目名
version '1.0-SNAPSHOT'


// 打包sourcesJar任務
task sourcesJar(type: Jar, dependsOn: classes) {
    classifier = 'sources'
    from sourceSets.main.allSource
}

// 打包javadocJar任務
task javadocJar(type: Jar, dependsOn: javadoc) {
    classifier = 'javadoc'
    from javadoc.destinationDir
}

// 解決javadoc打包亂碼
javadoc {
    options {
        encoding "UTF-8"
        charSet 'UTF-8'
        author true
        version true
        title "文檔大標題"
    }
}


publishing {
    // 發布
    publications {
        mavenJava(MavenPublication) {
            //指定group/artifact/version信息
            groupId project.group
            artifactId project.name
            version project.version
            // components.java jar包
            // components.web war包
            from components.java

            // 增加 sourcesJar、javadocJar 任務
            artifact sourcesJar
            artifact javadocJar
        }
    }
    // 發布倉庫
    repositories {
   
           // 本地倉庫位於USER_HOME/.m2/repository
           // 
        mavenLocal()
        // 其他maven倉庫
        maven { url uri('/Users/h__d/Desktop/1') }
        // aliyun鏡像倉庫
//         maven {
//             // 憑證
//             credentials {
//                 username 'username' // 倉庫發布用戶名
//                 password 'password' // 倉庫發布用戶密碼
//             }
//             // 地址
//             url 'https://maven.aliyun.com/nexus/content/groups/public/'
//         }
    }
}

　　發布到配置倉庫命令：gradle publish

　　發布到本地倉庫命令：gradle publishToMavenLocal

　　進行發布

　　

 

參考：

　　1、https://blog.csdn.net/u013632755/article/details/100111453

　　2、https://blog.csdn.net/dnc8371/article/details/106812825

　　3、https://blog.csdn.net/u011578734/article/details/114104495