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

相关文章

Spring 框架之Springfox使用详解

《Spring框架之Springfox使用详解》Springfox是Spring框架的API文档工具,集成Swagger规范,自动生成文档并支持多语言/版本,模块化设计便于扩展,但存在版本兼容性、性... 目录核心功能工作原理模块化设计使用示例注意事项优缺点优点缺点总结适用场景建议总结Springfox 是

Python的端到端测试框架SeleniumBase使用解读

《Python的端到端测试框架SeleniumBase使用解读》:本文主要介绍Python的端到端测试框架SeleniumBase使用,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全... 目录SeleniumBase详细介绍及用法指南什么是 SeleniumBase?SeleniumBase

Android DataBinding 与 MVVM使用详解

《AndroidDataBinding与MVVM使用详解》本文介绍AndroidDataBinding库,其通过绑定UI组件与数据源实现自动更新,支持双向绑定和逻辑运算,减少模板代码,结合MV... 目录一、DataBinding 核心概念二、配置与基础使用1. 启用 DataBinding 2. 基础布局

Android ViewBinding使用流程

《AndroidViewBinding使用流程》AndroidViewBinding是Jetpack组件,替代findViewById,提供类型安全、空安全和编译时检查,代码简洁且性能优化,相比Da... 目录一、核心概念二、ViewBinding优点三、使用流程1. 启用 ViewBinding (模块级

Android学习总结之Java和kotlin区别超详细分析

《Android学习总结之Java和kotlin区别超详细分析》Java和Kotlin都是用于Android开发的编程语言,它们各自具有独特的特点和优势,:本文主要介绍Android学习总结之Ja... 目录一、空安全机制真题 1:Kotlin 如何解决 Java 的 NullPointerExceptio

C++ HTTP框架推荐(特点及优势)

《C++HTTP框架推荐(特点及优势)》:本文主要介绍C++HTTP框架推荐的相关资料,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录1. Crow2. Drogon3. Pistache4. cpp-httplib5. Beast (Boos

SpringBoot基础框架详解

《SpringBoot基础框架详解》SpringBoot开发目的是为了简化Spring应用的创建、运行、调试和部署等,使用SpringBoot可以不用或者只需要很少的Spring配置就可以让企业项目快... 目录SpringBoot基础 – 框架介绍1.SpringBoot介绍1.1 概述1.2 核心功能2

macOS Sequoia 15.5 发布: 改进邮件和屏幕使用时间功能

《macOSSequoia15.5发布:改进邮件和屏幕使用时间功能》经过常规Beta测试后,新的macOSSequoia15.5现已公开发布,但重要的新功能将被保留到WWDC和... MACOS Sequoia 15.5 正式发布!本次更新为 Mac 用户带来了一系列功能强化、错误修复和安全性提升,进一步增

Android NDK版本迭代与FFmpeg交叉编译完全指南

《AndroidNDK版本迭代与FFmpeg交叉编译完全指南》在Android开发中,使用NDK进行原生代码开发是一项常见需求,特别是当我们需要集成FFmpeg这样的多媒体处理库时,本文将深入分析A... 目录一、android NDK版本迭代分界线二、FFmpeg交叉编译关键注意事项三、完整编译脚本示例四

Android与iOS设备MAC地址生成原理及Java实现详解

《Android与iOS设备MAC地址生成原理及Java实现详解》在无线网络通信中,MAC(MediaAccessControl)地址是设备的唯一网络标识符,本文主要介绍了Android与iOS设备M... 目录引言1. MAC地址基础1.1 MAC地址的组成1.2 MAC地址的分类2. android与I