自定義gradle外掛並且釋出到本地倉庫

2023-07-24 21:00:31

轉載請標明出處,維權必究:http://77blogs.com/?p=189
一、在工程上新建一個Module。

二、刪除其餘不必要的檔案,最終目錄結構如下:

注意:由於我用的是kotlin語言,所以用的是java目錄,java語言也是用java目錄,如果用的是groovy語言,那麼就用groovy目錄。

src/main/resources/META-INF/gradle-plugins目錄下定義外掛宣告,*.properties檔案的檔名就是外掛名稱
比如
而檔案的內容implementation-class後面跟著的是外掛類的全類名。

三、module的gradle引入相關的依賴以及外掛

apply plugin: 'java'
apply plugin: 'groovy'
apply plugin: 'maven'
apply plugin: 'kotlin'

repositories {
    maven { url 'http://maven.aliyun.com/nexus/content/groups/public' }
    google()
    jcenter()
    mavenLocal()
}

dependencies {
    implementation gradleApi()
    implementation localGroovy()
    implementation "commons-io:commons-io:2.6"
    implementation 'com.android.tools.build:gradle:4.0.1'
    implementation 'com.android.tools.build:gradle-api:4.0.1'
    implementation 'org.ow2.asm:asm:7.1'
    implementation 'org.ow2.asm:asm-util:7.1'
    implementation 'org.ow2.asm:asm-commons:7.1'
    implementation "org.jetbrains.kotlin:kotlin-stdlib:1.4.32"
}

uploadArchives {
    repositories {
        mavenDeployer {
            pom.groupId = 'com.plugin'
            pom.artifactId = 'double-click'
            pom.version = '1.0.26'
            //釋出到本地倉庫
            repository(url: uri('../repo'))
        }
    }
}

由於我需要用到asm與transform相關的api,所以引入了相關的依賴。

四、編寫外掛程式碼,此處不展開說了。

五、釋出到本地倉庫:

uploadArchives {
    repositories {
        mavenDeployer {
            pom.groupId = 'com.xxx.plugin'
            pom.artifactId = 'double-click'
            pom.version = '1.0.26'
            //釋出到本地倉庫
            repository(url: uri('../repo'))
        }
    }
}

  • pom.groupId:groundId自己定義,一般為包名
  • pom.artifactId:artifactId自己定義
  • pom.version:版本號
  • repository(url: uri('../repo')):倉庫地址,為本地專案的repo資料夾,注意../不要寫錯,這是代表gradle所在目錄的上一層目錄。

六、參照
1、專案的app.gradle裡引入外掛:

apply plugin: 'com.xxxx.double-click'

該名稱為第二部裡面所講的外掛名稱。

2、project.gradle中引入地址:

buildscript {
    ext.kotlin_version = "1.4.32"
    repositories {
        google()
        jcenter()
        maven {
            //設定本地外掛目錄
            url uri('./repo')
        }
    }
    dependencies {
        classpath "com.android.tools.build:gradle:4.1.3"
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.6.10"
        classpath "com.xxxxx.plugin:double-click:1.0.26"
    }
}

這裡主要有兩部分:
(1)設定本地外掛所在的目錄,注意要與釋出到本地倉庫時候寫的地址對應上。

maven {
     //設定本地外掛目錄
     url uri('./repo')
}

(2)宣告,寫法就是傳送到本地倉庫時候所寫的groupId:artifactId:version

classpath "com.xxxxx.plugin:double-click:1.0.26"