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

相关文章

修复已被利用的高危漏洞! macOS Sequoia 15.6.1发布

《修复已被利用的高危漏洞!macOSSequoia15.6.1发布》苹果公司于今日发布了macOSSequoia15.6.1更新,这是去年9月推出的macOSSequoia操作... MACOS Sequoia 15.6.1 正式发布!此次更新修复了一个已被黑客利用的严重安全漏洞,并解决了部分中文用户反馈的

GSON框架下将百度天气JSON数据转JavaBean

《GSON框架下将百度天气JSON数据转JavaBean》这篇文章主要为大家详细介绍了如何在GSON框架下实现将百度天气JSON数据转JavaBean,文中的示例代码讲解详细,感兴趣的小伙伴可以了解下... 目录前言一、百度天气jsON1、请求参数2、返回参数3、属性映射二、GSON属性映射实战1、类对象映

Android协程高级用法大全

《Android协程高级用法大全》这篇文章给大家介绍Android协程高级用法大全,本文结合实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友跟随小编一起学习吧... 目录1️⃣ 协程作用域(CoroutineScope)与生命周期绑定Activity/Fragment 中手

Android 缓存日志Logcat导出与分析最佳实践

《Android缓存日志Logcat导出与分析最佳实践》本文全面介绍AndroidLogcat缓存日志的导出与分析方法,涵盖按进程、缓冲区类型及日志级别过滤,自动化工具使用,常见问题解决方案和最佳实... 目录android 缓存日志(Logcat)导出与分析全攻略为什么要导出缓存日志?按需过滤导出1. 按

解决若依微服务框架启动报错的问题

《解决若依微服务框架启动报错的问题》Invalidboundstatement错误通常由MyBatis映射文件未正确加载或Nacos配置未读取导致,需检查XML的namespace与方法ID是否匹配,... 目录ruoyi-system模块报错报错详情nacos文件目录总结ruoyi-systnGLNYpe

Android Paging 分页加载库使用实践

《AndroidPaging分页加载库使用实践》AndroidPaging库是Jetpack组件的一部分,它提供了一套完整的解决方案来处理大型数据集的分页加载,本文将深入探讨Paging库... 目录前言一、Paging 库概述二、Paging 3 核心组件1. PagingSource2. Pager3.

Python Web框架Flask、Streamlit、FastAPI示例详解

《PythonWeb框架Flask、Streamlit、FastAPI示例详解》本文对比分析了Flask、Streamlit和FastAPI三大PythonWeb框架:Flask轻量灵活适合传统应用... 目录概述Flask详解Flask简介安装和基础配置核心概念路由和视图模板系统数据库集成实际示例Stre

Olingo分析和实践之OData框架核心组件初始化(关键步骤)

《Olingo分析和实践之OData框架核心组件初始化(关键步骤)》ODataSpringBootService通过初始化OData实例和服务元数据,构建框架核心能力与数据模型结构,实现序列化、URI... 目录概述第一步:OData实例创建1.1 OData.newInstance() 详细分析1.1.1

Android kotlin中 Channel 和 Flow 的区别和选择使用场景分析

《Androidkotlin中Channel和Flow的区别和选择使用场景分析》Kotlin协程中,Flow是冷数据流,按需触发,适合响应式数据处理;Channel是热数据流,持续发送,支持... 目录一、基本概念界定FlowChannel二、核心特性对比数据生产触发条件生产与消费的关系背压处理机制生命周期

Android ClassLoader加载机制详解

《AndroidClassLoader加载机制详解》Android的ClassLoader负责加载.dex文件,基于双亲委派模型,支持热修复和插件化,需注意类冲突、内存泄漏和兼容性问题,本文给大家介... 目录一、ClassLoader概述1.1 类加载的基本概念1.2 android与Java Class