CN111290780A

CN111290780A - 一种自动化上传SDK到maven仓库的方法

Info

Publication number: CN111290780A
Application number: CN202010162270.8A
Authority: CN
Inventors: 谈趣; 黄海亮; 梁瑛玮; 洪行健; 李长杰; 冷冬; 丁一
Original assignee: Guangzhou Easefun Information Technology Co ltd
Current assignee: Guangzhou Easefun Information Technology Co ltd
Priority date: 2020-03-10
Filing date: 2020-03-10
Publication date: 2020-06-16
Anticipated expiration: 2040-03-10
Also published as: CN111290780B

Abstract

一种自动化上传SDK到maven仓库的方法，其特征在于：a.集成www.bintray.com提供的Gradle上传插件到项目中；b.修改Gradle上传插件中的配置1：在上传自定项配置项中，增加使用自己编写的Jar任务；c.修改Gradle上传插件中的配置2：在上传自定项配置项中，增加使用Gradle系统提供的正式环境编译程序生成的混淆后的aar包路径；d.修改Gradle上传插件中的配置3，屏蔽默认的上传文件项配置；Gradle系统提供的正式环境编译程序，会根据我们在程序中的混淆配置，生成混淆后的aar包，两个程序被Jar任务依赖，会在Jar任务之前执行。本发明与已有技术相比，具有通过www.bintray.com提供的Gradle插件上传方式，可以通过一条命令自动化上传包括混淆后的aar包，自定义配置的源码包等打包好的Android SDK到www.bintray.com的优点。

Description

一种自动化上传SDK到maven仓库的方法

技术领域

本发明涉及计算机领域，特别是防录屏技术。

背景技术

www.bintray.com有提供Gradle上传方式可以让用户通过集成Gradle插件（https://github.com/bintray/gradle-bintray-plugin），来自动化上传SDK包到www.bintray.com的maven仓库，但是gradle-bintray-plugin有两个问题。

问题一：无法直接上传混淆后的aar包，要先提前单独生成混淆后的aar包。

问题二：无法直接上传自定义源码包，要先提前单独生成自定义源码包。

源码片段

void uploadArtifact(Artifact artifact) {

def versionPath = packagePath + '/' + versionName : artifact.version

def uploadUri = "/content/$versionPath/${artifact.path}"

if (!artifact.file.exists()) {

logger.error("Skipping upload for missing file '$artifact.file'.")

return

}

artifact.file.withInputStream { is ->

is.metaClass.totalBytes = {

artifact.file.length()

}

logger.warn("Uploading to $apiUrl$uploadUri...")

if (dryRun) {

logger.info("(Dry run) Uploaded to '$apiUrl$uploadUri'.")

return

}

getHttpBuilder().request(PUT) {

if (override) {

uri.query = [override: "1"]

}

addUploadHeaders(headers)

// Set the requestContentType to BINARY, so that HTTPBuildercan encode the uploaded file:

requestContentType = BINARY

// Set the Content-Type to '*/*' to enable Bintray to set iton its own:

headers["Content-Type"] = '*/*'

uri.path = uploadUri

body = is

response.success = { resp ->

logger.warn("Uploaded to '$apiUrl$uri.path'.")

}

response.failure = { resp, reader ->

throw new GradleException("Could not upload to '$apiUrl$uri.path': $resp.statusLine $reader")

}

gradle-bintray-plugin源码中可以看到，传入的参数artifact会打开一个文件的InputStream来上传。

而混淆后的aar包，是需要经过gradle的assembleRelease任务来构建生成的。所以，这里不能直接上传混淆后的aar包，而是要先执行gradle的assembleRelease任务构建混淆后的aar包，再把混淆后的aar包地址作为参数artifact传入。

而自定义源码包，是一个完全自定义的构建任务生成的jar文件。所以，这里不能直接上传自定义源码包，而是要先执行自定义源码包构建任务构建jar文件，再把jar文件的地址作为参数artifact传入。

发明内容

提供一种通过与gradle-bintray-plugin相配合的上传方式，可以一条命令自动化上传包括混淆后的aar包，自定义配置的源码包等打包好的Android SDK到www.bintray.com的maven仓库，的一种自动化上传SDK到maven仓库的方法。

本发明是这样实现的，

1.集成www.bintray.com提供的Gradle上传插件到项目中，

2.修改Gradle上传插件中的配置，在上传自定项配置项中，增加使用自己编写的Jar任务，Jar任务依赖自定义源码包生成程序和Gradle系统提供的正式环境编译程序，执行Jar任务时，会返回到自定义源码包生成程序运行后生成的Jar源码包的路径，

3.修改Gradle上传插件中的配置，在上传自定项配置项中，增加使用Gradle系统提供的正式环境编译程序生成的混淆后的aar包的路径，

4.修改Gradle上传插件中的配置，屏蔽默认的上传文件项配置，

自定义源码包生成程序，自己编写，只会打包需要打包的源码文件，生成Jar源码包，

Gradle系统提供的正式环境编译程序，会根据我们在程序中的混淆配置，生成混淆后的aar包，

自定义源码包生成程序和Gradle系统提供的正式环境编译程序被Jar任务依赖，会在Jar任务之前执行。

本发明由于增加使用自己编写的Jar任务以及对上传自定项配置项中做相应的修改，因此，可以一条命令自动化上传包括混淆后的aar包，自定义配置的源码包等打包好的Android SDK到www.bintray.com的maven仓库，从而能实现本专利申请的发明目的。

具体实施方式：

以下以一个Android Studio Phone项目为例，具体描述如何实现该方案：

（集成gradle-bintray-plugin插件到项目中）

buildscript {

repositories {

google()

jcenter()

}

dependencies {

classpath 'com.android.tools.build:gradle:3.0.1'

classpath 'com.github.dcendents:android-maven-gradle-plugin:2.0'//新增

classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.8.4'//新增

}

allprojects {

repositories {

google()

jcenter()

}

task clean(type: Delete) {

delete rootProject.buildDir

}

（在项目根目录的build.gradle文件中新增两个依赖：

classpath ‘com.github.dcendents:android-maven-gradle-plugin:2.0'

classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.8.4'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.8.4是www.bintray.com提供的Gradle上传插件程序。 com.github.dcendents:android-maven-gradle-plugin:2.0是配合gradle-bintray-plugin使用的一个第三方插件程序）

（在需要作为SDK进行上传的module build.gradle中，编写gradle-bintray-plugin使用程序，这里的module名称是core）

apply plugin: 'com.android.library'

android {

compileSdkVersion 29

defaultConfig {

minSdkVersion 15

targetSdkVersion 29

versionCode 1

versionName "1.0"

testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"

consumerProguardFiles 'consumer-rules.pro'

}

buildTypes {

release {

minifyEnabled true

proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'

}

dependencies {

implementation fileTree(dir: 'libs', include: ['*.jar'])

implementation 'androidx.appcompat:appcompat:1.0.2'

testImplementation 'junit:junit:4.12'

androidTestImplementation 'androidx.test:runner:1.1.1'

androidTestImplementation 'androidx.test.espresso:espresso-core:3.1.1'

}

//-----------------------------------------------------------------------------------------------------------

(以下是gradle-bintray-plugin使用代码和自定义源码包生成程序代码)

apply plugin: 'maven-publish'

apply plugin: 'com.jfrog.bintray'

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

Map<String, String> coreMap = ["/src/main/java/com/easefun/polyv/bintray/upload/core/PolyvMain.java": ""];

task copyCoreSources(type: Copy) {

logger.info "copy core sources"

for (Map.Entry<String, String> entry : coreMap.entrySet()) {

from(project.projectDir.getAbsolutePath() + entry.key) {

into entry.value

}

into new File(rootProject.projectDir, "/make/sources/core/com/easefun/polyv/bintray/upload/core")

}

group = 'com.easefun.polyv'

version = '1.0.0'

project.archivesBaseName = 'core'

// This generates sources.jar

tasks.create(name:"coreSourcesJar", type:Jar, dependsOn:["copyCoreSources", "assembleRelease"]) {

manifest {

attributes 'Implementation-Title': "polyv core sources",

'Implementation-Version': '1.0.0'

}

logger.info "make core sources jar"

//从哪里打包class文件

from new File(rootProject.rootDir, "/make/sources/core")

classifier = "sources"

}

publishing {

publications {

MyMavenPublication(MavenPublication) {

groupId = 'com.easefun.polyv'

artifactId = 'core'

version = '1.0.0'

artifact tasks.getByName("coreSourcesJar")

artifact new File(project.getBuildDir(), "/outputs/aar/core-release.aar");

pom.withXml {

def dependenciesNode = asNode().appendNode('dependencies')

// Iterate over the implementation dependencies (we don'twant the test ones), adding a <dependency> node for each

configurations.implementation.allDependencies.each {

// Ensure dependencies such as fileTree are notincluded in the pom.

if (it.name != 'unspecified') {

def dependencyNode = dependenciesNode.appendNode('dependency')

dependencyNode.appendNode('groupId', it.group)

dependencyNode.appendNode('artifactId', it.name)

dependencyNode.appendNode('version', it.version)

}

// bintray configuration

bintray {

user = 'Bintray user'

key = 'Bintray user key'

publications = ['MyMavenPublication']

pkg {

repo = 'test'

userOrg = 'polyv'

name = 'core'

websiteUrl = 'https://wwww.polyv.net'

vcsUrl = 'https://wwww.polyv.net'

licenses = ["MIT"]

labels = ["polyv", "Polyv", 'core']

publicDownloadNumbers = true

publish = true

version {

name = '1.0.0'

vcsTag = '1.0.0'

gpg {

sign = true

}

说明：

1、在MyMavenPublication中增加artifact字段，artifact字段的值配置为使用自己编写的coreSourcesJar任务，coreSourcesJar任务返回自定义jar源码包路径。

2、coreSourcesJar任务中依赖assembleRelease任务，assembleRelease任务会生成混淆后的aar包。

3、在MyMavenPublication中增加artifact字段，artifact字段的值配置为使用混淆后的aar包路径。

coreSourcesJar任务，是自定义源码包生成程序的入口，内部包含多个自行实现的构建任务，会根据配置的源文件来打包生成Jar源码包。

coreSourcesJar任务的整个流程是：

•coreSourcesJar任务执行之前，会调用copyCoreSources任务，copyCoreSources任务中会把coreMap中配置的源文件拷贝到项目中自定义的/make/sources/core/com/easefun/polyv/bintray/upload/core下。

•coreSourcesJar任务会把/make/sources/core目录下的文件打包成jar文件，并且把jar定义为source。

使用coreSourcesJar任务来生成jar源码包的原因：

用户在使用Android SDK的时候，实际是使用aar包，而aar包中包含的都是编译后的代码文件。编译后的代码文件中不会包含注释，也因为混淆的原因，很多方法中的参数名，都被重命名了，不利于理解。为了给SDK增加易用性，要把可以公开的接口、类、方法，以源码的方式提供，源码文件中可以包含接口注释、类注释、方法注释、变量注释，源码文件都统一打成一个包，就是源码jar包。这样，在查看编译后的文件时，就能直接查看源码文件，可以有效提高SDK的易用性。又因为不是所有代码都能以源码的方式公开，比如加解密相关的逻辑，就不能公开，而是要混淆，所以这里要配置需要打包的源文件，以此来提高SDK的安全性。

assembleRelease任务，是Android Gradle插件库提供的正式环境编译程序，会根据程序中的混淆配置文件，生成混淆后的aar包。

com.android.tools.build:gradle:3.0.1是Android Gradle插件库。

在module build.gradle中配置buildTypes，release表示构建类型，minifyEnabled 为true表示启用混淆，proguardFile表示混淆配置文件。assembleRelease任务会自动根据混淆配置文件中的语法，来混淆aar包中编译后的代码文件。

使用混淆功能的原因：

aar包中包含的编译后的代码文件也是可以阅读的，特别是涉及到加解密部分代码的逻辑，如果其他人可以看到，会产生重大安全隐患，因此，为了提高SDK中代码的安全性，就需要使用混淆功能，使代码难以阅读。也为了减少SDK包体积的大小，也要使用混淆功能。

因此，当执行gradle-bintray-plugin上传任务，在项目根目录下执行命令：

以Mac OS 为例

./gradlew bintrayUpload

gradlew是Android Studio Phone项目的一个shell脚本文件。

在gradle-bintray-plugin上传文件的时候，会先执行makeCoreSourcesJar任务，makeCoreSourcesJar任务又会先执行依赖的copyCoreSources任务和assembleRelease任务，生成自定义jar源码包，混淆后的aar包。然后再上传到配置的maven仓库。以此就实现了一条命令自动化上传包括混淆后的aar包，自定义jar源码包等打包好的Android SDK到www.bintray.com的maven仓库。

优势

可以通过一条命令自动化上传打包好的Android SDK到www.bintray.com的maven仓库，包括：混淆后的aar包，自定义jar源码包。提升SDK发布效率，降低人工操作难度。

混淆后的aar包提升SDK安全性，减少SDK体积大小。

自定义配置的源码包，兼顾提升SDK安全性和SDK使用效率。

使用端不需要做任何改变，对于从maven仓库拉取包，没有任何变化。

Claims

1.一种自动化上传SDK到maven仓库的方法，其特征在于：

a、集成www.bintray.com提供的Gradle上传插件到项目中，

b、修改Gradle上传插件中的配置，在上传自定项配置项中，增加使用自己编写的Jar任务，Jar任务依赖自定义源码包生成程序和Gradle系统提供的正式环境编译程序，执行Jar任务时，会返回到自定义源码包生成程序运行后生成的Jar源码包的路径，

c、修改Gradle上传插件中的配置，在上传自定项配置项中，增加使用Gradle系统提供的正式环境编译程序生成的混淆后的aar包的路径，

d、修改Gradle上传插件中的配置，屏蔽默认的上传文件项配置，