Android Maven 上传aar 生成Gitlab私有远程

前言

需要实现的功能是，通过 maven 把 Library 打包成 aar 文件，上传至 Gitlab 私有仓库，并实现可远程依赖。

eg:

implementation 'com.custom.library:Module:1.0.0'

配置环境

硬 件： Mac OS
As 版本： Arctic Fox
Kotlin 版本: 1.5.30
Gradle 版本：7.0.2

初始化过程

直接创建一个Project，然后再创建一个 Module 即可。

配置过程

1,先把 module- build.gradle 中的 applicationId 配置删除掉，会和 app 目录下的冲突。

2, 在 module-build.gradle 中添加 maven-publish 插件。

plugins {
  id 'com.android.library'  // 这里要改成 library
 ...
  id 'maven-publish'  // 新增
}

添加 Maven 配置(官方链接)

因为我这边是上传的 Gitlab 示例代码也是 Gitlab 的，另外下面的配置代码都是写在 library 的 build.gradle 中。

• repositories 模块

        repositories {
            maven {
                url "https://gitlab.com/api/v4/projects/[PROJECT_ID]/packages/maven"
                name "GitLab"  // 这个name 目前感觉好像没有明显作用 -.-
                credentials(HttpHeaderCredentials) {
                    name = "Private-Token"
                    value = "[GitLabPrivateToken]"
                }
                authentication {
                    header(HttpHeaderAuthentication)
                }
            }
        }

PROJECT_ID 是要替换为你自己的项目ID (在Gitlab的项目主页会有显示)，如果项目ID是 123123，那么最终的完整链接是：

url "https://gitlab.com/api/v4/projects/123123/packages/maven"

GitLabPrivateToken 需要替换成你自己的 Gitlab 私有 Token 。（不知道怎么获取的话，自己搜索一下哈）

• publications 模块

        publications {
            aar(MavenPublication) {  // 这个方法名， 好像也没影响 aar  bar 随便写一个都行，
//            from components.java
                groupId "com.custom.library" // 包名
                artifactId "Module" // module的名字   这个不配置的话，默认为 library 的名字，
                version BUILD_VERSION // 版本号
                artifact androidSourcesJar
                artifact("$buildDir/outputs/aar/Module-release.aar")   //  这里需要注意，修改成你生成的aar 名字，一般是[Library的名字]-release.aar 

//                //maven-publish does not capture dependencies from this file
                pom.withXml {  // 这里的照抄，
                    def dependenciesNode = asNode().appendNode('dependencies')
                    // Iterate over the api dependencies (we don't want the test ones), adding a <dependency> node for each
                    configurations.api.allDependencies.each {
                        def dependencyNode = dependenciesNode.appendNode('implementation')
                        dependencyNode.appendNode('groupId', it.group)
                        dependencyNode.appendNode('artifactId', it.name)
                        dependencyNode.appendNode('version', it.version)
                    }
                }
            }
        }

• 其他方法

// 源代码一起打包
task androidSourcesJar(type: Jar) {
    archiveClassifier.set('sources')
//    from android.sourceSets.main.java.sourceFiles  // 用这段代码，生成的依赖，看不到源码source.
    from android.sourceSets.main.java.srcDirs
}
artifacts {
    archives androidSourcesJar
}

完整的配置代码

注意： 这里的代码是在 Library 的 build.gradle 文件中，别写错地方了

plugins {
    id 'com.android.library'
    id 'kotlin-android'
    id 'kotlin-android-extensions'
    id 'maven-publish'
}
...
省略代码
...

def BUILD_VERSION = '0.0.1'

// 源代码一起打包
task androidSourcesJar(type: Jar) {
    archiveClassifier.set('sources')
//    from android.sourceSets.main.java.sourceFiles
    from android.sourceSets.main.java.srcDirs
}
artifacts {
    archives androidSourcesJar
}

afterEvaluate {
    publishing {
        publications {
            aar(MavenPublication) {
//            from components.java
                groupId "com.custom.library" // 包名
                artifactId "Module" // module的名字   这个不配置的话，默认为 library 的名字，
                version BUILD_VERSION // 版本号
                artifact androidSourcesJar
                artifact("$buildDir/outputs/aar/Module-release.aar")  // 这里的 Module-release 名字，可以在配置完成之后，先执行一下 build 命令，确认一下然后再调整。命令下面有介绍。

//                //maven-publish does not capture dependencies from this file
                pom.withXml {
                    def dependenciesNode = asNode().appendNode('dependencies')
                    // Iterate over the api dependencies (we don't want the test ones), adding a <dependency> node for each
                    configurations.api.allDependencies.each {
                        def dependencyNode = dependenciesNode.appendNode('implementation')
                        dependencyNode.appendNode('groupId', it.group)
                        dependencyNode.appendNode('artifactId', it.name)
                        dependencyNode.appendNode('version', it.version)
                    }
                }
            }
        }
        repositories {
            maven {
                url "https://gitlab.com/api/v4/projects/123123/packages/maven"
                name "gitlab-name"
                credentials(HttpHeaderCredentials) {
                    name = "Private-Token"
                    value = "${System.getenv("GITLABTOKEN")}"
                }
                authentication {
                    header(HttpHeaderAuthentication)
                }
            }
        }
    }
}

执行命令语句

打开 Android Studio 的 Terminal 输入以下命令，并执行

./gradlew clean build publish

这里一共是执行三个命令，1，clean 2，build 3, publish

查看结果

命令执行完成后，在 Gitlab 的项目页面查看，

image.png

问题注意

1，Module-build.gradle 文件中的 JavaVersion 和 jvmTarget 要注释掉，

//    compileOptions {
//        sourceCompatibility JavaVersion.VERSION_1_8
//        targetCompatibility JavaVersion.VERSION_1_8
//    }
//    kotlinOptions {
//        jvmTarget = '1.8'
//    }

2，要把Project的 gradle jdk 版本改为 11 版本，1.8不支持。路径如下

preference -> Build, Execution... -> Build Tools -> Gradle

image.png

3，如果还有JDK版本的问题，就要在 project 的 gradle.properties 文件中添加下面代码, 注意这个代码不要提交，多人协作会冲突。

org.gradle.java.home=/Applications/Android Studio 2.app/Contents/jre/Contents/Home

这个是你本地的 JDK11 路径。

最终引用

1， 在Project 的 setting.gradle 文件中添加以下代码

        maven {
            url "https://gitlab.com/api/v4/projects/123123/packages/maven"
            name "Gitlab"
            credentials(HttpHeaderCredentials) {
                name = "Private-Token"
                value = "${System.getenv("GITLABTOKEN")}"
            }
            authentication {
                header(HttpHeaderAuthentication)
            }
        }

2，在 app- build.gradle 中添加依赖

implementation("com.custom.library:Module:0.0.1")