发布新手的第一个开源库－快速发布开源库到JitPack

  
前言:

  
之前在JCenter上发布了个开源库,各种配置挺麻烦的,但折腾之后还是总算没出错成功弄好了,有兴趣的看一下顺手点个star:多达288种动态效果的侧滑菜单开源库,满足您项目的各种需求.但是准备弄第二个的时候虽然上传成功,后台也能看到文件了,但是添加依赖之后只有资源文件没有代码,很是郁闷.问了群里的大神之后大神推荐使用JitPack,研究了下确实挺简单的,就是配置的时候因为百度到的东西都是过时的,走了一点弯路,现在解决了顺便做个记录,防止再次踩坑.

  
关于将代码弄成开源库我这边是这样考虑的,如果做开发做个一段时间的同学都应该会有自己的"快速开发框架",听起来高大上但我的意思是指自己平时收集的代码和写的base等业务无关的代码,如果你还没有这样的东西,那你应该尝试着来做一下.这样在开发其他项目的时候以module引入将会减少很多简单代码的书写.另外一点考虑是以开源库的形式使用module在构建项目的时候是非常快的,而且如果以导module的形式那一旦有更改就得重新导一遍.所以将自己"积攒"的代码做成一个库是一个很明智的选择,当然如果你的代码特别的好,分享给其他人用也是很好的.好了.废话就这么多,下面开始正题:

  
JitPack官网地址:[JitPack](https://jitpack.io/)


  
下面就新建一个测试开源库然后一步步演示如何发布并使用一个开源库

  
1.首先用Android Studio新建一个工程,添加要发布的module


  
这里说一点命名的问题,一般来说要分享一个module,会给module起个简洁的名字,然后管理module会起一个长一点的名字,比如module叫Test,项目名称叫TestDemo,这样如果是上传JCenter完全没问题,引用的时候还是引用的Test,但是在JitPack上面就会变成要引用TestDemo了,虽然内容是只有Test的内容,但是看着很奇葩啊,所以大家注意把项目名称起好一点,module随意.

  
这一步结果如图:项目名叫Test,存放开源库内容的module叫TestModule(AS显示的时候是忽略大小写的)

  


   


    


    

     
    

   

   

    这里写图片描述
   

  

  
2.书写开源库内容

  
这一步没啥说的,要开源什么就写什么呗.我这边就写个BaseActivity一会测试依赖是否成功.

  
这一步结果如下:

  


   


    


    

     
    

   

   

    这里写图片描述
   

  

  
3.在项目的build.gradle内添加内容

  
位置如下:

  


   


    


    

     
    

   

   

    这里写图片描述
   

  

  
添加一句

  
classpath 'com.github.dcendents:android-maven-gradle-plugin:1.4.1'

  
注意:这一步是添加maven的构建插件,后面的版本号要是最新的.因为我之前网上搜的都是1.3,然后后面的步骤总是报错不成功,所以建议写最新的,查看最新版本去它的Github上看:android-maven-gradle-plugin
  
原本内容如下:
  
buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:2.2.0-beta1'
        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
    }
}

  
添加后的内容如下:
  
buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:2.2.0-beta1'
        classpath 'com.github.dcendents:android-maven-gradle-plugin:1.4.1'
        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
    }
}

  
添加之后会有提示让你Sync,按提示同步一下
  

   

    

    

     
    
   
   

    这里写图片描述
   
  
  
4.在要开源的module的build.gradle下添加内容
  
位置如下:
  

   

    

    

     
    
   
   

    这里写图片描述
   
  
  
内容在头部添加,原本的内容是这样的
  
apply plugin: 'com.android.library'
...

  
添加后的是这样的
  
apply plugin: 'com.android.library'
apply plugin: 'com.github.dcendents.android-maven'
group='com.github.Brioal' //Brioal替换成你自己的Github用户名
...

  
现在又会出现提示Sync,再次同步
  
如果没有出错的话本地的配置基本已经成功了
  
接下来要将这个项目放到Github上,这大家应该都会,但我还是演示下如何用AS快速发布
  

   

    

    

     
    
   
   

    这里写图片描述
   
  
  
如果AS还没配置过Github的话点击这个会让你设置Github帐号,我这边已经用过所以直接验证密码就行
  

   

    

    

     
    
   
   

    这里写图片描述
   
  
  
注:这些操作的前提是Git已经配置好了,如果Git没有配置好这一步会出错,建议百度先把Git搭建好
  
上传成功之后会在Github上看到刚刚上传的项目
  

   

    

    

     
    
   
   

    这里写图片描述
   
  
  
5.给项目添加一个Tag
  
点击如图所示位置:
  

   

    

    

     
    
   
   

    这里写图片描述
   
  
  
显示没有Tag,然后点击新建
  

   

    

    

     
    
   
   

    这里写图片描述
   
  
  
我这就随便填个
  

   

    

    

     
    
   
   

    这里写图片描述
   
  
  
点击下方的Publish即可完成创建,成功之后界面如下
  

   

    

    

     
    
   
   

    这里写图片描述
   
  
  
现在我们的开源库已经可以被使用了,这时候应该获取使用的方式并添加到readme中
  
打开JitPack主页,将你的项目的Gihub地址复制到这并点击look up
  

   

    

    

     
    
   
   

    这里写图片描述
   
  
  
如果前面没有问题的话现在可以看到我们之前写的Tag号,点击get
  

   

    

    

     
    
   
   

    这里写图片描述
   
  
  
会自动跳转到使用方式,如下:
  

   

    

    

     
    
   
   

    这里写图片描述
   
  
  
步骤已经很详细了,现在我就来新建个项目测试一下
  
直接跳过新建项目
  
1.第一步在项目的build.gradle下配置
  
位置如下:
  

   

    

    

     
    
   
   

    这里写图片描述
   
  
  
allprojects {
        repositories {
            ...
            maven { url "https://jitpack.io" }
        }
    }

  
第二部,在app的build.gradle下添加如下
  
dependencies {
            ...
            compile 'com.github.Brioal:Test:1.0'
            ...
    }

  
会提示Sync,按提示同步一下
  
测试依赖是否成功
  

   

    

    

     
    
   
   

    这里写图片描述
   
  
  
测试成功.完毕~~~
 


作者：Brioal
链接：https://www.jianshu.com/p/f1b2ad4c507a
來源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

为什么写

看见标题有人可能会轻蔑一笑，多简单个事？还至于专门写一篇文章吗？

我之前也以为挺简单的，因为之前自己也上传过，但是前几天的经历告诉我没有那么简单，特别是现在安卓 Gradle 升级到 7.0 之后。。。

还可能有人问为什么要在 JitPack 上创建呢？JCenter 、Maven 不香嘛？

因为我之前就在 JitPack 上创建过依赖，有点经验，所以选择这个，至于JCenter ，可能大家也知道，直接看官网吧：

懂了吧。。。

为啥没选 Maven 呢。。。因为我没想到 JitPack 变得这么麻烦，本来是奔着简单才选的，如果再给我一次机会我一定不上传 JitPack 了。。。好了，废话不多说，直接进入文章主题吧：

流程

上传依赖到 JitPack 流程很简单，网上搜博客一搜一大堆，这里就不详细说了，我简单过一下吧：

创建 Android Library

首先要创建一个 Android Library ，这其实是废话，你要上传的就是依赖不创建 Android Library 创建啥？对不。。。然后在里面写好你需要作为依赖的代码，比如写一些工具类啊啥的，这个看自己的需要吧，就不做演示了。。。

上传到 Github

代码写完了就该上传到 Github 了。什么？你没有 Github 仓库？码云的也可以。什么？都没有？玩蛋去。。

这里就假设你有 Github 了，然后在 as 中登录一下，按照图片下面的操作直接添加你的账号就行了：

添加完了之后按照下面图片中那样点击：

点击完之后会弹出下面的对话框：

注意不要勾选 Private ，勾选了的话你上传的就成了私有的了。

打 Release 包

上传成功之后打开 Github 网页点击下面图片中箭头所指的地方开始打包：

点击完之后按照下面的格式填写信息：

第一个框是版本号，第二个框是标题，第三个框是描述，根据个人情况填写就行，填写完之后点击绿色按钮进行发布就行了。

JitPack 发布

这里就很简单了，打开 JitPack 官网：https://jitpack.io/

这块有两个选择，通过右上角登录你的 Github 账号或者在搜索框搜索你刚才上传库的地址，都可以，自己选择，选择之后点击 Look up 会出现如下：

点击 Get it 静静等待即可。

使用依赖

上面完成之后直接就可以使用了，现在工程级目录下的 build.gradle 中添加如下代码：

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

然后在你的 module 级目录下的 build.gradle 中添加如下代码：

	dependencies {
	        implementation 'com.github.zhujiang521:Banner:Tag'
	}

其实这块网页中都写的有：

问题

本来不想写上面这一堆，但是感觉不写也不对，大家理解起来可能有困难，所以就写了下。

如果是在去年，上面的一套流程完全没有问题，但是在现在，上面的流程。。。不对。

AndroidMavenPlugin 的问题

为什么说不对呢？如果你现在按照上面的流程走的话，在 JitPack 发布那一块你肯定会失败，就是 Get it 失败，就像下面这样：

错了不要紧，看看日志错在哪了，点击那个小书的标签，进入日志，发现报错信息如下：

FAILURE: Build failed with an exception.

* Where:
Script '/script/maven-plugin.gradle' line: 2

* What went wrong:
A problem occurred evaluating script.
> Failed to apply plugin 'com.github.dcendents.android-maven'.
   > Could not create plugin of type 'AndroidMavenPlugin'.
      > Could not generate a decorated class for type AndroidMavenPlugin.
         > org/gradle/api/publication/maven/internal/MavenPomMetaInfoProvider

呃呃，这是啥？AndroidMavenPlugin ？Google 了之后才知道 JitPack 使用的就是 AndroidMavenPlugin 来发布依赖的，OK，既然这个东西有问题，那就来看看怎么加上吧：

classpath 'com.github.dcendents:android-maven-gradle-plugin:2.1'

OK，再次提交代码，打 release 包，然后去 JiaPack 网站点 Get it ，发现依然报这个错。。。

什么鬼。。。

又去 Github 搜索了下 android-maven-gradle-plugin ，发现人家这个库已经废弃了。。。

上面废弃库指向的是安卓官方文档。。。这又是什么鬼。。。也没人告诉我啊！！！

过程有多艰难这里就不进行描述了，在下面我会简单说下。经过一番搜索，发现。。。发现我就是个憨批。。。使用 JitPack 不跟着人家官方文档来，跟什么别人的博客？其实大家以后也是，能看官方文档就别看三方写的东西，出错了都不知道为啥。。。来看下吧：

官方文档中清清楚楚、明明白白地写着需要配置Gradle插件我不配置偏偏要去百度上面出现的错误！！！真的是。。。憨批！

来吧，看下安卓的文档吧：https://developer.android.com/studio/build/maven-publish-plugin

详细内容大家去官网看吧，这里直接写下解决问题的代码吧：

plugins {
    id 'com.android.library'
    id 'kotlin-android'
    id 'maven-publish'
}

afterEvaluate {
    publishing {
        publications {
            release(MavenPublication) {
                from components.release
                groupId = 'com.zj.banner'
                artifactId = 'banner'
                version = '1.0.0'
            }
        }
    }
}

OK，提交代码，打 release 包，然后再去 JiaPack 网站点 Get it ，大部分人应该就可以成功了，但是。。。我的还是不行的。。。

Java 11 的问题

为啥还是不行呢？不要紧，看看日志错在哪了，点击那个小书的标签，进入日志，发现报错信息如下：

FAILURE: Build failed with an exception.

* Where:
Build file '/home/jitpack/build/app/build.gradle' line: 2

* What went wrong:
An exception occurred applying plugin request [id: 'com.android.application']
> Failed to apply plugin 'com.android.internal.application'.
   > Android Gradle plugin requires Java 11 to run. You are currently using Java 1.8.
     You can try some of the following options:
       - changing the IDE settings.
       - changing the JAVA_HOME environment variable.
       - changing `org.gradle.java.home` in `gradle.properties`.

嗯。。。这是什么情况？

其实上面也提到过，Android Gradle 在升级到 7.0 之后就必须使用 Java 11 以及之后的版本才可以，而我目前使用的是 Java 1.8。

嗯，既然需要 Java 11 那就升级下，改下 module 级 build.gradle 中的代码：

android {
    ...
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_11
        targetCompatibility = JavaVersion.VERSION_11
    }

    kotlinOptions {
        jvmTarget = '11'
        useIR = true
    }
}

大家要注意，每次修改完代码都需要先把代码 push 到 Github 中，然后重新按照上面的步骤打一个 release 包，再去 JitPack 网页中点击你打的包的那个版本的 Git it 才行。

提交完了之后执行，发现。。。竟然还在报错，报的还是这个错！这是什么玩意？

其实我在这块卡了很久，一直以为是我本地的代码问题，但后来想明白应该是 JitPack 的问题，因为本地运行是没有任何问题的。

想清楚这一点，我来到了 JitPack 的 Github 仓库，点开了仓库的 Issues ，直接搜索 Java 11，果然，找到了这个问题：

上面的图片中有个 JitPack 的帮助文档，点击打开：

但之前其实还有个疑问，我在代码中国呢已经设置了 Java 的版本，为什么还是报错呢？看上面的图片大家应该也已经知道了，JitPack 默认使用的是 OpenJDK Java 8 编译项目，但是咱们需要 Java 11 ，你必须按照上面那样在根目录添加一个 jitpack.yml 文件才可以，OK，那就添加吧：

before_install:
  - sdk install java 11.0.10-open
  - sdk use java 11.0.10-open

jdk:
  - openjdk11

再次提交代码，打 release 包，然后去 JiaPack 网站点 Get it ，发现依然报这个错。。。

我的天，我当时真的不知道该怎么搞，以为我 jitpack.yml 这个文件格式写的有问题 JitPack 识别不出来？还是别的什么问题？然后改来改去改了几十遍。。。为什么我知道是几十遍呢？下面是我的提交记录：

这只是其中一部分，下面是我 Github 的一部分提交记录：

看到上面的提交记录，你就应该能明白当时我的无助。。。。

索性不管了，明天再说吧。。。

然而，奇怪的事情发生了，第二天我再次使用相同版本进行 Get it 的时候，虽然还是失败，但是问题竟然变了！！！什么鬼？看下日志：

Kotlin:       1.4.31
Groovy:       3.0.7
Ant:          Apache Ant(TM) version 1.10.9 compiled on September 27 2020
JVM:          11.0.2 (Oracle Corporation 11.0.2+9)
OS:           Linux 4.14.63-xxxx-std-ipv6-64 amd64

通过日志可以看到 Java 已经设置为了 11 ，我的天，昨天搞了一天这玩意没成功，其实已经成功了，我估计是 JitPack 中有缓存。。。害死我了。。。

OK，再次提交代码，打 release 包，然后去 JiaPack 网站点 Get it ，然后就是漫长的等待。。。

终于， Git it 按钮变为了绿色，成功了。。。

总结

没什么好总结的，因为感觉自己脑子不够用，遇到问题首先想到的一直是复制错误去百度、去 Google ，从来没想着去最权威的东西——官方文档，老想着别人可能也遇到过这个问题，直接去拿现成的，这是个不好的习惯，得改。

希望大家能以此为戒，努力，共勉。