打造一个高逼格的android开源项目——小白全攻略 (转)

时间 2019-11-12

标签打造一个 android 开源项目攻略栏目 Android 繁體版

原文原文链接

转自：打造一个高逼格的android开源项目html

小引子

在平时的开发过程当中，咱们常常会查阅不少的资料，最常参考的是 github 的开源项目。一般在项目的主页面能看到项目的简介和基本使用，而且时不时能看到页面汇中有好多的彩色标签，看起来很酷，很专业，颇有逼格，能提高不少的好感度。java

前言

本文又是一篇很长的文章，如以前写的某篇文章同样，基本是一口气连续两三天的写。写啊写啊写，不知不觉就写了好多，其实有不少是素材图片，务必作到每一个细节我都实践一遍。linux

考虑到同窗们的时间有限，各取所需，因此按照个人惯例，首先有一篇完整版，其次，有一篇缩略版。但是此次缩略版很差作，因此综合考虑，把每一个单独的知识点拆分出来，抓住重点，尽可能让你们看的开心。android

这里须要提醒的是：ios

看了完整版就不用看精简集合了，内容都同样。完整版具备必定的连贯性。
精简版就看的清爽哈，以备本身玩的时候，快速查找相关资料和步骤。nginx

这里优先汇总下：git

范例

咱们以最流行的 android 开源项目 MPAndroidChart 为例来看看。

前两个蓝色的标签：开始两个蓝色的标签是开源项目主要贡献者 Twitter 的联系方式，点击后能够跳入到 Twitter 的主页，查看该大神的动态。
橘色的标签：是国外比较有名的开源项目网站 android-arsenal，不少开源项目都会在这里找到，有该项目的详细介绍。包含组员，版本号，github 项目基础信息等等。点击后会进入 MPAndroidChart 项目的首页，能看到有好多想知道的，不想知道的各类信息。
release蓝色的标签：点击后能进入到比较有名的 jitpack.io 对应的MPAndroidChart 页面，直接获取 MPAndroidChart 的最新版本，也能看到以前的构建历史。下面会重点介绍 jitpack.io 的使用。
绿色的标签：这个比较有意思，是当前想支持的最低版本，MPAndroidChart的最低版本是 api-8。点击后会进入到Android 2.2–2.2.3 Froyo (API level 8) 的详细介绍。这个功能是 android-arsenal 专门提供开发者使用的。下面也会有所介绍。

下面咱们将这些标签称之为徽章（shields）。

Top 30 android 开源项目徽章

咱们尝试在 github 里面搜索以 android 关键字开发语言为 java 的开源项目。

统计状况以下：

Retrofit 0
okhttp 0
Butter Knife 0
MPAndroidChart 4
Android-Universal-Image-Loader 2
glide 1
leakcanary 0
EventBus 1
picasso 0
zxing 3
iosched 0
Fresco 1
lottie-android 0
RxAndroid 3
libgdx 1
SlidingMenu 0
PhotoView 1
android-async-http 1
material-dialogs 5
AndroidUtilCode 0
androidannotations 3
Material-Animations 1
fastjson 5
ViewPagerIndicator 0
plaid 0
PocketHub 1
tinker 4
Android-CleanArchitecture 2
Android-PullToRefresh 0
MaterialDesignLibrary 1

咱们是筛选容器就是 30个，统计日期：2017年04月27日（随着时间推移，可能略微有变更）。使用标签的有 18个，未使用的有12个。使用几率大约是：60%。若是筛选容器的范围再大一点可能更多，没有使用徽章的12个项目，可能因为历史缘由，或者我的缘由未使用，可是无论怎么说，使用徽章的人会愈来愈多。

为何要使用徽章？

徽章 shields

徽章的使用不只仅是为了装 B，而是为了让开源想更高效。进入项目主页一眼能看出须要的东西，例如该项目可否编译经过，当前最新的版本是什么等。

徽章能突出视野，github 默认给咱们展现的是黑白世界，可是经过徽章，将会获得改变。重要的信息能够一目了然。

最经常使用徽章有哪些？

一份不太靠谱的标准，不过你应该掌握:

（PS: 上图中的图标顺序对应下面的顺序）

jitpack 徽章：JitPack 是一个仓库，相似 maven，binary, 主要是帮咱们生产 android 项目的 aar or jar 的平台。基于 GitHub，能够很方便将 library 发布到远程，而后能够用 gradle 依赖到任何一个项目中。
travis-ci 徽章：Travis-CI 是一个线托管的CI服务，不须要本身搭服务器，在网页上点几下就好，用起来更方便。最重要的是，它对开源项目是免费的。
circle-ci 徽章：Cricle-CI 是也一个线托管的CI服务，和上面相同，不过这个相对来讲比较好用一些，能够 SSH 到测试容器，方便在出问题的时候上去调试找缘由，界面相对好看一些。
codecov 徽章：Codecov 是开源的测试结果展现平台，将测试结果可视化。Github上许多开源项目都使用了Codecov来展现单测结果。
api level 徽章：Api-Leavel 是 android-arsenal 网站提供的 android api 展现的徽章。能够在项目主页中直接使用 badge 的内容。
codacy 徽章：编程代码自动审查服务平台。帮助开发者及时发现代码中的 bug，提高软件运行质量，主要包括代码质量、语法规范、功能可用性方面的检查。
我的专属徽章：shiedls 根据本身的需求能够定制不少样式的徽章，全凭我的爱好，怎么开心怎么玩。

环境说明

这里我用一个简单的 android 项目来作一个说明，其余语言也是能够的，这里仅仅展现一个实例。

个人本机的android环境说明以下：

Mac
Android Studio 2.4 preview 4
gradle: 3.4.1
java: 1.8.0_73
buildToolsVersion: 25.0.2
compileSdkVersion: 25
minSdkVersion: 14
support: appcompat-v7:25.1.0
constraint: constraint-layout:1.0.0-beta4
classpath: com.android.tools.build:gradle:2.4.0-alpha4

用其余版本或者环境也是能够的, 这里只是说明。若是任何遇到问题，能够在个人博客里面留言，联系详情为：http://www.gdky005.com/about/ 由于该文的完整版真的很长，涉及到不少的技术，因此专门设立了 QQ群：621094999，有疑问或很是感兴趣的同窗，能够来次探讨，也许一些新功能就是大家发觉的呢。（PS：本应该在文末尾添加联系方式的，可是无奈，不少网站都有爬虫系统，好不容易写的文章就被爬走了，致使不少小伙伴遇到问题后，各类留言，可是我就是看不到，因此此次采起特殊方式，见谅哈）

JitPack 的使用

官网： https://jitpack.io

建立 Android Library

在 AS 中建立标准的 android 项目：
建立 Library：
建立 badge library 成功。
配置相关文件
进入 jitpack android 能够看到 jitpack 为咱们提供的文档帮助。
在项目的根目录下的 build.gradle 文件中添加：
在 library 下的 build.gradle 中添加：

，对应官网中说的『group='com.github.YourUsername’』，其实能够不写，写不写都会自动生成。即便你写成了别的，最终仍是以这样的格式输出。

AndroidBadge 中的 build.gradle :

classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5' // Add this line

AndroidBadge 里面的 badge (library) :

apply plugin: 'com.github.dcendents.android-maven'

发布到 Github （这里直接展现 AS 中的界面图形操做，会命令行的同窗随意）

登陆本身的 github 帐号，而后建立一个项目，在首页右边能看到：
点击大绿色按钮，并填写信息：

。那个协议，大家随意，这里只是演示。
建立成功后：

，拷贝当前项目地址。
在 AS 的项目中建立 git 仓库：

，点击后，直接选择 ok。将项目添加到 git 管理

。项目中的文件都变成绿色后：

，耐心等待完成后，本地项目已经被 git 管理起来了，而后把代码提交到 github 便可。可能会有冲突，自行解决便可。
如今咱们给 library 的 badge 项目添加一个工具类：

，并提交到 github。

Github 打 release or tag

建立第一个 release 分支：

发布成功之后就能看到:

通常用 release 就能够了，在适当的时候用 tag。

在 JitPack 上生成 aar

进入 https://jitpack.io/。
将 github 的项目地址： https://github.com/gdky005/AndroidBadge，直接拷贝到 jitpack 网页中的文本框中。
点击 Look Up 后：

，等里面的那个圈圈转完之后，出现绿色的这个：

说明已经发布 aar 成功，那么咱们能够直接使用了。若是点开这个东西，会看到编译的和发布的过程。
若是是红色的，说明有错误，点开查看，修改后从新构建。

在 app Demo 中测试是否生效

点击 get 后，能看到：

给项目根目录下的 build.gradle 添加：
给app 项目里面的 build.gradle 添加：

AndroidBadge 中的 build.gradle :

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

AndroidBadge 里面的 app 的 build.gradle :

compile 'com.github.gdky005:AndroidBadge:v1.0.0'

好的，如今咱们已经添加成功了，在 MainActivity 里面是是吧，看可否调到以前在 library 里面的写的 Utils.getVersion()。很高兴的是咱们调出来了：

在项目的最底下也能看到：

。运行 app 项目：

问题来了，咱们修改library 后也能调用到吗？

让我们一块儿试试吧：

修改 badge 项目中的 1.0.0 为 1.0.1 ：

。
提交代码后，push 到 github。提交成功之后，咱们重复上面的打 release 步骤

,

,
而后再去 jitpack 上看看：

多了一个 v1.0.1, 点击 get 吧。
发布成功后，咱们去 app 里面试试。
同步后，直接运行 app。很是好，咱们的修改的东西已经变了：

。

至此， jitpack 基本也差很少了，可是貌似缺乏了最重要的一点吧。

jitpack 的徽章怎么弄

仍是在刚刚的 jitpack 界面，只是咱们把页面拉倒底部。

点击后：

是否是看到了熟悉的 md 文档的格式呢？看不懂也不要紧，下面会专门讲解。

拷贝内容：
打开 github 的 AndroidBridge 项目：

，点击该文件。
让咱们在线编辑下：
给 github 中的这个 readme.md 文件添加点东西吧。
让咱们保存下。
而后回到项目首页看看：

棒棒的，添加成功。

Travis CI 的使用

官网： http://travis-ci.org/
ps: 这个是公开的，若是须要使用私有的，请使用 .com 域名。
须要提醒的是：每次提交代码后都会从新下载须要的资源文件哦，因此时间很长，耐心等待吧。

TravisCI 有什么用？

travis-ci 就是自动化 CI 工具，相似于大公司常用的 Jenkins，可是 travis-ci 是在云端的，而是支持 github, 还免费，咱们能够用 travis-ci 作不少的事情，不只仅是编译看项目有没有问题。例如在项目构建结束之后，咱们能够打包，并发布 apk 到都蒲公英， fir，也能够用邮件通知给相关的开发人员和业务任务。作一些简单处理，轻轻松松。这部份内容到后面尽快整理，在写一篇。

添加 github 项目到 travis-ci

进入 Travis 官网后，使用 GitHub 帐号登陆，成功后：

。
点击加号，能看到你 GitHub 里面的全部：

，若是没有项目或者没有你新建的项目，请点击右上方的 Sync account 按钮。
点击这里：

，开启 Travis 构建。点击这个能够配置该项目：
默认是空的：

在项目中添加 travis-ci 须要的 .travis.yml 文件

在项目根目录下直接建立一个 .travis.yml 的文件。
直接在文件里面添加代码：

.travis.yml 文件源代码

language: android jdk: oraclejdk8 sudo: false android: components: - tools - build-tools-25.0.2 - android-25 - extra-android-m2repository - extra-android-support licenses: - android-sdk-license-.+ - '.+' before_install: - chmod +x gradlew - mkdir "$ANDROID_HOME/licenses" || true - echo -e "\n8933bad161af4178b1185d1a37fbf41ea5269c55" > "$ANDROID_HOME/licenses/android-sdk-license" - echo -e "\n84831b9409646a918e30573bab4c9c91346d8abd" > "$ANDROID_HOME/licenses/android-sdk-preview-license" script: - ./gradlew assembleRelease

由于该文很长很长，因此暂时就不解释具体含义了，能够看看官方文档。

push 项目到 github, travis-ci 自动监测构建

提交到代码，并 push 到 github。会自动触发 Travis 的自动构建。
下面黑色部分是构建的过程：

，黑框上的白色点点点击后会变成绿色，会自动滚动到最下面。

喝一杯咖啡，慢慢等待吧，最难熬的时候已通过去，此刻是享受的时候了。

回到首页刷新后，能看到：

说明咱们已经构建成功了。

.travis.yml 须要注意的地方

初次使用 Travis 的试试，总遇到说 android 的一些协议未接受而构建失败，致使耗费了一两天，曾经一度想放弃，可是最终坚持了下来，经过各类搜索，摸索，猜想，终于搞定。其实最初的项目是这个：https://github.com/gdky005/TestJitpack ，里面有不少辛酸史记录，从提交记录能看得出来，有兴趣的能够研究研究，也许能解决你如今的问题。

Travis CI 协议问题解决方法：http://stackoverflow.com/questions/37615379/travis-ci-build-doesnt-work-with-android-constraint-layout

最重要部分在这里：

machine:
  environment:
      ANDROID_HOME: /usr/local/android-sdk-linux dependencies: pre: - mkdir -p "$ANDROID_HOME/licenses" - echo -e "\n8933bad161af4178b1185d1a37fbf41ea5269c55" > "$ANDROID_HOME/licenses/android-sdk-license" - echo -e "\n84831b9409646a918e30573bab4c9c91346d8abd" > "$ANDROID_HOME/licenses/android-sdk-preview-license"

添加 travis-ci 徽章到 github

激动的时刻再次到来，让咱们找找徽章在哪里呢？

让咱们来选择 markdonw 格式：

并复制上。

一样如上修改 readme.md。

加空格后，直接贴上去：

，这里须要说明的是，若是换成，图标也会换行哦。这样写就能保证全部的图标在一行了。

回到项目首页之后就能发现：

添加 Travis 徽章成功。

Bye the way! 上面是最初级的构建过程，若是遇到单元测试就不行了，还得参考个人开源项目 TestJitpack。不过有点乱，后面整理下。

Circle CI 的使用

官网: https://circleci.com/

Circle CI 和 Travis CI 有什么区别？须要一块儿使用吗？

Circle CI 相对来讲比 Travis CI 好一些，至少界面上来讲哈。还提供 ssh 的链接，构建过程相对来讲比较透明直观。例如：

Travis CI 的文档资料相对 Circle CI 来讲比较多， Circle CI 资料少之又少。

Travis CI 的使用率仍是很高的，不过 Circle CI 相对来讲比较年轻化，符合主流的科技感，更智能。

说到是否须要一块儿使用，其实都行，不过我在观察 github 主流项目的时候有很多项目都是同时使用的，多一个技能总没有坏处吧。其实会了 Travis CI，在加 Circle CI 真是简单很多呢，只是基本语法不太同样。

添加项目到 Circle CI

登陆主页面：

，在 project 里面本身的帐号下搜索刚建立的项目。
通常直接选择 Ubuntu 便可:

,点击绿色 Build project.
能看到：

，可是此次确定会失败，由于咱们尚未添加 Circle 须要的文件呢。

在项目中添加 Circle CI 须要的 circle.yml 文件

在项目的根目录下添加 circle.yml 文件；
添加 circle 的代码到文件中：

circle.yml 源代码：

machine:
  java: version: oraclejdk8 environment: ANDROID_HOME: /usr/local/android-sdk-linux dependencies: pre: - mkdir -p "$ANDROID_HOME/licenses" - echo -e "\n8933bad161af4178b1185d1a37fbf41ea5269c55" > "$ANDROID_HOME/licenses/android-sdk-license" - echo -e "\n84831b9409646a918e30573bab4c9c91346d8abd" > "$ANDROID_HOME/licenses/android-sdk-preview-license" override: - echo y | android update sdk --no-ui --filter "android-25" - echo y | android update sdk --no-ui --filter "build-tools-25.0.2" - echo y | android update sdk --no-ui --filter "extra-android-m2repository" - echo y | android update sdk --no-ui --filter "extra-android-support" - echo y | android update sdk --no-ui --filter "extra-google-m2repositor" - ./gradlew dependencies || true test: override: - ./gradlew build

push 项目到 github, Circle CI 自动监测构建

提交代码后，发布到 github，Circle CI 会自动执行。
点击进来后，会看到：

，说明已经开始构建了，下载须要的东西：

。
构建中的一些步骤：

，相对 Travis 来讲展现更直观。
看到

说明构建成功。

添加 Circle CI 徽章到 github

咱们再来把 Circle CI 的徽章找到，并添加到咱们的 github 上去吧。

咱们把徽章的 markdown 连接拷贝下来放入到咱们的主项目页面的里面。

回项目主页刷新后：

很是 happy, 已经添加成功了。

接下来添加什么呢？

Github上许多开源项目都使用了Codecov来展现单元测试结果，就它了。

Codecov 的使用

根据文中的指示：咱们能看到一个开源的 github 项目https://github.com/codecov/example-android，不过看起来点晕晕的，因而摸索了一段时间。

咱们以后都直接使用 Trivas CI 构建了。

添加项目就不说了，进入后，点击 project changes, 找到本身的项目：

，等生产报告后，进入该网站就能看见结果。

利用 Jacoco 生成报告

Codecov不支持本身生成Android的测试覆盖率报告，它能作的是接收Jacoco生成的报告并进行可视化

1）在 app 的 build.gradle 文件中添加依赖

//Jacoco 生成报告的依赖 androidTestCompile('com.android.support.test:runner:0.5', { exclude group: 'com.android.support', module: 'support-annotations' }) // Set this dependency to use JUnit 4 rules androidTestCompile('com.android.support.test:rules:0.5', { exclude group: 'com.android.support', module: 'support-annotations' }) // Espresso-contrib for DatePicker, RecyclerView, Drawer actions, Accessibility checks, CountingIdlingResource androidTestCompile('com.android.support.test.espresso:espresso-contrib:2.2.2', { exclude group: 'com.android.support', module: 'support-annotations' exclude group: 'com.android.support', module: 'support-v4' exclude group: 'com.android.support', module: 'appcompat-v7' exclude group: 'com.android.support', module: 'design' exclude group: 'com.android.support', module: 'recyclerview-v7' }) androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', { exclude group: 'com.android.support', module: 'support-annotations' })

2) 在须要构建测试覆盖率报告的Module （AndroidBadge 项目中的 app）的gradle文件中设置。

debug{
        testCoverageEnabled true }

3) 能够在尝试在本地生成报告：

./gradlew :app:createDebugAndroidTestCoverageReport 生成测试报告。 app 就是我们项目中要测试的 module

测试报告地址：app/build/reports/coverage/debug/index.html。

上报数据给 Codecov

使用Github帐号登陆 https://codecov.io/，并提供受权给该应用。
在.travis.yml文件中添加命令将测试覆盖率报告上传给Codecov。

after_success:
```
- bash <(curl -s https://codecov.io/bash)
```

Codecov 须要用到单元测试，因此必需要在配置文件中添加模拟器

由于以前修改过不少次，过程很繁琐，直接给配置文件了，相信你们一眼就能看出来。

完整的配置文件是：

language: android jdk: oraclejdk8 sudo: false env: global: - ANDROID_API_LEVEL=25 - ANDROID_BUILD_TOOLS_VERSION=25.0.2 - ANDROID_ABI=armeabi-v7a - ANDROID_TAG=google_apis - ADB_INSTALL_TIMEOUT=20 # minutes (2 minutes by default) android: components: - platform-tools - tools # to install Android SDK tools 25.1.x - build-tools-$ANDROID_BUILD_TOOLS_VERSION - android-$ANDROID_API_LEVEL - sys-img-armeabi-v7a-google_apis-$ANDROID_API_LEVEL licenses: - android-sdk-license-.+ - '.+' before_install: - chmod +x gradlew - mkdir "$ANDROID_HOME/licenses" || true - echo -e "\n8933bad161af4178b1185d1a37fbf41ea5269c55" > "$ANDROID_HOME/licenses/android-sdk-license" - echo -e "\n84831b9409646a918e30573bab4c9c91346d8abd" > "$ANDROID_HOME/licenses/android-sdk-preview-license" before_script: # Create and start emulator - echo no | android create avd --force -n test -t "android-"$ANDROID_API_LEVEL --abi $ANDROID_ABI --tag $ANDROID_TAG - emulator -avd test -no-skin -no-window & - android-wait-for-emulator - adb shell input keyevent 82 & script: - ./gradlew assembleRelease - ./gradlew :app:createDebugAndroidTestCoverageReport --info --stacktrace after_success: - bash <(curl -s https://codecov.io/bash)

codecov 总结

Travis-CI 对 android 的单元测试支持不是很好，由于须要开启虚拟机，开启这个过程就得10分钟（个人测试时间），很耗费时间。有时候也链接不上，一次跑下来估计得个 20分钟左右吧。因此，稳定性确实不是很高。若是不作单元测试，而只是作发布之类的，稳定性仍是高的。

单元测试应都会吧，这里检测的标准就是说每一个类和方法都必须检测到，不然就算没有覆盖。我这里也就简单在项目中写过例子，剩下的大家本身玩吧。

因此要不要使用单元测试仍是根据项目决定吧。

获取 codecov 的徽章

Api_Level 的使用

让 codecov 慢慢构建吧，咱们先继续。

官网：https://android-arsenal.com/api

Api_Level 有什么用？

Api_Level 是 arsenal 网站给各位开发者的一个福利，咱们的 android 开源项目通常都有一个最低的构建版本。平时咱们都是在 md 文件中写上支持版本是 14+等不少样式，可是不够醒目，有了 Api_Level 后，打开开源项目主页就知道，最低版本是多少。不用看文档也能明白，轻松很多。对应的 api 的一些特性和修改也能在这里展示。

Api_Level 怎么玩？

若是你的开源项目最低支持版本是：14，那么就选择这里：

把这个拷贝下来，放入咱们的 md 文档中吧。

codacy 的使用

官网： https://www.codacy.com

codacy 是什么？

codacy 编程代码自动审查服务平台，能够帮咱们分析存在的问题或者说是 bug,主要包括代码质量、语法规范、功能可用性方面的检查。

codacy 怎么使用？

进入官网，添加本身的须要的 project。

完成后，等待一段时间就行了，会给你发邮件通知，已经完成。

完成后的效果是：

，我们的这个项目评级是 B。

codacy 徽章呢？

拷贝下来，手动放到我们的项目的 md 文档中把。比较放心一些，若是点击后面的 add badge ,会自动加到项目中，须要咱们 pull request 里面处理下。

搞定。

生成个性徽章

官网： https://shields.io/

有什么用？

彰显我的魅力，体现某种功能。例如我们作一个跳转到个人博客的我的徽章。

怎么玩？

滚动网页到最下面：

在对应的地方填写相应的东西（也支持中文哦），完成后点击后面的 Make Badge 按钮试试看。

我想个人我的图标是这种浅蓝色：

，那么我就在 color 中直接写：7AD6FD

点击生成一个地址，先保存下面。

这个原理是什么呢？（回答最开始的问题）

徽章的格式便是 markdown 的格式:

[![](B)\](D)

A 表示的页面中须要显示的内容， B 表示的是图片的地址，D 表示的是点击后须要跳转的连接的地址。

合成个人我的专属图标吧

图片地址是上面存下来的。前面显示内容：做者。按照上面的规范出来的结果就是：

[![](https:\//img.shields.io\/badge\/%E4%BD%9C%E8%80%85-gdky005-7AD6FD.svg)\](http:\//www.gdky005.com)

把这段代码粘贴到咱们的 md 文档中，个性专属徽章就出来了，并且点击后能到咱们想去的地方。

很酷吧，其实还能够作不少这样的事情。

本文的中的项目地址是： https://github.com/gdky005/AndroidBadge
须要逐步了解项目的过程或者根据步骤出现问题的话，能够check 对应的节点，看看代码是否不一样，而后自行修改，我特地保存了该进度。若是下图中 git提交的记录：

相信小伙伴们确定能作出更有意思的东西，到时候记得与我和你们分享，比较有特点的，我会将大家的连接挂载到 github 项目里面。

由于该文真的很长，涉及到不少的技术，因此专门设立了 QQ群：621094999，有须要帮助或许分享新技能的小伙伴请进入。

本文完整地址请在个人博客里面查看，会修复文章存在的问题，并补充一些相关细节。针对小伙伴们提出的问题，将在博客中修改和增长。若是你们以为不错，而且很喜欢的话，麻烦 GitHub 中 start 下，不胜感激。

最后真想说一句

我们不玩虚的，玩点有技术含量的东西。