JitPack - 发布Android库

原文地址: http://tianma.space/post/667499984/

JitPack.io 是一个 JVM/Android 工程的包管理仓库。开发者可以在上面发布自己的库,一旦成功发布,就可以方便的在 Gradle 中引用。 当然了,Andriod 相关的包管理仓库除了 JitPack 之外,还有 jCenter 等,但 JitPack 应该发布起来是最简单的了。

发布 Android Library

1. Gradle

为了让 JitPack 能正确的构建 Android 工程,需要添加 android-maven-gradle-plugin 插件:

  • 如果使用的 Gradle 版本 >= 4.1 (即使用的 com.android.build.gradle 版本 >= 3.0.0):
    1. 项目根目录build.gradle 中如下配置:
      buildscript {
          dependencies {
              classpath 'com.github.dcendents:android-maven-gradle-plugin:2.0' // 添加这行配置
          }
      }
      
    2. 库工程build.gradle 中如下配置:
      apply plugin: 'com.github.dcendents.android-maven'
      group = 'com.github.YourUsername'
      
  • 如果使用的其他版本的 Gradle 配置会有所变化,因为 android-maven-gradle-pluginGradle 版本有个对应关系。具体配置和上面的相似,只不过对应版本,详情可以戳这里 android maven gradle plugin - Note on Releases

2. GitHub

在Github对应项目上发布release包或者添加一个tag,网上教程很多,略过。

3. JitPack

参照下图,将项目提交到 JitPack ,让其构建对应的工程:

提交到JitPack

点击 Get it 按钮,JitPack 会给出指定库的引用配置信息:

JitPack库的配置信息

使用 Android Library

Dependency 格式构成

发布到 JitPack 的库的 dependency 的格式如下:

  • Group(组) : com.github.Username
  • Artifact(产品) : Repository Name (Github Repo 名)
  • Version(版本) :Release 的 tag 或者 commit hash 值 或者 -SNAPSHOT

JitPack 中的 Snapshot

snapshot(快照) 版本在开发中很有用。snapshot 可以表示那些没有正式发布的版本。 指定的版本snapshot版本 区别在于后者可能可以不断的更新版本,即可能指向最新的版本。所以snapshot版本在项目开发过程中很实用。 snapshot 版本格式如下:

  • branch-SNAPSHOT (分支名-SNAPSHOT)

例如:

 compile 'com.github.Username:RepoName:master-SNAPSHOT'   
 // eg 'com.github.tianma8023:SimpleLineChart:master-SNAPSHOT'

通过添加 -SNAPSHOT 字段可以每次构建 master 分支上最新的 commit。
注意: 考虑到 Gradle 会缓存 SNAPSHOT 的版本,所以当使用 snapshot 的形式,并且有新的版本更新时,需要在 Android Studio 中通过 File -> Synchronize 进行更新和同步。

Gradle 中导入 Library

  1. 使用你的库,需要把 jitpack.io 添加入仓库列表中去,在 项目根目录build.gradle 中添加:
    allprojects {
        repositories {
            jcenter()
            maven { url 'https://jitpack.io' } // 添加这行
        }
    }
    
    注意:不要把 jitpack.io 添加到 buildscript 闭包中去。
  2. 模块build.gradle 中添加库的依赖:
    dependencies {
        // 方式1. SNAPSHOT
        compile 'com.github.Username:RepoName:branch-SNAPSHOT'
        // eg. complie 'com.github.tianma8023:SimpleLineChart:master-SNAPSHOT'
       
        // 方式2. Release Tag
        // compile 'com.github.Username:RepoName:ReleaseTag'
        // eg. compile 'com.github.tianma8023:SimpleLineChart:0.0.2'
        
        // 方式3. Commit Hash
        // compile 'com.github.Username:RepoName:CommitHash' 
        // eg. compile 'com.github.tianma8023:SimpleLineChart:015b8d6aff'
    }
    

踩坑

  1. 在导入 JitPack 的库工程的时候,会出现资源不能被获取的报错信息,但是 JitPack 上面的 Build 是成功的。这个时候,其实是是本地网络问题,因为 jitpack.io 走的是 https。 所以,可以添加网络代理,因为本身我用的 SS 科学上网的,所以在项目的 gradle.properties 文件中添加代理:
    # http
    systemProp.http.proxyHost=127.0.0.1
    systemProp.http.proxyPort=1080
    # https
    systemProp.https.proxyHost=127.0.0.1
    systemProp.https.proxyPort=1080
    
  2. 按照之前的 Punlish 流程,引用 JitPack 库之后,并不能很好的阅读源码和查看注释,这是发布前的配置问题。参考 Maven 的配置,在 build 过程中执行文档化操作即可。在 library 模块下新建 javadoc-sources-build.gradle 文件:
    // Specify encoding - 指定编码方式
    tasks.withType(JavaCompile) {
        options.encoding = 'UTF-8'
    }
    
    // Package source code - 打包源码
    task sourcesJar(type: Jar) {
        from android.sourceSets.main.java.srcDirs
        classifier = 'sources'
    }
    
    task javadoc(type: Javadoc) {
        failOnError false
        source = android.sourceSets.main.java.sourceFiles
        classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
        classpath += configurations.compile
    }
    
    // generate javadoc - 生成Javadoc
    task javadocJar(type: Jar, dependsOn: javadoc) {
        classifier = 'javadoc'
        from javadoc.destinationDir
    }
    
    artifacts {
        archives sourcesJar
        archives javadocJar
    }
    
    然后在 library 模块下的 build.gradle 引入之前的配置:
    apply from: 'javadoc-sources-build.gradle'
    
    之后按照正常发布流程即可。

参考

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,332评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,508评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,812评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,607评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,728评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,919评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,071评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,802评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,256评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,576评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,712评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,389评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,032评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,798评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,026评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,473评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,606评论 2 350

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,834评论 25 707
  • 一.榜单介绍 排行榜包括四大类: 单一框架:仅提供路由、网络层、UI层、通信层或其他单一功能的框架 混合开发框架:...
    伟子男阅读 5,240评论 0 161
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,637评论 18 139
  • 附上原文作者连接:作者:金诚 一.榜单介绍 排行榜包括四大类: 单一框架:仅提供路由、网络层、UI层、通信层或其他...
    这个美嘉不姓陈阅读 2,254评论 1 35
  • 为什么你总是做些有开头没有结未的事呢,看看你都干了什么,几号回家的了,上来几天都没调整过来,继续学习。 今天也是有...
    李红烨阅读 315评论 0 0