Gradle如何发布一个Android开源框架到JitPack

2024-06-03 09:12

本文主要是介绍Gradle如何发布一个Android开源框架到JitPack,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

序言

在Android领域耕耘了多年的老司机们,技术大多已经沉淀到足以自己写各种各样的框架了。你有没有想过?其实你可以将写好的框架开源出来,让更多人受益,提升开发效率。亦或者是引用过别人com.github打头的开源框架,但是不知道自己如何发布这样一个框架出去。如果你对这样的写法不熟悉,那么,你还有待加油。

// 添加以下代码到项目根目录下的build.gradle
allprojects {repositories {maven { url "https://jitpack.io" }}
}
// 添加以下代码到app模块的build.gradle
dependencies {def latest_version = '1.0'implementation 'com.github.dora4:dora-eventbus-support:$latest_version'
}
旧版本Gradle发布方式

那么我们言归正传,由于库项目不是一个app项目,所以不应该保留app模块。当然保留也没关系,只不过看着有些别扭罢了。我们第一步是要创建一个app项目,然后有两种选择。要么你再创建一个lib模块,然后把app模块删除掉。也可以直接将app模块更名为lib。改文件夹名称还不行,接下来你应该在settings.gradle中包含这个文件夹。

include ':lib'

然后把测试相关的一些东西去掉,只留纯净的你的框架的代码。你一顿操作猛如虎,咚咚咚地将框架代码写好了,也调试好了,现在到了发布环节了。

classpath "com.github.dcendents:android-maven-gradle-plugin:1.5"

在项目根目录到build.gradle引入这个gradle插件,然后在lib模块的build.gradle中加入以下代码。

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

细心的小伙伴应该发现了,这里是com.android.library,而不是com.android.application。因为我们是库项目,不是app项目。接下来我们将代码提交到GitHub这个全球最大的同性交友平台,号称“GuyHub”。然后我们在这里添加库的发布。

截屏2023-04-10 00.53.58.png

点击Craft a new release。

截屏2023-04-10 00.55.13.png
然后在输入框填入框架的版本号。

截屏2023-04-10 00.57.13.png
点击Publish release就可以了。

截屏2023-04-10 01.00.07.png
最后打开 https://jitpack.io 查看开源框架的编译进度。

新版本Gradle发布方式

如果可以一直使用上续代码发布框架那该多好啊!很遗憾,当gradle版本发生了一次重大更新后,写法就千差万别了,但大体流程还是一致的。笔者也是研究了许久,才又重新将开源框架使用高版本的gradle发布出去。我觉得这里应该有个👍。

新版本的gradle的发布我采用kts脚本,当然这个不是必须的,只不过kts有代码提示罢了。新版本gradle发布开源框架参考这个项目https://github.com/dora4/dora-eventbus-support ,这个库比较简洁,方便学习。我使用另一个库的代码讲解。

plugins {id("com.android.library")id("kotlin-android")id("maven-publish")
}android {namespace = "dora.dcache"compileSdk = 33defaultConfig {minSdk = 21targetSdk = 33}buildTypes {release {isMinifyEnabled = falseproguardFiles(getDefaultProguardFile("proguard-android.txt"), "proguard-rules.pro")}}compileOptions {sourceCompatibility = JavaVersion.VERSION_1_8targetCompatibility = JavaVersion.VERSION_1_8}
}dependencies {implementation("androidx.appcompat:appcompat:1.2.0")implementation("androidx.lifecycle:lifecycle-livedata-ktx:2.2.0")implementation("com.squareup.okhttp3:okhttp:4.8.0")implementation("com.squareup.retrofit2:converter-gson:2.8.1")implementation("com.squareup.retrofit2:retrofit:2.8.1")implementation("com.squareup.retrofit2:adapter-rxjava2:2.8.1")implementation("io.reactivex.rxjava2:rxjava:2.0.4")implementation("io.reactivex.rxjava2:rxandroid:2.0.1")implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.5.10")implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.4.2")implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:1.4.2")
}afterEvaluate {publishing {publications {register("release", MavenPublication::class) {from(components["release"])groupId = "com.github.dora4"artifactId = "dcache-android"version = "1.6.19"}}}
}

最主要的是要apply maven-publish这个插件,然后在afterEvaluate中加入发布的配置信息。你别看代码很简单,但是网上的资料大多都有各种各样的问题,找到可以让你编译过的并不容易。在此之前你要在settings.gradle.kts中加入以下代码。

pluginManagement {resolutionStrategy {eachPlugin {if (requested.id.namespace == "com.android.tools.build") {useModule("com.android.tools.build:gradle:4.1.2")}if (requested.id.namespace == "org.jetbrains.kotlin") {val kotlin_version = "1.8.10"useModule("org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version")}if (requested.id.namespace == "com.github.dcendents") {useModule("com.github.dcendents:android-maven-gradle-plugin:1.5")}}}
}

然后在项目根目录的build.gradle.kts加入以下代码。

plugins {id("com.android.library") version("7.3.1") apply(false)id("org.jetbrains.kotlin.android") version("1.7.20") apply(false)id("com.github.dcendents.android-maven") version("1.5") apply(false)
}

OK,大功告成!剩下的跟旧版本的发布方式类似。

对写开源框架的一点看法

作为一个开发开源框架的Android工程师,一定要有一种精益求精的精神,在一个比较小的功能上尽可能做到完美,把各种情况都考虑到位。因为框架冗余代码太多,别人在选框架的时候也会考虑对apk安装包大小影响的。尽量做到小而精,而不是大而全。代码越多,越容易出bug,而开源框架是要给很多人使用的,别人不太可能使用你有很多bug的框架,除非那人本来也不太懂。大家一起把自己擅长的领域开源出来,这样可以节省大家的开发时间,不是很好的一件事吗?

这篇关于Gradle如何发布一个Android开源框架到JitPack的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



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

相关文章

微信公众号脚本-获取热搜自动新建草稿并发布文章

《微信公众号脚本-获取热搜自动新建草稿并发布文章》本来想写一个自动化发布微信公众号的小绿书的脚本,但是微信公众号官网没有小绿书的接口,那就写一个获取热搜微信普通文章的脚本吧,:本文主要介绍微信公众... 目录介绍思路前期准备环境要求获取接口token获取热搜获取热搜数据下载热搜图片给图片加上标题文字上传图片

Android中Dialog的使用详解

《Android中Dialog的使用详解》Dialog(对话框)是Android中常用的UI组件,用于临时显示重要信息或获取用户输入,本文给大家介绍Android中Dialog的使用,感兴趣的朋友一起... 目录android中Dialog的使用详解1. 基本Dialog类型1.1 AlertDialog(

SpringKafka消息发布之KafkaTemplate与事务支持功能

《SpringKafka消息发布之KafkaTemplate与事务支持功能》通过本文介绍的基本用法、序列化选项、事务支持、错误处理和性能优化技术,开发者可以构建高效可靠的Kafka消息发布系统,事务支... 目录引言一、KafkaTemplate基础二、消息序列化三、事务支持机制四、错误处理与重试五、性能优

新特性抢先看! Ubuntu 25.04 Beta 发布:Linux 6.14 内核

《新特性抢先看!Ubuntu25.04Beta发布:Linux6.14内核》Canonical公司近日发布了Ubuntu25.04Beta版,这一版本被赋予了一个活泼的代号——“Plu... Canonical 昨日(3 月 27 日)放出了 Beta 版 Ubuntu 25.04 系统镜像,代号“Pluc

Python Dash框架在数据可视化仪表板中的应用与实践记录

《PythonDash框架在数据可视化仪表板中的应用与实践记录》Python的PlotlyDash库提供了一种简便且强大的方式来构建和展示互动式数据仪表板,本篇文章将深入探讨如何使用Dash设计一... 目录python Dash框架在数据可视化仪表板中的应用与实践1. 什么是Plotly Dash?1.1

基于Flask框架添加多个AI模型的API并进行交互

《基于Flask框架添加多个AI模型的API并进行交互》:本文主要介绍如何基于Flask框架开发AI模型API管理系统,允许用户添加、删除不同AI模型的API密钥,感兴趣的可以了解下... 目录1. 概述2. 后端代码说明2.1 依赖库导入2.2 应用初始化2.3 API 存储字典2.4 路由函数2.5 应

Python GUI框架中的PyQt详解

《PythonGUI框架中的PyQt详解》PyQt是Python语言中最强大且广泛应用的GUI框架之一,基于Qt库的Python绑定实现,本文将深入解析PyQt的核心模块,并通过代码示例展示其应用场... 目录一、PyQt核心模块概览二、核心模块详解与示例1. QtCore - 核心基础模块2. QtWid

Android Kotlin 高阶函数详解及其在协程中的应用小结

《AndroidKotlin高阶函数详解及其在协程中的应用小结》高阶函数是Kotlin中的一个重要特性,它能够将函数作为一等公民(First-ClassCitizen),使得代码更加简洁、灵活和可... 目录1. 引言2. 什么是高阶函数?3. 高阶函数的基础用法3.1 传递函数作为参数3.2 Lambda

Android自定义Scrollbar的两种实现方式

《Android自定义Scrollbar的两种实现方式》本文介绍两种实现自定义滚动条的方法,分别通过ItemDecoration方案和独立View方案实现滚动条定制化,文章通过代码示例讲解的非常详细,... 目录方案一:ItemDecoration实现(推荐用于RecyclerView)实现原理完整代码实现

Android App安装列表获取方法(实践方案)

《AndroidApp安装列表获取方法(实践方案)》文章介绍了Android11及以上版本获取应用列表的方案调整,包括权限配置、白名单配置和action配置三种方式,并提供了相应的Java和Kotl... 目录前言实现方案         方案概述一、 androidManifest 三种配置方式