Android开发：如何将工程改造成库，并上传到Github作为依赖，提供引用

注：本文适合使用Android Studio的开发者

在Android项目中经常需要依赖使用别人开发的第三方依赖库，使开发更加方便。比如我下面用到的几个依赖库：

那么这些依赖库是怎么制作的呢，在这篇文章中介绍其中一种比较常见的方法，主要分为三个步骤：

1. 在Android Studio中将普通工程改造成库
2. 将改造后的库上传到Github
3. 在jitpack登记(注：在jitpack登记时，一定要登录自己的账号，可以注册，也可以使用GitHub授权登录)
4. 将库作为依赖被自己的其他项目或别人使用

 

1. 工程中创建Module

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

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

　　　　

 给库取名，比如xxxLibrary，我这里叫testLibrary。 

 

2. 将核心代码移植到Module

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

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

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

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

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

3. 导入Module

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

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

 

4. 把自己的库上传到Github开源

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

a.在github上新建一个repository，然后你会得到一个类似https://github.com/xxxx/xxxx.git这样的URL
b.在Android Studio的命令行中执行git init，或者打开windows的命令行，cd到要上传的工程根目录下，或者在工程根目录右键         Git    Bash here（如果你安装了GitExtension的话）执行相同的命令；
c.执行git remote add origin https://github.com/xxxx/xxxx.git，记得改成你自己的URL
　　这样你就把本地工程和Github上的repository关联起来了，就可以愉快地pull和push了。这里省略了很多细节，比如，建议写一个Markdown格式的自述文件README.md；再如，上述第b、c步可以在Android Studio的图形界面完成，这里不再赘述。

 

5. Release Github project

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

点击releases 

 

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

 

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

 

 6. 添加到JitPack

打开JitPack官网https://jitpack.io/，然后一定要登录自己的账号，可以GitHub授权登录。在输入框中粘贴刚刚在Github上Release的项目的地址。 
　　点击Look up然后在弹出的输入框中点击Get it 完成库的生成。我上传的是整个工程，但是这里它可以自动识别出工程中的库module。 

 

 

然后就看到我们熟悉的添加依赖的指导了，把Gradle和Maven的添加依赖的指导复制到Github上库项目的自述文件README.md中，告诉别人怎么用你的库。

 

7. 测试库依赖

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

Step 1. Add it in your root build.gradle at the end of repositories:

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

Step 2. Add the dependency

	dependencies {
	         implementation 'com.github.XiaoWuLibs:FastSharepreference:v1.0.0'
}
	}

　　gradle synchronize一下，在工程中调用库中的任意一个API，如果只提示导包，而不是报错，则表示添加依赖成功。文中示例库源码可在Github上查看,地址：https://github.com/XiaoWuLibs/FastSharepreference