如何制作开源依赖库上传至GitHub供他人使用

背景

在项目开发中经常会使用别人的第三方依赖库&＃xff0c;在之前的Eclipse时代&＃xff0c;基本都是通过拷贝jar包引入到工程中去使用。现如今大部分 Android开发者都开始使用Android Studio工具进行开发&＃xff0c;只需要在项目下的build.gradle文件中添加依赖&＃xff0c;就可以完成第三方依赖库的引用。

大多数情况都是使用别人的依赖库&＃xff0c;那么我们为什么就不能考虑自己也写个依赖库让别人使用呢&＃xff1f;在此前&＃xff0c;我们需要知道如何才能将自己的库上传给别人使用。以下我就介绍一种上传到JitPack让别人使用的方式。

集成

1、创建一个Library库

在创建的Project工程中新建一个Module&＃xff1a;

项目工程右键 -> New -> Module -> Android Library -> 给库命名如ToastLibrary

然后我们就可以创建一个Module。

2、在新建的Module中添加需要提供的依赖文件

我们在这里添加了一个自定义的吐司工具类ToastUtil。

注意&＃xff1a;如果我们已经有了项目工程时需要将其打包成依赖库&＃xff0c;那么就需要将原工程中的核心代码转移到Module中&＃xff0c;比如一些接口、工具类、公共的封装类等&＃xff0c;原工程只保留UI相关以及封装框架的使用。尤其要注意的一点是不要将Application移过去&＃xff0c;如果在Application中已经写了一些通用的方法&＃xff0c;如定义了如下方法&＃xff1a;

public static void runOnUiThread(Runnable task) {mainHandler.post(task);
}

解决方法是在Module中新增一个静态类&＃xff0c;比如我这里命名是ToastInitializer&＃xff0c;它用于完成Application的职责。ToastInitializer静态类中有一个initializer方法&＃xff0c;要求在使用这个依赖库时必须在Application的onCreate方法中调用一次ToastInitializer.initializer(this)把Context传进来。

public static void initializer(Context context) {if (null !&＃61; context) {appContext &＃61; context;}
}

其实这样的方式我们在使用依赖库时大部分都有遇到过。使用友盟推送SDK时&＃xff0c;要求你在Application的onCreate方法中调用一次PushAgent.getInstance(this)&＃xff1b;使用百度地图SDK时&＃xff0c;要求你在Application的onCreate方法中调用一次SDKInitializer.initialize(this)&＃xff1b;是不是感觉似曾相识&＃xff1f;这些都是为了实现类似的功能&＃xff0c;那就是传递app context。这样你在库中即使没有Application也可以随意使用app context来进行一些操作。又因为ToastInitializer是个静态类&＃xff0c;所以在调用ToastInitializer.initializer(this)时就会加载这个类&＃xff0c;也就是在Application初始化时app context就会传进去&＃xff0c;ToastInitializer类里的静态块会比别的类和方法先执行。

如果需要在原工程中引用库中的方法&＃xff0c;需要在原工程的build.gradle中添加如下内容&＃xff1a;

dependencies {compile project(path: &＃39;:toastlibrary&＃39;)
}

其中toastlibrary是你的类库名称。

3、上传依赖库至GitHub

当Library库完成后需要将其上传至GitHub中&＃xff0c;具体上传方式见我另一篇博客Android Studio中Git的使用。

4、Releases Github Project

在GitHub中打开提交的依赖库&＃xff0c;点击releases -> 创建新版本Create a new release -> 填写版本号、发布标题、版本描述&＃xff0c;然后进行推送版本Publish release。

看到以下这样的页面表示推送成功。

5、添加到JitPack

打开JitPack官网 https://jitpack.io/ 地址&＃xff0c;输入GitHub中对应的项目地址&＃xff0c;点击Look up在查询得到的版本中点击需要版本号的Get it完成依赖库的生成。

然后就可以看到使用方法了&＃xff0c;接下来就可以按照它的使用方法在我们的项目上使用这个依赖库了。

6、项目中集成依赖库

在项目根目录的build.gradle添加以下代码&＃xff1a;

allprojects {repositories {jcenter()maven { url &＃39;https://jitpack.io&＃39; }}
}

在app目录的build.gradle添加依赖引用&＃xff1a;

dependencies {compile &＃39;com.github.wiggins9629:Toast:v1.0.1&＃39;
}

如果依赖库需要app context来进行一些初始化操作&＃xff0c;那么还需要在项目Application中的onCreate方法中添加ToastInitializer.initializer(this)来传递app context&＃xff1a;

public class MyApplication extends Application {&＃64;Overridepublic void onCreate() {super.onCreate();ToastInitializer.initializer(this);}
}

至此我们就完成项目依赖库的集成了&＃xff0c;可以在项目中调用依赖库的方法了。

public class MainActivity extends BaseActivity implements View.OnClickListener {private TextView mTvToast;&＃64;Overrideprotected void onCreate(Bundle savedInstanceState) {super.onCreate(savedInstanceState);setContentView(R.layout.activity_main);initView();setListener();}private void initView() {mTvToast &＃61; (TextView) findViewById(R.id.tv_toast);}private void setListener() {mTvToast.setOnClickListener(this);}&＃64;Overridepublic void onClick(View v) {switch (v.getId()) {case R.id.tv_toast:ToastUtil.showText("测试Toast依赖库的集成");break;}}
}

需要注意的是可能会出现离线的问题&＃xff0c;需要设置一下非离线状态&＃xff0c;把Offline work给去掉&＃xff0c;再同步一次工程就可以了。

以上就是通过Android Studio制作开源依赖库上传至GitHub供他人集成使用的过程&＃xff0c;希望能给大家带来帮助&＃xff01;

下面是此依赖库的项目工程&＃xff0c;欢迎大家参考指教。

项目地址 ☞ 传送门