小白如何使用Android Studio把自己的Android library分享到jCenter

来源:互联网 发布:淘宝网不是私密连接 编辑:程序博客网 时间:2024/06/06 00:51

正餐开始前的叨叨

如果你想在Android Studio中引入一个library到你的项目,你只需添加如下的一行代码到模块的build.gradle文件中。

compile 'top.ish.foundationlibrary:foundationlibrary:1.0.0'

不过你可能很好奇Android Studio是从哪里得到这个library的。

Android Studio是从build.gradle里面定义的Maven 仓库服务器上下载library的。Apache Maven是Apache开发的一个工具,提供了用于贡献library的文件服务器。总的来说,只有两个标准的Android library文件服务器:jcenter 和 Maven Central。

jcenter

jcenter是一个由 bintray.com维护的Maven仓库 。你可以在这里看到整个仓库的内容。

我们在项目的build.gradle 文件中如下定义仓库,就能使用jcenter了

allprojects {    repositories {        jcenter()    }}

Maven Central

Maven Central 则是由sonatype.org维护的Maven仓库。你可以在这里看到整个仓库。

注:不管是jcenter还是Maven Central ,两者都是Maven仓库

我们在项目的build.gradle 文件中如下定义仓库,就能使用Maven Central了:

allprojects {    repositories {        mavenCentral()    }}

注意,虽然jcenter和Maven Central 都是标准的 android library仓库,但是它们维护在完全不同的服务器上,由不同的人提供内容,两者之间毫无关系。在jcenter上有的可能 Maven Central 上没有,反之亦然。

理解jcenter和Maven Central

为何有两个标准的仓库?

事实上两个仓库都具有相同的使命:提供Java或者Android library服务。上传到哪个(或者都上传)取决于开发者。

起初,Android Studio 选择Maven Central作为默认仓库。如果你使用老版本的Android Studio创建一个新项目,mavenCentral()会自动的定义在build.gradle中。

但是Maven Central的最大问题是对开发者不够友好。上传library异常困难。上传上去的开发者都是某种程度的极客。同时还因为诸如安全方面的其他原因,Android Studio团队决定把默认的仓库替换成jcenter。正如你看到的,一旦使用最新版本的Android Studio创建一个项目,jcenter()自动被定义,而不是mavenCentral()。

有许多将Maven Central替换成jcenter的理由,下面是几个主要的原因。

  • jcenter通过CDN发送library,开发者可以享受到更快的下载体验。

  • jcenter是全世界最大的Java仓库,因此在Maven Central 上有的,在jcenter上也极有可能有。换句话说jcenter是Maven Central的超集。

  • 上传library到仓库很简单,不需要像在 Maven Central上做很多复杂的事情。

  • 友好的用户界面

  • 如果你想把library上传到 Maven Central ,你可以在bintray网站上直接点击一个按钮就能实现。

gradle是如何从仓库上获取一个library的?

在讨论如何上传library到jcenter之前,我们先看看gradle是如何从仓库获取library的。比如我们在 build.gradle输入如下代码的时候,这些库是如果奇迹般下载到我们的项目中的。

compile 'com.inthecheesefactory.thecheeselibrary:fb-like:0.9.3'

一般来说,我们需要知道library的字符串形式,包含3部分

GROUP_ID:ARTIFACT_ID:VERSION

上面的例子中,GROUP_ID是com.inthecheesefactory.thecheeselibrary ,ARTIFACT_ID是fb-like,VERSION是0.9.3。

GROUP_ID定义了library的group。有可能在同样的上下文中存在多个不同功能的library。如果library具有相同的group,那么它们将共享一个GROUP_ID。通常我们以开发者包名紧跟着library的group名称来命名,比如com.squareup.picasso。然后ARTIFACT_ID中是library的真实名称。至于VERSION,就是版本号而已,虽然可以是任意文字,但建议设置为x.y.z的形式,如果喜欢还可以加上beta这样的后缀。

下面是Square library的一个例子。你可以看到每个都可以很容易的分辨出library和开发者的名称。

dependencies {  compile 'com.squareup:otto:1.3.7'  compile 'com.squareup.picasso:picasso:2.5.2'  compile 'com.squareup.okhttp:okhttp:2.4.0'  compile 'com.squareup.retrofit:retrofit:1.9.0'}

那么在添加了上面的依赖之后会发生什么呢?

简单!Gradle会询问Maven仓库服务器这个library是否存在,如果存在,gradle会获得请求library的路径。

一般这个路径都是这样的形式:GROUP_ID/ARTIFACT_ID/VERSION_ID

例如可以在

http://jcenter.bintray.com/com/squareup/otto/1.3.7
https://oss.sonatype.org/content/repositories/releases/com/squareup/otto/1.3.7/

路径下获得com.squareup:otto:1.3.7的library文件。

然后Android Studio 将下载这些文件到我们的电脑上,与我们的项目一起编译。整个过程就是这么简单,一点都不复杂。

但是需要注意的是从仓库上下载的library只是存储在仓库服务器上的jar 或者aar文件而已。有点类似于自己去下载这些文件,拷贝然后和项目一起编译。但是使用gradle依赖管理的最大好处是你除了添加几行文字之外什么也不用做。library就可以正常在项目中使用了。

了解aar文件

刚才说了仓库中存储的有两种类型的library:jar 和 aar。jar文件大家都知道,但是什么是aar文件呢?

aar文件时在jar文件之上开发的。之所以有它是因为有些Android Library需要植入一些安卓特有的文件,比如AndroidManifest.xml,资源文件,Assets或者JNI。这些都不是jar文件的标准。

因此aar文件就时发明出来包含所有这些东西的。总的来说它和jar一样只是普通的zip文件,不过具有不同的文件结构。jar文件以classes.jar的名字被嵌入到aar文件中。其余的文件罗列如下:

/AndroidManifest.xml (mandatory)/classes.jar (mandatory)/res/ (mandatory)/R.txt (mandatory)/assets/ (optional)/libs/*.jar (optional)/jni/<abi>/*.so (optional)/proguard.txt (optional)/lint.jar (optional)

可以看到.aar文件是专门为安卓设计的

正餐开始

云端准备

第一步

在 https://bintray.com/signup/oss 上注册账号
注意:注册的时候注意选择,如图
注册选择

第二步

创建仓库

第三步

填入需要的信息
填入信息

第四步

填写仓库信息

第五步

到创建的仓库里面建立应用
创建应用

第六步

这里写图片描述

完工!现在你有了自己在Bintray上的Maven仓库,可以准备上传library到上面了。

android studio端准备

首先,我们需要修改工程项目的build.gradle文件中的依赖部分,如下:

dependencies {        classpath 'com.android.tools.build:gradle:2.3.3'        classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.2'        classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5'}

接下来我们将修改local.properties。在里面定义api key的用户名以及被创建的apikey,用于bintray的认证。用户名就是你注册用户的用户名,apikey的获取如下
这里写图片描述
这里写图片描述

bintray.user=YOUR_BINTRAY_USERNAMEbintray.apikey=YOUR_BINTRAY_API_KEY

注意,local.properties文件要加入到.gitignore,不能上传。apikey是你的认证信息很重要

再接下来就是配置build.gradle文件 注意,修改的是你要上传的library的 build.gradle ,由于配置比较麻烦,将build.gradle全部贴出来,大家可以根据实际情况替换或者复制粘贴

apply plugin: 'com.android.library'android {    resourcePrefix "sp_" //随意填写    compileSdkVersion 25    buildToolsVersion '25.0.3'    defaultConfig {        minSdkVersion 23        targetSdkVersion 25        versionCode 2        versionName "1.1"    }    buildTypes {        release {            minifyEnabled false            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'        }    }}dependencies {    compile fileTree(dir: 'libs', include: ['*.jar'])    testCompile 'junit:junit:4.12'    compile 'com.android.support:appcompat-v7:25.3.1'    compile "com.android.support:design:25.3.1"    compile 'com.android.support:recyclerview-v7:25.3.1'}//==================从这里配置开始=========================apply plugin: 'com.github.dcendents.android-maven'apply plugin: 'com.jfrog.bintray'// 这个version是区分library版本的,因此当我们需要更新library时记得修改这个version// 这个version影响后面的引用version = "1.0.0"def siteUrl = 'https://github.com/weiyanjie/FoundationLibrary'   // 项目的主页def gitUrl = 'https://github.com/weiyanjie/FoundationLibrary.git'   // Git仓库的urlgroup = "top.ish.foundationlibrary"            // Maven Group ID for the artifact,一般填你唯一的包名install {    repositories.mavenInstaller {        // This generates POM.xml with proper parameters        pom {            project {                packaging 'aar'                // Add your description here                name 'android开发基础类库'     //项目的描述,可以描述下项目的基本情况                url siteUrl                // Set your license                licenses {                    license {                        name 'The Apache Software License, Version 2.0'                        url 'http://www.apache.org/licenses/LICENSE-2.0.txt'                    }                }                developers {//填写的开发者的基本信息                    developer {                        id 'androidman'                        name 'weiyanjie'                        email 'androidman@yeah.net'                    }                }                scm {                    connection gitUrl                    developerConnection gitUrl                    url siteUrl                }            }        }    }}task sourcesJar(type: Jar) {    from android.sourceSets.main.java.srcDirs    classifier = 'sources'}task javadoc(type: Javadoc) {    source = android.sourceSets.main.java.srcDirs    classpath += project.files(android.getBootClasspath().join(File.pathSeparator))}task javadocJar(type: Jar, dependsOn: javadoc) {    classifier = 'javadoc'    from javadoc.destinationDir}artifacts {    archives javadocJar    archives sourcesJar}Properties properties = new Properties()properties.load(project.rootProject.file('local.properties').newDataInputStream())bintray {    user = properties.getProperty("bintray.user")    key = properties.getProperty("bintray.apikey")    configurations = ['archives']    pkg {        repo = "maven"   //发布到JCenter上的仓库名字        name = "foundationlibrary"    //发布到JCenter上的项目名字        websiteUrl = siteUrl        vcsUrl = gitUrl        licenses = ["Apache-2.0"]        publish = true    }}

做完这些,那么上传所有的配置就都完成了,下面最后一步,在工程根目录里面执行如下命令

./gradlew install       //编译./gradlew bintrayUpload //上传

等待上传完毕,然后去自己的仓库首页找到该库里面的工程,点击Add TO JCenter,然后发送,然后等待jcenter的审核就行了

需要注意的是在jcenter审核通过之前我们是不能在自己的项目里面使用的

添加到jcenter

发送

审核通过后会以站内信的形式发给你,如下图

审核通过

这个时候你就可以在你的工程中引用你的库啦

compile 'top.ish.foundationlibrary:foundationlibrary:1.0.0'

其实这个路径是 group:库的名字:版本号 (就是我们配置library的时候填写的)

总结

第一次搞得时候可能很多地方一脸懵逼,所以本文尽可能多的把需要用到的细节呈现出来。如果大家有什么疑问欢迎留言

参考

http://www.jcodecraeer.com/a/anzhuokaifa/androidkaifa/2015/0623/3097.html
http://www.jianshu.com/p/0ba8960f80a9

阅读全文
0 0
原创粉丝点击