天天看點

Gradle 使用技巧(七) - 10分鐘将快速開源 Jitpack 與增加中文注釋

引言

作為一個開發者,最自豪的事情就是自己的努力得到了别人的贊賞。這一次就通過一個簡短的系列:如何在最簡短的時間内将自己的lib上傳到中央倉庫供其他人下載下傳,并且增加中文源碼注釋。

選擇

前提條件:

  • 有GitHub帳号
  • 有需要開源的庫

為了達到快速開放的目的,本次選擇的倉庫是jitpack,而不選擇maven,其主要原因是maven太過于複雜,還需要新增賬號,初次使用還可能需要花費大半天的時間。

開始

Git倉庫

檢視項目結構

建立一個新的release

Gradle 使用技巧(七) - 10分鐘将快速開源 Jitpack 與增加中文注釋

new release

輸入相關的值:

Gradle 使用技巧(七) - 10分鐘将快速開源 Jitpack 與增加中文注釋

enter data

建立結果:

Gradle 使用技巧(七) - 10分鐘将快速開源 Jitpack 與增加中文注釋

建立成功

Jitpack

打開

,将GitHub倉庫位址放入輸入框,點選 look up

Gradle 使用技巧(七) - 10分鐘将快速開源 Jitpack 與增加中文注釋

輸入相關值

等待編譯:

Gradle 使用技巧(七) - 10分鐘将快速開源 Jitpack 與增加中文注釋

等待編譯

編譯成功:

Gradle 使用技巧(七) - 10分鐘将快速開源 Jitpack 與增加中文注釋

編譯成功

引入使用

Step 1.在根build.gradle添加倉庫位址

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}
           

Step 2. 添加依賴

dependencies {
    implementation 'com.github.aohanyao:GradlesKill:v0.0.1'
}
           

Step 3.驗證引用

Gradle 使用技巧(七) - 10分鐘将快速開源 Jitpack 與增加中文注釋

引用結果

增加中文注釋

從上圖可以看到,printTest方法上面是沒有注釋的,接下來就是加入注釋的操作,将以下代碼塊加入到lib的gradle中的android節點:

// 打包源碼jar
task sourcesJar(type: Jar) {
    from android.sourceSets.main.java.srcDirs
    classifier = 'sources'
}
//編譯groovy代碼時采用 UTF-8
tasks.withType(GroovyCompile) {
    groovyOptions.encoding = "MacRoman"
}

//編譯JAVA檔案時采用UTF-8
tasks.withType(JavaCompile) {
    options.encoding = "UTF-8"
}

task javadoc(type: Javadoc) {
    failOnError false
    source = android.sourceSets.main.java.sourceFiles
    classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
    classpath += configurations.compile
}

// 打封包檔jar
task javadocJar(type: Jar, dependsOn: javadoc) {
    classifier = 'javadoc'
    from javadoc.destinationDir
}

artifacts {
    archives sourcesJar
    archives javadocJar
}
           

然後重新送出代碼,再建立一個release,重複上面的步驟。

Gradle 使用技巧(七) - 10分鐘将快速開源 Jitpack 與增加中文注釋

建立新的release

Gradle 使用技巧(七) - 10分鐘将快速開源 Jitpack 與增加中文注釋

重新擷取編譯:

Gradle 使用技巧(七) - 10分鐘将快速開源 Jitpack 與增加中文注釋

重新編譯

更改依賴:

Gradle 使用技巧(七) - 10分鐘将快速開源 Jitpack 與增加中文注釋

更改依賴

檢視結果:

Gradle 使用技巧(七) - 10分鐘将快速開源 Jitpack 與增加中文注釋

更改結果

結束

未完待續、敬請期待!

Gradle 使用技巧(七) - 10分鐘将快速開源 Jitpack 與增加中文注釋

FullScreenDeveloper

源碼位址

繼續閱讀