當(dāng)你寫好了一個(gè)開源庫间护,是否也想像其他的開源庫一樣在Android Studio中一句compile就可以引用。比如:
compile 'com.android.support:appcompat-v7:25.1.0'
這看起來是一件很酷的事情,其實(shí)也不難悠瞬。將你的項(xiàng)目上傳Maven昵骤,然后發(fā)布到JCenter即可。下面我們來看看詳細(xì)過程交惯。
準(zhǔn)備工作
首先你要寫好一個(gè)開源項(xiàng)目次泽。嗯,不用我說你也知道席爽。
注冊Bintray
說到注冊意荤,大家第一時(shí)間肯定是想到去官網(wǎng)注冊。但是只锻,現(xiàn)在官網(wǎng)首頁的注冊入口(上面第一張圖)已經(jīng)變成組織的注冊了玖像,并不是個(gè)人注冊。所以我們要去個(gè)人注冊入口:
在上面這個(gè)頁面注冊就對了齐饮。也可以用第三方登錄捐寥,我是直接用Github登錄(好像其它兩個(gè)在我國也登錄不了)笤昨,省事。
創(chuàng)建一個(gè)Maven倉庫
注冊完登錄進(jìn)去后握恳,點(diǎn)擊“Add New Repository”瞒窒,新建倉庫:
接下來,我們會看到這么一個(gè)界面:
Name填maven乡洼,Type選Maven崇裁,Default Licenses選Apache-2.0,Description是描述就珠,隨便填寇壳,點(diǎn)擊Create。然后回到主頁就會在剛剛“Add New Repository”下面多了一個(gè)叫maven的倉庫妻怎。
配置build.gradle
在你Project的build.gradle文件中加入Maven和Jfrog Bintray的依賴插件:
buildscript {
repositories {
jcenter()
}
dependencies {
classpath 'com.android.tools.build:gradle:2.2.3'
//下面這兩句
classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5'
classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.7.3'
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
}
}
allprojects {
repositories {
jcenter()
}
}
task clean(type: Delete) {
delete rootProject.buildDir
}
你不一定要和我用同樣版本的插件壳炎,說不定你用的時(shí)候就不是這個(gè)版本了。建議去Github上看看最新的版本:
Maven:https://github.com/dcendents/android-maven-gradle-plugin
Jfrog Bintray:https://github.com/bintray/gradle-bintray-plugin
然后在library的build.gradle文件中進(jìn)行配置逼侦,這里以我的開源控件CircleView為例:
整個(gè)build.gradle文件如下:
apply plugin: 'com.android.library'
//添加這兩行
apply plugin: 'com.github.dcendents.android-maven'
apply plugin: 'com.jfrog.bintray'
android {
compileSdkVersion 25
buildToolsVersion "25.0.0"
defaultConfig {
minSdkVersion 14
targetSdkVersion 25
versionCode 1
versionName "1.0"
testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
}
buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}
}
dependencies {
compile fileTree(dir: 'libs', include: ['*.jar'])
androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', {
exclude group: 'com.android.support', module: 'support-annotations'
})
compile 'com.android.support:appcompat-v7:25.1.0'
testCompile 'junit:junit:4.12'
}
//項(xiàng)目主頁
def siteUrl = 'https://github.com/backkomyoung/CircleView'
//項(xiàng)目的git地址
def gitUrl = 'https://github.com/backkomyoung/CircleView.git'
//發(fā)布到JCenter上的項(xiàng)目名字
def libName = "CircleView"
//發(fā)布到組織名稱名字匿辩,必須填寫
group = "me.songning.CircleView"
// 版本號,下次更新是只需要更改版本號即可
version = "1.0.0"
//上面配置后上傳至JCenter后的編譯路徑是這樣的: compile 'me.songning.CircleView:library:1.0.0'
//生成源文件
task sourcesJar(type: Jar) {
from android.sourceSets.main.java.srcDirs
classifier = 'sources'
}
//生成Javadoc文檔
task javadoc(type: Javadoc) {
source = android.sourceSets.main.java.srcDirs
classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
}
//文檔打包成jar
task javadocJar(type: Jar, dependsOn: javadoc) {
classifier = 'javadoc'
from javadoc.destinationDir
}
//拷貝javadoc文件
task copyDoc(type: Copy) {
from "${buildDir}/docs/"
into "docs"
}
//上傳到JCenter所需要的源碼文件
artifacts {
archives javadocJar
archives sourcesJar
}
// 配置maven庫榛丢,生成POM.xml文件
install {
repositories.mavenInstaller {
// This generates POM.xml with proper parameters
pom {
project {
packaging 'aar'
//項(xiàng)目描述铲球,隨意填
name 'A colorful circle view with text.'
url siteUrl
licenses {
license {
//開源協(xié)議
name 'The Apache Software License, Version 2.0'
url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
}
}
developers {
developer {
//開發(fā)者的個(gè)人信息
id 'backkomyoung'
name 'SongNing'
email 'backkomyoung@gmail.com'
}
}
scm {
connection gitUrl
developerConnection gitUrl
url siteUrl
}
}
}
}
}
//上傳到JCenter
Properties properties = new Properties()
properties.load(project.rootProject.file('local.properties').newDataInputStream())
bintray {
user = properties.getProperty("bintray.user") //讀取 local.properties 文件里面的 bintray.user
key = properties.getProperty("bintray.apikey") //讀取 local.properties 文件里面的 bintray.apikey
configurations = ['archives']
pkg {
//這里的repo值必須要和你創(chuàng)建Maven倉庫的時(shí)候的名字一樣
repo = "maven"
//發(fā)布到JCenter上的項(xiàng)目名字
name = libName
//項(xiàng)目描述
desc = 'A colorful circle view with text.'
websiteUrl = siteUrl
vcsUrl = gitUrl
licenses = ["Apache-2.0"]
publish = true
}
}
javadoc {
options{
//如果你的項(xiàng)目里面有中文注釋的話,必須將格式設(shè)置為UTF-8晰赞,不然會出現(xiàn)亂碼
encoding "UTF-8"
charSet 'UTF-8'
author true
version true
links "http://docs.oracle.com/javase/7/docs/api"
}
}
除此外稼病,還要將user和key寫到local.properties文件中:
sdk.dir=E\:\\Android\\Sdk
//uer和key
bintray.user=username
bintray.apikey=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
user即為你的賬號:
key的話點(diǎn)擊修改信息:
選擇左邊的“API key”,然后復(fù)制key:
把user和key填到上面的local.properties文件中就ok啦掖鱼。準(zhǔn)備工作到這里算是完成了然走。
執(zhí)行命令
打開Android Studio底部工具欄的Terminal窗口,輸入命令:
gradlew install
漫長的等待...可能是我的網(wǎng)絡(luò)問題戏挡,吃了個(gè)飯回來才弄好芍瑞。
顯示“BUILD SUCCESSFUL”即表示成功。
到這里已經(jīng)成功一半了褐墅,只差上傳到Bintray了拆檬。然后我們接著在Terminal窗口輸入命令:
gradlew bintrayUpload
這個(gè)很快就好~
同樣,顯示“BUILD SUCCESSFUL”即表示成功妥凳。
發(fā)布到JCenter
這時(shí)候打開我們創(chuàng)建的maven倉庫竟贯,就會在里面發(fā)現(xiàn)已經(jīng)成功將項(xiàng)目上傳到倉庫里。
點(diǎn)擊我們的項(xiàng)目名逝钥,進(jìn)入詳情:
點(diǎn)擊“Add to JCenter”后:
直接點(diǎn)Send就行了澄耍。因?yàn)闀r(shí)差的關(guān)系,接下來就是漫長的等待審核了。
經(jīng)過幾個(gè)小時(shí)齐莲,在Bintray的網(wǎng)站上會有提示審核通過。這時(shí)候磷箕,就可以在Android Studio上通過compile的方式使用了选酗。
遇到的問題
說說我遇到的問題,就是執(zhí)行上傳命令的時(shí)候岳枷,顯示這個(gè)錯(cuò)誤:
提示找不到“maven”芒填,原因是我當(dāng)時(shí)還沒創(chuàng)建Maven倉庫就執(zhí)行上傳命令,創(chuàng)建后再執(zhí)行一遍命令就成功了空繁。還有就是創(chuàng)建的Maven倉庫的名字一定要和build.gradle文件里面的repo值一致殿衰。我就遇到這一個(gè)問題。
如果你們遇到其他的問題盛泡,建議看看這篇:
結(jié)語
到這里就把整個(gè)開源庫發(fā)布到JCenter的流程寫完了闷祥,有什么問題可以在下面留言~
參考文章
android 將開源項(xiàng)目發(fā)布到JCenter及問題總結(jié)
利用Gradle發(fā)布項(xiàng)目到JCenter、Maven
新版Bintray-極簡上傳Library到JCenter