Android Module上传到Maven仓库及实现同时上传到多个Maven仓库，新版 Gradle7.0 / 老版 Gradle6.5 Maven仓库上传配置

今天药忘吃喽~ 2023-10-09 14:04 21阅读 0赞

今天做了一个将`Module`上传到`Maven`仓库的功能，在此记录一下，给有需要的童鞋参考。

需要注意的是，`Gradle7.0`及以上，`maven`插件已无法使用，需要使用`maven-publish`插件。

*  如果使用的是`Gradle7.0`及以上，直接看本文中的 3.Gradle 7.0 上传到Maven仓库 部分
 *  如果使用的是`Gradle7.0`以下版本，看本文中的 1. 上传到单个Maven仓库 和 2. 上传到多个Maven仓库 部分

## 1. 上传到单个`Maven`仓库 ##

### 1.1 新建`maven_upload.gradle` ###

在项目根目录下，新建 `maven_upload.gradle`

apply plugin: 'maven'
    
    def REPOSITORY_URL = "http://xxxx.yyyy.你的maven服务器的地址/" //TODO <--- 请修改
    def NEXUS_USERNAME = "maven服务器账号" //TODO <--- 请修改
    def NEXUS_PASSWORD = "maven服务器密码" //TODO <--- 请修改
    logger.info("groupId = %s\t\nartifactId = %s\t\nversion = %s\t\nrepository = %s\t\n", GROUP, POM_ARTIFACT_ID, VERSION_NAME, REPOSITORY_URL)
    afterEvaluate {
         project ->
        uploadArchives {
        
            repositories.mavenDeployer {
        
                pom.groupId = GROUP
                pom.artifactId = POM_ARTIFACT_ID
                pom.version = VERSION_NAME
                repository(url: REPOSITORY_URL) {
        
                    authentication(userName: NEXUS_USERNAME, password: NEXUS_PASSWORD)
                }
            }
        }
        // 用于打包源代码的任务
        task androidSourcesJar(type: Jar) {
        
            classifier = 'sources'
            //from android.sourceSets.main.java.sourceFiles //仅Java源码
            from android.sourceSets.main.java.srcDirs //包括Java和Kotlin源码
        }
        artifacts {
        
            archives androidSourcesJar //打包源码，去除这行打的包将看不到源码
        }
    }

注意这里的几个关键变量

*  REPOSITORY\_URL : Maven服务器地址
 *  NEXUS\_USERNAME : Maven服务器的账号
 *  NEXUS\_PASSWORD : Maven服务器的密码

### 1.2 在想要上传的`Library`中添加 ###

在想要上传的Library中添加如下代码，将GROUP、POM\_ARTIFACT\_ID修改为我们自定义的内容

ext.GROUP="com.heiko.android"
    ext.POM_ARTIFACT_ID="mytest"
    ext.VERSION_NAME=android.defaultConfig.versionName
    //引用gradle_upload.gradle
    apply from: "${
          project.rootDir}/maven_upload.gradle"

GROUP 、 POM\_ARTIFACT\_ID 、 VERSION\_NAME 这三者 共同组成我们所需的一个依赖，比如 `implementation 'com.heiko.mytest:1.0.0'`

### 1.3 进行使用 ###

添加上面的代码之后，我们点击`sync`，同步下代码  
可以发现多了一个`uploadArchives`的Gradle Task  
![在这里插入图片描述][005ecfea76124001b09061fd429295e8.png]  
我们双击运行，一段时间后，出现如下成功的提示，说明就上传到maven仓库成功了  
![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBASGVpa28tQW5kcm9pZA_size_20_color_FFFFFF_t_70_g_se_x_16]

#### 1.3.1 依赖上传的`Maven`库 ####

上传成功后，我们要如何进行依赖使用呢 ?

###### 3.1 添加`Maven`仓库地址 ######

在一个新建的项目了，我们需要先添加maven仓库的地址

allprojects {
        
        repositories {
        
            //....此处省略了其他的maven库....
            maven {
        
                url "http://xxxx.yyyy.你的maven服务器的地址/" //TODO <--- 请修改
                credentials {
        
                    username 'maven服务器的账号' //TODO <--- 请修改
                    password 'maven服务器的密码' //TODO <--- 请修改
                }
            }
        }
    }

#### 1.3.2 进行依赖 ####

dependencies {
        
        //...
        implementation 'com.heiko.android:mytest:1.0.0'
    }

#### 1.3.3 验证是否可以用 ####

标准一 : 可引用module中的类、函数

标准二 : 可正常编译项目并正常跑在Android设备上

## 2. 上传到多个`Maven`仓库 ##

有时候我们需要将library上传到多个Maven仓库，这种情况下uploadArchives任务就不能满足需求了，可以通过如下自定义task的方式解决。

### 2.1 修改`maven_upload.gradle` ###

apply plugin: 'maven'
    
    def RELEASE_REPOSITORY_URL = "http://xxxx.yyyy.你的生产maven服务器的地址/" //TODO <--- 请修改
    def SNAPSHOT_REPOSITORY_URL = "http://xxxx.yyyy.你的快照maven服务器的地址/" //TODO <--- 请修改
    def NEXUS_USERNAME = "maven服务器账号" //TODO <--- 请修改
    def NEXUS_PASSWORD = "maven服务器密码" //TODO <--- 请修改
    
    //上传到快照Maven
    task uploadArchivesSpapshot(type: Upload, group: "upload") {
        
        configuration = configurations.archives
        repositories {
        
            mavenDeployer {
        
                pom.groupId = GROUP
                pom.artifactId = POM_ARTIFACT_ID
                pom.version = VERSION_NAME + "-SNAPSHOT"
                repository(url: SNAPSHOT_REPOSITORY_URL) {
        
                    authentication(userName: NEXUS_USERNAME, password: NEXUS_PASSWORD)
                }
            }
        }
    }
    
    //上传到生产Maven
    task uploadArchivesRelease(type: Upload, group: "upload") {
        
        configuration = configurations.archives
        repositories {
        
            mavenDeployer {
        
                pom.groupId = GROUP
                pom.artifactId = POM_ARTIFACT_ID
                pom.version = VERSION_NAME
                repository(url: RELEASE_REPOSITORY_URL) {
        
                    authentication(userName: NEXUS_USERNAME, password: NEXUS_PASSWORD)
                }
            }
        }
    }
    
    //上传到快照Maven和生产Maven
    task uploadArchivesAll(group: "upload") {
        
        dependsOn(uploadArchivesSpapshot, uploadArchivesRelease)
    }

### 2.2 在想要上传的Library中添加 ###

GROUP 、 POM\_ARTIFACT\_ID 、 VERSION\_NAME 这三者 共同组成我们所需的一个依赖，比如 `implementation 'com.heiko.mytest:1.0.0'`

### 2.3 进行使用 ###

添加上面的代码之后，我们点击`sync`，同步下代码  
可以发现多了3个Gradle Task，分别是`uploadArchivesAll`，`uploadArchivesRelease`，`uploadArchivesSpapshot`  
![在这里插入图片描述][5126bf457ada441a9c67448b1b99220a.png]  
我们点击`uploadArchivesAll`，执行成功后，可以发现快照仓库和生产仓库上都有对应版本的依赖了。

## 3.Gradle 7.0 上传到`Maven`仓库 ##

`maven`插件在Gradle7.0上已无法使用，需要修改为`maven-publish`插件。

#### 3.1 新建`maven_upload.gradle` ####

我们新建或修改`maven_upload.gradle`文件

apply plugin: 'maven-publish'
    
    def RELEASE_REPOSITORY_URL = "https://你的maven仓库地址"
    def SNAPSHOT_REPOSITORY_URL = "https://你的快照maven仓库地址"
    def NEXUS_USERNAME = "你的maven仓库用户名"
    def NEXUS_PASSWORD = "你的maven仓库密码"
    
    afterEvaluate {
        
        publishing {
        
            repositories {
        
                maven {
        
                    //allowInsecureProtocol(true)
                    name("ReleaseMaven")
                    url = RELEASE_REPOSITORY_URL
                    credentials {
        
                        username = NEXUS_USERNAME
                        password = NEXUS_PASSWORD
                    }
                }
                maven {
        
                    name("SnapshotMaven")
                    url = SNAPSHOT_REPOSITORY_URL
                    credentials {
        
                        username = NEXUS_USERNAME
                        password = NEXUS_PASSWORD
                    }
                }
            }
            publications {
        
                Production(MavenPublication) {
        
                    from components.release
                    artifact androidSourcesJar //打包源码，去除这行打的包将看不到源码
                    groupId = GROUP
                    artifactId = POM_ARTIFACT_ID
                    version = VERSION_NAME
                }
                Develop(MavenPublication) {
        
                    from components.debug
                    artifact androidSourcesJar //打包源码，去除这行打的包将看不到源码
                    groupId = GROUP
                    artifactId = POM_ARTIFACT_ID
                    version = "${
          VERSION_NAME}-SNAPSHOT"
                }
            }
        }
    }
    
    // 用于打包源代码的任务
    task androidSourcesJar(type: Jar) {
        
        archiveClassifier.set('sources')
        from android.sourceSets.main.java.srcDirs
    }

#### 3.2 在想要上传的`Library`中添加 ####

在想要上传的Library中添加如下代码，将GROUP、POM\_ARTIFACT\_ID修改为我们自定义的内容

GROUP 、 POM\_ARTIFACT\_ID 、 VERSION\_NAME 这三者 共同组成我们所需的一个依赖，比如 `implementation 'com.heiko.mytest:1.0.0'`

#### 3.3 重新`Sync`一下 ####

重新`Sync`一下，可以看到，Grandle多了几个Task  
![在这里插入图片描述][a9f0e565b65c455494caaaa573b1664f.png]

`publishDevelopPublicationToSnapshotMavenRepository`表示上传开发包到快照仓库  
`publishProductionPublicationToReleaseMavenRepository`表示上传生产包到正式仓库

> `repositories`中的`name`用来指定`Maven`仓库的名称，以区分不同的`Maven`仓库。  
> `publications`中的`Production`和`Develop`名字是自定义的，可以自己想个名字。

## 4. 注意事项 ##

### 4.1 Module中不能直接依赖其他的aar ###

Module中不能直接依赖其他的aar，如果有直接依赖其他的aar，会报`Missing required attribute : dependency groupId`的错误  
![请添加图片描述][c2fcb234733943218ed547b120c37673.png]  
所以，如果有直接依赖其他的aar，需要先将这些aar手动上传到maven仓库上，详见我的另一篇博客 [手动上传aar到nexus maven仓库][aar_nexus maven]

### 4.2 Module中不能直接依赖其他的Module ###

Module不能存在嵌套关系，如果有存在嵌套关系，也会报上面的那个`Missing required attribute : dependency groupId`的错误

## 5. 相关文章 ##

我的其他和Maven相关的文章

关于自动化打包Maven仓库的配置  
[Android Maven仓库搭建 - 实现自动化打包自动拉取最新maven依赖][Android Maven_ - _maven]

其他  
[Linux (Ubuntu) Android环境及Maven(Nexus3.X)配置][Linux _Ubuntu_ Android_Maven_Nexus3.X]  
[手动上传aar到nexus maven仓库][aar_nexus maven]  
[将Flutter项目打包aar上传maven][Flutter_aar_maven]

> 参考  
> [Gradle上传多个仓库][Gradle]  
> [publishing\_maven][publishing_maven]  
> [Gradle插件之maven-publish：发布android library到maven仓库][Gradle_maven-publish_android library_maven]  
> [android studio Gradle7.0发布内容到Maven仓库][android studio Gradle7.0_Maven]

[005ecfea76124001b09061fd429295e8.png]: https://img-blog.csdnimg.cn/005ecfea76124001b09061fd429295e8.png
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBASGVpa28tQW5kcm9pZA_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/cb18ed6315b640bf991655912c56afba.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBASGVpa28tQW5kcm9pZA==,size_20,color_FFFFFF,t_70,g_se,x_16
[5126bf457ada441a9c67448b1b99220a.png]: https://img-blog.csdnimg.cn/5126bf457ada441a9c67448b1b99220a.png
[a9f0e565b65c455494caaaa573b1664f.png]: https://img-blog.csdnimg.cn/a9f0e565b65c455494caaaa573b1664f.png
[c2fcb234733943218ed547b120c37673.png]: https://img-blog.csdnimg.cn/c2fcb234733943218ed547b120c37673.png
[aar_nexus maven]: https://blog.csdn.net/EthanCo/article/details/117779069
[Android Maven_ - _maven]: https://blog.csdn.net/EthanCo/article/details/124466747?spm=1001.2014.3001.5502
[Linux _Ubuntu_ Android_Maven_Nexus3.X]: https://blog.csdn.net/EthanCo/article/details/55060742
[Flutter_aar_maven]: https://blog.csdn.net/EthanCo/article/details/121034392
[Gradle]: https://www.jianshu.com/p/b72d3335c1d4
[publishing_maven]: https://docs.gradle.org/current/userguide/publishing_maven.html
[Gradle_maven-publish_android library_maven]: https://juejin.cn/post/6844904185754812423
[android studio Gradle7.0_Maven]: https://blog.csdn.net/u011106915/article/details/124254481