将自己的工程开源到GitHub---转载记录保存

2024-09-05 01:58

本文主要是介绍将自己的工程开源到GitHub---转载记录保存,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

1.1 工程中创建Module

  最开始你可能自己写了个工程,感觉不错,进行了一定的封装和优化,想留作开发下一个App时用或者给别人用。但是每次复制粘贴代码显得繁琐,还要处理一堆的package name和import错误。于是你想着把它改造成独立的工程,每次整个工程复制进去,设置引用就可以了。这就要使用Android Studio的module了。以前,你的工程只有一个Module,就是(Module: app)。现在你需要新建一个Module,如图所示:

在工程名上右键–>New–>Module, 
   
   
选择Android Library–>Next,   
    

给库取名,比如xxxLibrary,我这里叫OrangeRetrofit。 
    

1.2 将核心代码移植到Module

  接下来要做的是,把原先在工程的(Module: app)中的核心代码移到(Module:OrangeRetrofit)中。比如这里将网络请求框架的封装全部移到(Module:OrangeRetrofit)中,(Module: app)中只剩下UI相关以及封装后的网络请求框架的使用。移植过程中尤其要注意的一点是,不要把Application移过去。那么之前很多写在Application中的通用方法怎么办?比如在Application中定义了这样一个方法。

public static void runOnUiThreadDelayed(Runnable task, long miliis) {mainHandler.postDelayed(task, miliis);
}



  解决办法是,在Module中新增一个静态类,我这里就叫OrangeRetrofit,用于完成Application的职责。OrangeRetrofit静态类中有一个init方法,要求使用这个库的人必须在Application的onCreate方法中调用一次OrangeRetrofit.init(this),把context传进来。

public static void init(Context context) {if (null != context) {appContext = context;
}


  是不是有种似曾相识的感觉?使用友盟SDK时,要求你在Application的onCreate方法中调用一次PushAgent.getInstance(this); 使用百度地图SDK时,要求你在Application的onCreate中调用一次SDKInitializer.initialize(this)。这些都是为了实现类似的功能,那就是传递app context。这样你在库中,没有Application,也可以随意得Toast,随意地getVersionName()。又因为OrangeRetrofit是个静态类,所以在调用OrangeRetrofit.init(this)时就会加载这个类,也就是在Application初始化时,app context就会传进去,OrangeRetrofit类里的静态块会比别的类和方法先执行。这样,OrangeRetrofit之于库(Module:OrangeRetrofit)就非常类似Application之于工程(Module: app)。

1.3 导入Module

  上述步骤都完成了,并且调试通过后,你可能想在另一个工程中使用它。在工程中导入Module很简单:

  1. 把整个module文件夹复制到工程的根目录
  2. 在工程的settings.gradle中增加对module的引用。 
      由include ‘:app’变成include ‘:app’, ‘:orangeretrofit’
  3. 在工程的主module (Module: app)中增加对库module的引用 
      compile project(path: ‘:orangeretrofit’)
      配置好后,gradle synchronize一下就可以使用了。

2.1 把自己的库上传到Github开源

  这个就和上传普通的代码到Github一摸一样了,在我的例子中,我上传的是包含(Module: app)和(Module:OrangeRetrofit)的整个工程。

  1. 在github上新建一个repository,然后你会得到一个类似https://github.com/xxxx/xxxx.git这样的URL
  2. 在Android Studio的命令行中执行git init,或者打开windows的命令行,cd到要上传的工程根目录下,或者在工程根目录右键Git Bash here(如果你安装了GitExtension的话)执行相同的命令;
  3. 执行git remote add origin https://github.com/xxxx/xxxx.git,记得改成你自己的URL

  这样你就把本地工程和Github上的repository关联起来了,就可以愉快地pull和push了。这里省略了很多细节,比如,建议写一个Markdown格式的自述文件README.md;再如,上述第2、3步可以在Android Studio的图形界面完成,这里不再赘述。对Git命令操作不熟悉的可阅读这篇翻译贴Git详解之三 Git分支

3.1 Release Github project

  在2.1中上传到Github上的项目别人可以看到、下载、仿照、修改、整合到自己项目中,但是依然需要复制粘贴,并不能直接依赖。继续

点击releases 
   
   
按照右边的英文提示填写版本信息和描述,然后点击Publish Release一键发布。 
  

看到这样的页面表示发布成功。

3.2 添加到JitPack

  打开JitPack官网https://jitpack.io/,在输入框中粘贴刚刚在Github上Release的项目的地址。 
  点击Look up然后在弹出的输入框中点击Get it 完成库的生成。我上传的是整个工程,但是这里它可以自动识别出工程中的库module。 
 
  然后就看到我们熟悉的添加依赖的指导了,把Gradle和Maven的添加依赖的指导复制到Github上库项目的自述文件README.md中,告诉别人怎么用你的库。 


3.3 测试库依赖

  自己新建一个工程,在主module的build.gradle中的dependencies节点中加入依赖

dependencies{...//其他依赖compile 'com.github.ashima0512:OrangeRetrofitDemo:v1.0.0'
}


  gradle synchronize一下,在工程中调用库中的任意一个API,如果只提示导包,而不是报错,则表示添加依赖成功。记得实际使用时,在Application的onCreate方法中调用OrangeRetrofit.init(this)。文中示例库OrangeRetrofit的源码可在Github上查看。

原文链接:https://blog.csdn.net/hmh0512/article/details/53818058

这篇关于将自己的工程开源到GitHub---转载记录保存的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1137646

相关文章

Ilya-AI分享的他在OpenAI学习到的15个提示工程技巧

Ilya(不是本人,claude AI)在社交媒体上分享了他在OpenAI学习到的15个Prompt撰写技巧。 以下是详细的内容: 提示精确化:在编写提示时,力求表达清晰准确。清楚地阐述任务需求和概念定义至关重要。例:不用"分析文本",而用"判断这段话的情感倾向:积极、消极还是中性"。 快速迭代:善于快速连续调整提示。熟练的提示工程师能够灵活地进行多轮优化。例:从"总结文章"到"用

阿里开源语音识别SenseVoiceWindows环境部署

SenseVoice介绍 SenseVoice 专注于高精度多语言语音识别、情感辨识和音频事件检测多语言识别: 采用超过 40 万小时数据训练,支持超过 50 种语言,识别效果上优于 Whisper 模型。富文本识别:具备优秀的情感识别,能够在测试数据上达到和超过目前最佳情感识别模型的效果。支持声音事件检测能力,支持音乐、掌声、笑声、哭声、咳嗽、喷嚏等多种常见人机交互事件进行检测。高效推

金融业开源技术 术语

金融业开源技术  术语 1  范围 本文件界定了金融业开源技术的常用术语。 本文件适用于金融业中涉及开源技术的相关标准及规范性文件制定和信息沟通等活动。

安全管理体系化的智慧油站开源了。

AI视频监控平台简介 AI视频监控平台是一款功能强大且简单易用的实时算法视频监控系统。它的愿景是最底层打通各大芯片厂商相互间的壁垒,省去繁琐重复的适配流程,实现芯片、算法、应用的全流程组合,从而大大减少企业级应用约95%的开发成本。用户只需在界面上进行简单的操作,就可以实现全视频的接入及布控。摄像头管理模块用于多种终端设备、智能设备的接入及管理。平台支持包括摄像头等终端感知设备接入,为整个平台提

K8S(Kubernetes)开源的容器编排平台安装步骤详解

K8S(Kubernetes)是一个开源的容器编排平台,用于自动化部署、扩展和管理容器化应用程序。以下是K8S容器编排平台的安装步骤、使用方式及特点的概述: 安装步骤: 安装Docker:K8S需要基于Docker来运行容器化应用程序。首先要在所有节点上安装Docker引擎。 安装Kubernetes Master:在集群中选择一台主机作为Master节点,安装K8S的控制平面组件,如AP

Node.js学习记录(二)

目录 一、express 1、初识express 2、安装express 3、创建并启动web服务器 4、监听 GET&POST 请求、响应内容给客户端 5、获取URL中携带的查询参数 6、获取URL中动态参数 7、静态资源托管 二、工具nodemon 三、express路由 1、express中路由 2、路由的匹配 3、路由模块化 4、路由模块添加前缀 四、中间件

MiniGPT-3D, 首个高效的3D点云大语言模型,仅需一张RTX3090显卡,训练一天时间,已开源

项目主页:https://tangyuan96.github.io/minigpt_3d_project_page/ 代码:https://github.com/TangYuan96/MiniGPT-3D 论文:https://arxiv.org/pdf/2405.01413 MiniGPT-3D在多个任务上取得了SoTA,被ACM MM2024接收,只拥有47.8M的可训练参数,在一张RTX

记录每次更新到仓库 —— Git 学习笔记 10

记录每次更新到仓库 文章目录 文件的状态三个区域检查当前文件状态跟踪新文件取消跟踪(un-tracking)文件重新跟踪(re-tracking)文件暂存已修改文件忽略某些文件查看已暂存和未暂存的修改提交更新跳过暂存区删除文件移动文件参考资料 咱们接着很多天以前的 取得Git仓库 这篇文章继续说。 文件的状态 不管是通过哪种方法,现在我们已经有了一个仓库,并从这个仓

HomeBank:开源免费的个人财务管理软件

在个人财务管理领域,找到一个既免费又开源的解决方案并非易事。HomeBank 正是这样一个项目,它不仅提供了强大的功能,还拥有一个活跃的社区,不断推动其发展和完善。 开源免费:HomeBank 是一个完全开源的项目,用户可以自由地使用、修改和分发。用户友好的界面:提供直观的图形用户界面,使得非技术用户也能轻松上手。数据导入支持:支持从 Quicken、Microsoft Money

如何提高 GitHub 的下载速度

如何提高 GitHub 的下载速度 文章目录 如何提高 GitHub 的下载速度1. 注册账号2. 准备好链接3. 创建仓库4. 在码云上下载代码5. 仓库更新了怎么办 一般来说,国内的朋友从 GitHub 上面下载代码,速度最大是 20KB/s,这种龟速,谁能忍受呢? 本文介绍一种方法——利用“码云”,可以大大提高下载速度,亲测有效。 1. 注册账号 去“码云”注册一