Android 热修复方案Tinker(六) Gradle插件实现

Gradle

dexMode

设置applyMapping会影响任何的assemble编译

R.txt

可以减少补丁包的大小

避免由于ResId改变导致remote view异常

加固或者多flavor打包(建议使用其他方式生成渠道包)的用户

Dalvik下性能损耗以及Art补丁包可能过大的问题，务必谨慎使用

务必注意的是，只有满足pattern的资源才会放到合成后的资源包。

Extension

tinkerPatch

oldApk

void checkParameter() {
if (oldApk == null) {
throw new GradleException("old apk is null, you must set the correct old apk value!")
}
File apk = new File(oldApk)
if (!apk.exists()) {
throw new GradleException("old apk ${oldApk} is not exist, you must set the correct old apk value!")
} else if (!apk.isFile()) {
throw new GradleException("old apk ${oldApk} is a directory, you must set the correct old apk value!")
}

}

buildConfig

tinkerId

void checkParameter() {
if (tinkerId == null || tinkerId.isEmpty()) {
throw new GradleException("you must set your tinkerId to identify the base apk!")
}
}

dex

dexMode

raw | jar

void checkDexMode() {
if (!dexMode.equals("raw") && !dexMode.equals("jar")) {
throw new GradleException("dexMode can be only one of 'jar' or 'raw'!")
}
}

lib

res

largeModeSize

void checkParameter() {
if (largeModSize <= 0) {
throw new GradleException("largeModSize must be larger than 0")
}
}

packageConfig

sevenZip

zipArtifact

Task

String tinkerValue = project.extensions.tinkerPatch.buildConfig.tinkerId
if (tinkerValue == null || tinkerValue.isEmpty()) {
throw new GradleException('tinkerId is not set!!!')
}

XmlParser

def metaDataTags = application['meta-data']

// remove any old TINKER_ID elements
def tinkerId = metaDataTags.findAll {
it.attributes()[ns.name].equals(TINKER_ID)
}.each {
it.parent().remove(it)
}

application.appendNode('meta-data', [(ns.name): TINKER_ID, (ns.value): tinkerValue])

// Write the manifest file
def printer = new XmlNodePrinter(new PrintWriter(manifestPath, "utf-8"))
printer.preserveWhitespace = true
printer.print(xml)

build/intermediates/tinker_intermediates/

File manifestFile = new File(manifestPath)
if (manifestFile.exists()) {
FileOperation.copyFileUsingStream(manifestFile, project.file(MANIFEST_XML))
project.logger.error("tinker gen AndroidManifest.xml in ${MANIFEST_XML}")
}

buildConfig.applyResourceMapping

tinker_intermediates

def file = project.file(PROGUARD_CONFIG_PATH)
project.logger.error("try update tinker proguard file with ${file}")

// Create the directory if it doesnt exist already
file.getParentFile().mkdirs()

// Write our recommended proguard settings to this file
FileWriter fr = new FileWriter(file.path)

String applyMappingFile = project.extensions.tinkerPatch.buildConfig.applyMapping

//write applymapping
if (shouldApplyMapping && FileOperation.isLegalFile(applyMappingFile)) {
project.logger.error("try add applymapping ${applyMappingFile} to build the package")
fr.write("-applymapping " + applyMappingFile)
fr.write("\n")
}

if (project.tinkerPatch.dex.usePreGeneratedPatchDex) {
def additionalKeptRules =
"-keep class ${AuxiliaryClassInjector.NOT_EXISTS_CLASSNAME} { \n" +
'    *; \n' +
'}\n' +
'\n' +
'-keepclassmembers class * { \n' +
'    <init>(...); \n' +
'    static void <clinit>(...); \n' +
'}\n'
fr.write(additionalKeptRules)
fr.write('\n')
}

Iterable<String> loader = project.extensions.tinkerPatch.dex.loader
for (String pattern : loader) {
if (pattern.endsWith("*") && !pattern.endsWith("**")) {
pattern += "*"
}
fr.write("-keep class " + pattern)
fr.write("\n")
}
fr.close()

applicationVariant.getBuildType().buildType.proguardFiles(file)
def files = applicationVariant.getBuildType().buildType.getProguardFiles()
project.logger.error("now proguard files is ${files}")

multiDexKeepProguard

tinker_intermediates

def file = project.file(MULTIDEX_CONFIG_PATH)
project.logger.error("try update tinker multidex keep proguard file with ${file}")

// Create the directory if it doesn't exist already
file.getParentFile().mkdirs()

// Write our recommended proguard settings to this file
FileWriter fr = new FileWriter(file.path)

fr.write(MULTIDEX_CONFIG_SETTINGS)
fr.write("\n")

Iterable<String> loader = project.extensions.tinkerPatch.dex.loader
for (String pattern : loader) {
if (pattern.endsWith("*")) {
if (!pattern.endsWith("**")) {
pattern += "*"
}
}
fr.write("-keep class " + pattern + " {\n" +
"    *;\n" +
"}\n")
fr.write("\n")
}
fr.close()

Plugin

project.extensions.create('tinkerPatch', TinkerPatchExtension)

project.tinkerPatch.extensions.create('buildConfig', TinkerBuildConfigExtension, project)

project.tinkerPatch.extensions.create('dex', TinkerDexExtension, project)
project.tinkerPatch.extensions.create('lib', TinkerLibExtension)
project.tinkerPatch.extensions.create('res', TinkerResourceExtension)
project.tinkerPatch.extensions.create('packageConfig', TinkerPackageConfigExtension, project)
project.tinkerPatch.extensions.create('sevenZip', TinkerSevenZipExtension, project)

if (!project.plugins.hasPlugin('com.android.application')) {
throw new GradleException('generateTinkerApk: Android Application plugin required')
}

def android = project.extensions.android

//add the tinker anno resource to the package exclude option
android.packagingOptions.exclude("META-INF/services/javax.annotation.processing.Processor")
android.packagingOptions.exclude("TinkerAnnoApplication.tmpl")

def configuration = project.tinkerPatch

//open jumboMode
android.dexOptions.jumboMode = true

//close preDexLibraries
try {
android.dexOptions.preDexLibraries = false
} catch (Throwable e) {
//no preDexLibraries field, just continue
}

android.registerTransform(new AuxiliaryInjectTransform(project))

def instantRunTask = project.tasks.getByName("transformClassesWithInstantRunFor${variantName}")
if (instantRunTask) {
throw new GradleException(
"Tinker does not support instant run mode, please trigger build"
+ " by assemble${variantName} or disable instant run"
+ " in 'File->Settings...'."
)
}

TinkerPatchSchemaTask tinkerPatchBuildTask = project.tasks.create("tinkerPatch${variantName}", TinkerPatchSchemaTask)
tinkerPatchBuildTask.dependsOn variant.assemble

tinkerPatchBuildTask.signConfig = variant.apkVariantData.variantConfiguration.signingConfig

variant.outputs.each { output ->
tinkerPatchBuildTask.buildApkPath = output.outputFile
File parentFile = output.outputFile
tinkerPatchBuildTask.outputFolder = "${parentFile.getParentFile().getParentFile().getAbsolutePath()}/" + TypedValue.PATH_DEFAULT_OUTPUT + "/" + variant.dirName
}

TinkerManifestTask manifestTask = project.tasks.create("tinkerProcess${variantName}Manifest", TinkerManifestTask)
manifestTask.manifestPath = variantOutput.processManifest.manifestOutputFile
manifestTask.mustRunAfter variantOutput.processManifest

variantOutput.processResources.dependsOn manifestTask

boolean proguardEnable = variant.getBuildType().buildType.minifyEnabled

if (proguardEnable) {
TinkerProguardConfigTask proguardConfigTask = project.tasks.create("tinkerProcess${variantName}Proguard", TinkerProguardConfigTask)
proguardConfigTask.applicationVariant = variant
variantOutput.packageApplication.dependsOn proguardConfigTask
}

tinker_intermediates

boolean multiDexEnabled = variant.apkVariantData.variantConfiguration.isMultiDexEnabled()

if (multiDexEnabled) {
TinkerMultidexConfigTask multidexConfigTask = project.tasks.create("tinkerProcess${variantName}MultidexKeep", TinkerMultidexConfigTask)
multidexConfigTask.applicationVariant = variant
variantOutput.packageApplication.dependsOn multidexConfigTask
}