JitPack 是一个简洁的 Maven 仓库服务,可以让你 无需上传 aar/jar 到中央仓库,只要项目在 GitHub 上,就能通过 JitPack 自动构建并发布,其他人只需一行依赖即可使用。
1. 新建 GitHub 项目
登录 GitHub,点击右上角 New Repository。
-
填写项目信息,例如:
Repository name:
MyLibraryDescription:
A sample Android library for JitPackVisibility: Public(必须是公开项目,私有仓库需要付费)
点击 Create Repository 完成创建。
2. 创建 Android Library 工程
在本地用 Android Studio 新建一个 Android Library Module。
目录结构大致如下:
<pre class="overflow-visible!" data-start="648" data-end="880">
├── library/ # Library 模块(核心代码) │ ├── build.gradle
│ └── src/main/java/com/example/mylibrary/...
├── app/ # Demo 应用(可选) ├── build.gradle
├── settings.gradle
└── gradle.properties
在 library/build.gradle 中,确认这是一个 com.android.library 模块:
id 'com.android.library'
id 'org.jetbrains.kotlin.android' // 如果使用 Kotlin
id 'maven-publish' // JitPack 推荐使用 maven-publish
}
android {
namespace "com.example.mylibrary"
compileSdk 34
defaultConfig {
minSdk 21
}
}
publishing {
publications {
release(MavenPublication) {
from components.release
groupId = 'com.github.你的GitHub用户名'
artifactId = 'MyLibrary'
version = '1.0.0'
}
}
}
3. 推送到 GitHub
git add .
git commit -m "Initial commit" git branch -M main
git remote add origin https://github.com/<你的GitHub用户名>/MyLibrary.git
git push -u origin main
4. 打 Tag / Release
JitPack 是按 Tag / Release 来发布的,所以需要打一个 Tag:
git push origin v1.0.0
5. 在 JitPack Look Up
输入仓库地址,例如:
https://github.com/<你的GitHub用户名>/MyLibrary
点击 Look Up,选择刚才的 Tag(v1.0.0),等待构建。
构建成功后,JitPack 会提供依赖配置。
6. 在其他项目里使用
在任意 Android 项目里,编辑 settings.gradle 或 build.gradle,添加 JitPack 仓库:
repositories {
maven { url 'https://jitpack.io' }
}
然后在 app/build.gradle 里引入依赖:
dependencies {
implementation 'com.github.<你的GitHub用户名>:MyLibrary:1.0.0'
}
这样就可以在项目中使用你的库了 🎉
7. 常见问题
-
构建失败?
检查库是否能在本地执行
./gradlew build成功。确认
maven-publish配置正确。查看 JitPack 提供的构建日志。
-
私有仓库?
- 需要付费并在 JitPack 设置里添加 GitHub Token 才能使用。
-
版本更新?
- 每次修改代码后重新打一个 Tag(例如
v1.0.1),即可发布新版本。
- 每次修改代码后重新打一个 Tag(例如
总结
GitHub 公开仓库 + 打 Tag 就能通过 JitPack 自动构建发布。
不需要上传 aar/jar 到 Maven Central 或 JCenter,非常适合个人开源项目。
使用者只需
implementation 'com.github.用户名:仓库名:Tag'即可依赖。