Android开发——在Github上面创建自己的开源库

前言

很多开发的小伙伴都有使用过Github上面的开源库,那么我们应该怎么创建我们的开源库呢?下面分享一下我的心得。让我们跟着这篇博客完成一个开源库的从0到1吧!

创建一个Android开源库

1.注册一个Github账号

【传送门】https://github.com/
在这里插入图片描述

2.Android studio创建一个项目

在这里插入图片描述

3.在项目里面创建Android Library

在这里插入图片描述
选择图中第二个类型,名称自定义。这里我命名是relyontest,意思是依赖测试。完成效果如下图:
在这里插入图片描述
1.在Project的build.gradledependencies{}代码块中加入以下代码

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

2.在Model的build.gradle中加入使用插件代码:

apply plugin:'com.github.dcendents.android-maven'
4.抒写你的开源类和开发源方法

我这不去细写开源类和开源方法。我这里定义LogUtils类,主要功能是进行Logcat打印,方便我们开发中使用到,简单的演示一下。源码如下:

package com.wyb.relyontest;

import android.util.Log;

/**
 * 类说明:Log工具类,打印开发中打印错误的日志
 * @author wuyubo
 */
public class LogUtils {
    
    private static final String TAG = "TAG";
    
    public static void showLog(String msg){
        Log.e(TAG,msg);
    }
}
5.配置git的忽略文件

在这里插入图片描述

5.将上面上传Gthub

由于没有办法截图,我们点击Android studio头部栏的VCS->import into Version Control->Share Project on Github这样就可以让Android studio链接我们的Github了,你之前没有登录的情况下就会弹出登录框给你。你登录之后就会,显示下图中的框:
在这里插入图片描述
完成所有的填写就可以按下share键。就会出现平时我们提交代码的界面,界面如下
在这里插入图片描述
提交完成之后,我们就可以在我们的注意看到我们的开源库啦!别急还没有完成哟,我们还有操作其他东西。小伙伴们,请往下看…

6.配置开源证书

在这里插入图片描述
图中右边这种就是Github的开源许可证书,现在在Github上面创建项目都会建议配置开源许可证书。那么有什么常见的开源许可证书呢?下面3种是配置比较多的:

  • Apache License 2.0
  • GNU General Public License v3.0
  • MIT License
    我们就以博客中的测试项目为例,我们给它配置一个开源许可证书。首先:我们创建一个新的文件
    在这里插入图片描述
    文件名称是LICENSE,右边就会出现Choose a license template,如下图所示
    在这里插入图片描述
    点击Choose a license template按钮跳转协议配置界面,界面如下图所示,我们选择Apache License 2.0
    在这里插入图片描述
    点击图中的review and submit按钮返回上一个界面,上一个界面我们需要选择提交才会生效。
    在这里插入图片描述
    上图说明:
  • 选择1:Commit directly to the master branch.
  • 选择2:Create a new branch for this commit and start a pull request.
    选择 1所示的内容,则直接将此许可证提交到master分支;选择 2 所示的内容,则是新建立一个分支,然后我们可以提PR到master,再进行合并。在此,我们选择 标注 1 所示的内容,直接将MIT License提交到master分支。
    完成之后的界面,红框中的就是我们的选择的开源证书:
    在这里插入图片描述
7.发布依赖版本

在这里插入图片描述
点击图中的releases选项跳转版本发布界面,界面如下:
在这里插入图片描述
点击图中Create a new release按钮,就会跳转发布版本详情界面,界面如下:
在这里插入图片描述
点击图中的Pubish release按钮就能确定发布完成,跳转界面如下:
在这里插入图片描述

8.打包生成依赖

【传送门】https://jitpack.io ,这个是开源库打包生成依赖的网站。
1.将Github仓库地址复制,地址显示在
在这里插入图片描述
2.将地址放到打包网站中,生成依赖地址
在这里插入图片描述
我们拿到图中的地址就能进行依赖使用啦!!!

9.使用我们的开源库

1.在Project中的build.gradle文件allprojects{}repositories{}代码中加入下面配置代码:

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

2.在Model中的build.gradle文件dependencies{}中加入我们开源的依赖地址:

 implementation 'com.github.wuyubo0522:relyontest:1.0.0'

使用成功界面,我们能看到我们的开源库
在这里插入图片描述

总结

这个是为了帮助小伙伴们了解做一个开源库的过程,这是应该是我第二个开源库。我昨晚为了搞一个自己的开源库搞到凌晨3点多,完成那一刻是超级惊喜的。我心中开心到爆炸,我终于有自己的开源库啦!!!上面是我开源库的从零到一的心得,希望能帮助开发的小伙伴们拥又一个自己的开源库。

鸣谢

感谢网上写Github开源库有关博客的哥们,感谢他们的博客对我的帮助,下面放置博客链接有兴趣的小伙伴可以去看看。

  1. https://blog.csdn.net/qq_35246620/article/details/77647234 开源许可证有关配置
  2. https://blog.csdn.net/u012661010/article/details/73433872/ 开源库的创建
  • 3
    点赞
  • 9
    收藏
    觉得还不错? 一键收藏
  • 2
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值