最近需要开发SDK给第三方接入,记录一下整体流程
先理一下SDK开发的整个过程:
- 新建项目,先为SDK创建一个独立的Module, 方便打包成jar或者aar包。
打包直接使用Android自带的打包工具 - 搭建Maven私服
在自己的服务器上使用Nexus搭建Maven私服,搭建完成后可以上传jar或者aar包到服务器上,第三方可以通过gradle自动下载jar或者aar包到自己项目使用。 - 打包jar或者aar包,使用上传插件上传包至Maven私服。
在gradle中编写完上传插件后,可一键将jar或者aar包上传到Maven私服。 - 在其他项目中引用SDK,使用SDK功能。
以上四步就是SDK开发的基本流程。
下面一步一步展开讲解
1.新建Module
在Module中写一个单例类,里面加一个方法,供第三方调用:
2.搭建Maven私服
Nexus官网:https://help.sonatype.com/en/download.html
根据自己操作系统,下载对应安装包,我直接搭在本地,所以下载的是Windows版本
下载后解压 进入bin目录
打开终端,切到bin目录并运行 .\nexus.exe /run 指令 启动Nexus
等待执行信息输出完毕
到这一步表示nexus服务已经启动
接着在浏览器输入: localhost:8081
接着点击 Signin 登录
第一次登录会提示你账号密码,密码到指定路径复制,再登录进去
第一次登录完会告诉你设置新密码
点击next,会让你选择能否匿名访问,选择不可匿名访问保证安全性
到这一步表示Maven私服已经搭建完成。
-
打包jar或aar包
我这里直接打的aar
在AndroidStudio右侧Gradle中找到当前Module文件夹,选择assembleRelease任务
运行完成会在build/outputs/aar/ 目录下打出aar包
使用 maven-publish 插件上传aar包
代码:
publishing {
publications {
create<MavenPublication>("maven") {
groupId = "sdk"
artifactId = "sdk"
version = "1.0.0"
artifact(file("build/outputs/aar/${project.name}-release.aar"))
// 添加所有依赖项
pom.withXml {
val node = asNode()
val dependenciesNode = node.appendNode("dependencies")
val impDependencies = configurations.findByName("implementation")
impDependencies?.dependencies?.forEach { dependency ->
if (dependency.group != null && dependency.version != null) {
val dependencyNode = dependenciesNode.appendNode("dependency")
dependencyNode.appendNode("groupId", dependency.group)
dependencyNode.appendNode("artifactId", dependency.name)
dependencyNode.appendNode("version", dependency.version)
dependencyNode.appendNode("scope", impDependencies.name)
}
}
}
versionMapping {
usage("java-api") {
fromResolutionOf("runtimeClasspath")
}
usage("java-runtime") {
fromResolutionResult()
}
}
}
}
repositories {
maven {
url = uri("http://127.0.0.1:8081/repository/maven-releases/")
credentials {
username = "admin"
password = "******"
}
}
}
}
账号密码就是nexus的登录账号密码
http://127.0.0.1:8081/repository/maven-releases/ 一般用来放正式包,还有其他路径:
每个路径有不同的含义,可自行查阅文档。
配置完 maven-publish 插件后, 在AndroidStudio右侧Gradle中会多出publish 任务
运行publish 任务, 等待上传完成
回到nexus网页,进入maven-releases 可以看到刚上传的aar包
完成以上步骤就已经把SDK上传到了Maven私服。
4.第三方项目引用
点击设置图标:
进入maven-releases 复制URL
在项目的根引用中添加:
再回到nexus 复制依赖路径:
在项目的build.gradle中引用依赖:
点击sync 等待下载完成, 打开External libraries 可以看到aar包已经引入进来
方法也可正常调用
以上就是SDK开发完整流程,这里选择了非匿名访问,所以下载需要账号密码,公用SDK可以选择允许匿名访问。
完