天天看点
返回

【Android Gradle 插件】将自定义 Gradle 插件上传到自建 Maven 仓库 ⑧ ( 设置 Gradle 插件模块 | 将 Gradle 插件上传到自建 Maven 仓库 )

文章目录

  • ​​一、设置 Gradle 插件模块​​
  • ​​二、执行发布 Gradle 插件任务将 Gradle 插件上传到自建 Maven 仓库​​

Android Plugin DSL Reference 参考文档 :

  • Android Studio 构建配置官方文档 : ​​https://developer.android.google.cn/studio/build​​
  • 添加构建依赖项 参考文档 : ​​https://developer.android.google.cn/studio/build/dependencies​​
  • Android Gradle 插件配置与 Gradle 配置关联 : ​​【Android Gradle 插件】Gradle 依赖管理 ① ( org.gradle.api.Project 配置 | Android Gradle 插件配置与 Gradle 配置关联 ) ★​​
  • Android Gradle 插件文档主页 : ​​https://google.github.io/android-gradle-dsl/2.3/​​
  • BaseExtension 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.BaseExtension.html​​
  • AppExtension ( build.gradle#android 配置 ) 文档位置 : ​​android-gradle-dsl-gh-pages/2.3/com.android.build.gradle.AppExtension.html​​
  • build.gradle#android 模块配置文档 : ​​android-gradle-dsl/2.3/com.android.build.gradle.AppExtension.html​​
  • ProductFlavor ( build.gradle#android#defaultConfig 配置 ) 文档 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.ProductFlavor.html​​
  • ProductFlavor#externalNativeBuild 配置 ( build.gradle#android#defaultConfig#externalNativeBuild 配置 ) : ​​com.android.build.gradle.internal.dsl.ProductFlavor:externalNativeBuild​​
  • ExternalNativeBuildOptions ( build.gradle#android#defaultConfig#externalNativeBuild 配置 ) 文档位置 : ​​android-gradle-dsl-gh-pages/2.3/com.android.build.gradle.internal.dsl.ExternalNativeBuildOptions.html​​
  • NdkBuildOptions ( build.gradle#android#defaultConfig#externalNativeBuild#ndkBuild 配置 ) 文档位置 : ​​android-gradle-dsl-gh-pages/2.3/com.android.build.gradle.internal.dsl.NdkBuildOptions.html​​
  • CmakeOptions ( build.gradle#android#defaultConfig#externalNativeBuild#cmake 配置 ) 文档位置 : ​​android-gradle-dsl-gh-pages/2.3/com.android.build.gradle.internal.dsl.CmakeOptions.html​​
  • JackOptions ( build.gradle#android#defaultConfig#jackOptions 配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.JackOptions.html​​
  • AnnotationProcessorOptions ( 注解处理器配置 ) ( build.gradle#android#defaultConfig#javaCompileOptions配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.AnnotationProcessorOptions.html​​
  • NdkOptions ( build.gradle#android#defaultConfig#ndk 配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.NdkOptions.html​​
  • NDK 参考文档 : ​​Add C and C++ Code to Your Project.​​
  • VectorDrawablesOptions ( build.gradle#android#defaultConfig#vectorDrawables 配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.VectorDrawablesOptions.html​​
  • BuildType ( build.gradle#android#buildTypes 配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.BuildType.html​​
  • SigningConfig ( build.gradle#android#signingConfigs 配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.SigningConfig.html​​
  • AaptOptions ( build.gradle#android#aaptOptions 配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.AaptOptions.html​​
  • AndroidSourceSets ( build.gradle#android#sourceSets 配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.api.AndroidSourceSet.html​​
  • AndroidSourceDirectorySet ( build.gradle#android#sourceSets#aidl/assets/java/jni/jniLibs 配置 ) 文档位置 :​​android-gradle-dsl/2.3/com.android.build.gradle.api.AndroidSourceDirectorySet.html​​
  • AndroidSourceFile ( build.gradle#android#sourceSets#manifest 配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.api.AndroidSourceFile.html​​
  • DataBindingOptions ( build.gradle#android#dataBinding ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.DataBindingOptions.html​​
  • DexOptions ( build.gradle#android#dexOptions ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.DexOptions.html​​
  • LintOptions ( build.gradle#android#lintOptions ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.LintOptions.html​​
  • PackagingOptions ( build.gradle#android#packagingOptions ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.PackagingOptions.html​​
  • Splits ( build.gradle#android#splits ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.Splits.html​​
  • AbiSplitOptions ( build.gradle#android#splits#abi ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.AbiSplitOptions.html​​
  • LanguageSplitOptions ( build.gradle#android#splits#language ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.LanguageSplitOptions.html​​
  • DensitySplitOptions ( build.gradle#android#splits#density ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.DensitySplitOptions.html​​
  • TestOptions ( build.gradle#android#testOptions ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.TestOptions.html​​
  • Android 测试相关文档 : ​​https://developer.android.google.cn/training/testing​​
  • UnitTestOptions ( build.gradle#android#testOptions#unitTests ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.TestOptions.UnitTestOptions.html​​
  • org.gradle.api.tasks.testing.Test 单元测试配置类 : ​​https://docs.gradle.org/current/javadoc/org/gradle/api/tasks/testing/Test.html​​
  • LibraryExtension ( Library 依赖库的 build.gradle#android 配置 ) 文档 : ​​android-gradle-dsl/2.3/com.android.build.gradle.LibraryExtension.html​​
  • org.gradle.api.Project 配置 ( build.gradle 根配置 ) 文档 : ​​https://docs.gradle.org/current/javadoc/org/gradle/api/Project.html​​
  • org.gradle.api.initialization.Settings 配置 文档 : ​​https://docs.gradle.org/current/javadoc/org/gradle/api/initialization/Settings.html​​
  • org.gradle.api.artifacts.dsl.DependencyHandler 配置 ( build.gradle#dependencies#implementation 配置 ) : ​​https://docs.gradle.org/current/javadoc/org/gradle/api/artifacts/dsl/DependencyHandler.html​​
  • 添加构建依赖项 参考文档 : ​​https://developer.android.google.cn/studio/build/dependencies​​
  • org.gradle.api.Task 配置 ( Gradle 任务类型 ) 文档 : ​​https://docs.gradle.org/current/javadoc/org/gradle/api/Task.html​​
  • org.gradle.api.tasks.TaskContainer配置 ( Gradle 任务容器类型 ) 文档 : ​​https://docs.gradle.org/current/javadoc/org/gradle/api/tasks/TaskContainer.html​​
  • org.gradle.api.DefaultTask 配置 ( Gradle 自定义任务类父类 ) 文档 : ​​https://docs.gradle.org/current/javadoc/org/gradle/api/DefaultTask.html​​
  • org.gradle.api.tasks.Delete 自带任务 ( clean 任务类型 ) 文档 : ​​https://docs.gradle.org/current/dsl/org.gradle.api.tasks.Delete.html​​
  • org.gradle.api.tasks.bundling.Zip 自带任务 ( 任务类型 ) 文档 :​​https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Zip.html​​
  • org.gradle.api.tasks.bundling.Jar自带任务 ( 任务类型 ) 文档 : ​​https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html​​
  • Gradle 自带任务查询界面 ( 搜索 Task Types ) : ​​https://docs.gradle.org/current/dsl/#N1045C​​
  • org.gradle.api.invocation.Gradle 文档 ( 可设置 Gradle 构建声明周期监听器 ) : ​​https://docs.gradle.org/current/javadoc/org/gradle/api/invocation/Gradle.html​​
  • org.gradle.BuildListener 构建监听器 文档 : ​​https://docs.gradle.org/current/javadoc/org/gradle/BuildListener.html​​
  • org.gradle.execution.TaskExecutionGraphListener 构建监听器 文档 : ​​https://docs.gradle.org/current/javadoc/org/gradle/api/execution/TaskExecutionGraphListener.html​​
  • 自定义 Gradle 插件 - GitHub 地址 : ​​https://github.com/han1202012/Android_UI​​

一、设置 Gradle 插件模块

在 ​​【Android Gradle 插件】将自定义 Gradle 插件上传到自建 Maven 仓库 ⑦ ( 登录 Maven 私服 | Maven 私服初始化设置 | 创建 Maven 仓库 )​​ 博客中 , 在 Maven 私服中创建了 Maven 仓库 " MyRepository “ , 地址为 ” http://localhost:8081/repository/MyRepository/ " ;

在 Gradle 插件模块的 build.gradle 构建脚本 的 publishing/publications 脚本块 中 , 配置如下代码 ,

  • name: 任意字符串 , 一般设置为远程仓库的名称 ;
  • url: Maven 仓库的 url 地址 ;
  • credentials: 设置访问 Maven 仓库的账号和密码 ; 
// 配置上传到哪个 Maven 仓库
    // 默认为本地 Maven 仓库
    repositories {
        maven {
            // 任意字符串名称
            name "MyRepository"
            // Maven 仓库的 url 地址
            // 点击 Maven 仓库的 URL 列的 copy 按钮获取
            url "http://localhost:8081/repository/MyRepository/"
            // 配置上传的身份
            // 就是 Maven 私服的账号密码
            credentials {
                username = "admin"
                password = "admin123"
            }
        }
    }

完整源码如下 :

plugins {
    id 'java-library'
    id 'kotlin'
    id 'groovy'
}

java {
    sourceCompatibility = JavaVersion.VERSION_1_7
    targetCompatibility = JavaVersion.VERSION_1_7
}

dependencies {
    implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
    implementation gradleApi()
    implementation localGroovy()
    implementation fileTree(dir: 'libs', includes: ['*.jar'])
}

// 指定自定义 Gradle 插件的分组
group 'kim.hsl.plugin'

// 指定自定义 Gradle 插件的版本号
version '0.1'

// 自定义 Gradle 插件的名称 , 默认为工程名
// 也可以在 publishing / publications 脚本块中 自己指定


// 用于将 插件上传到 远程仓库 或者 本地仓库 中
apply plugin: 'maven-publish'

// 自定义源码打包任务
// 自定义 Jar 类型的 Gradle 任务
// 将源码打包到 jar 包中
task sources2Jar(type: Jar) {
    // 指明要打的 jar 包名称
    // 最终打包的名称是 plugin-0.1-sources.jar
    baseName 'plugin'
    // 指定分类器 , 与其它 jar 包进行区分
    classifier 'sources'
    // 设置打包哪些文件
    // 这里设置的是 main 目录下的所有文件
    from sourceSets.main.allSource
}

// 自定义文档打包任务
// 自定义 Jar 类型的 Gradle 任务
// 将文档打包到 jar 包中
task document2Jar(type: Jar, dependsOn: [javadoc, groovydoc]) {
    // 指明要打的 jar 包名称
    // 最终打包的名称是 plugin-0.1-doc.jar
    baseName 'plugin'
    // 指定分类器 , 与其它 jar 包进行区分
    classifier 'doc'
    // 设置打包哪些文件
    // 这里设置的是 javadoc 和 groovydoc 任务的输出目录
    from javadoc.destinationDir, groovydoc.destinationDir
}

// 配置 工程工件 对应的 jar 包产出 配置
// 这里将 文档打包 和 源码打包 后的 jar 包作为输出
artifacts {
    archives sources2Jar
    archives document2Jar
}

// 发布到 远程/本地仓库 相关配置
publishing {
    publications {
        // plugin 函数是随意命名的函数
        plugin(MavenPublication) {
            // 配置上传内容
            // components.java 是打包的 jar 包
            from components.java

            // 指定自定义 Gradle 插件名称
            artifactId 'plugin'

            // 上传源码
            artifact sources2Jar
            // 上传文档
            artifact document2Jar

            // 自定义 pom 节点
            pom.withXml {
                /*  添加如下节点
                    <licenses>
                      <license>
                        <name>Apache License, Version 2.0</name>
                        <url>https://www.apache.org/licenses/LICENSE-2.0.txt</url>
                        <distribution>repo</distribution>
                        <comments>A business-friendly OSS license</comments>
                      </license>
                    </licenses>
                 */

                // 先创建 root 根节点
                def root = asNode()

                // 向根节点中添加 <licenses> 节点
                // 向 <licenses> 节点中添加 <license> 节点
                def licensesNode = root
                        .appendNode("licenses") // <licenses> 节点
                        .appendNode("license")  // <license> 节点

                // 为 <license> 节点 配置 name 节点属性
                licensesNode.appendNode("name", "Apache License, Version 2.0")
                // 为 <license> 节点 配置 url 节点属性
                licensesNode.appendNode("url", "https://www.apache.org/licenses/LICENSE-2.0.txt")
                // 为 <license> 节点 配置 distribution 节点属性
                licensesNode.appendNode("distribution", "repo")
                // 为 <license> 节点 配置 comments 节点属性
                licensesNode.appendNode("comments", "A business-friendly OSS license")
            }
        }
    }

    // 配置上传到哪个 Maven 仓库
    // 默认为本地 Maven 仓库
    repositories {
        maven {
            // 任意字符串名称
            name "MyRepository"
            // Maven 仓库的 url 地址
            // 点击 Maven 仓库的 URL 列的 copy 按钮获取
            url "http://localhost:8081/repository/MyRepository/"
            // 配置上传的身份
            // 就是 Maven 私服的账号密码
            credentials {
                username = "admin"
                password = "admin123"
            }
        }
    }
}

自定义 Gradle 插件 - GitHub 地址 : ​​https://github.com/han1202012/Android_UI​​

二、执行发布 Gradle 插件任务将 Gradle 插件上传到自建 Maven 仓库

构建脚本进行上述修改后 , 同步脚本 , 就会在 Gradle 面板中生成 " publishPluginPublicationToMyRepositoryRepository " 任务 ;

【Android Gradle 插件】将自定义 Gradle 插件上传到自建 Maven 仓库 ⑧ ( 设置 Gradle 插件模块 | 将 Gradle 插件上传到自建 Maven 仓库 )

在 Gradle 面板中执行该 " publishPluginPublicationToMyRepositoryRepository " 任务 , 就会自动将插件内容上传到创建的 maven 仓库中 ;

上传完成后 , 在 Maven 私服的 Web 界面 , 点击 MyRepository 仓库 ,

【Android Gradle 插件】将自定义 Gradle 插件上传到自建 Maven 仓库 ⑧ ( 设置 Gradle 插件模块 | 将 Gradle 插件上传到自建 Maven 仓库 )
android Maven android studio gradle java
上一篇: VMware虚拟机双屏显示
下一篇: QML自适应常用布局（一）

继续阅读