天天看點
傳回

【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自适應常用布局（一）

繼續閱讀