Gradle is the recommended access method tinker-patch-gradle-plugin We help you to complete the proguard, multiDex and Manifest processing.

In the project's build.gradle Medium, add tinker-patch-gradle-plugin Dependencies on

 buildscript { dependencies { classpath ( ' com.tencent.tinker:tinker-patch-gradle-plugin:1.9.1 ' ) } }

Then in the gradle file of the app app/build.gradle We need to add tinker library dependencies and apply tinker gradle plug-ins

 dependencies { // Optional, used to generate application classes provided( ' com.tencent.tinker:tinker-android-anno:1.9.1 ' ) // Tinker's core library compile( ' com.tencent.tinker:tinker-android-lib:1.9.1 ' )  } .. . .. . // Apply tinker plug-in apply plugin : ' com.tencent.tinker.patch '

We call the original apk package the benchmark apk package. TinkerPatch directly uses the benchmark apk package to make a difference from the newly compiled apk package to get the final patch package. The parameters configured by gradle are explained in detail as follows:

For specific parameter setting examples, refer to the app/build.gradle 。

Direct use task:tinkerPatchVariantName (For example, tinkerPatchDebug, tinkerPatchRelease) can automatically select the corresponding compilation type according to Variant, and it also completes the following operations for us:

1. Automatically insert TINKER_ID into the meta item of AndroidManifest, and the output path is build/intermediate/tinker_intermediates/AndroidManifest.xml;

2. If minifyEnabled is true, Tinker's proguard rules will be automatically added to proguardFiles, and the output path is build/intermediate/tinker_intermediates/linker_proguard.pro, Here you don't need to copy them to your own proguard configuration file ;

3. If multiDexEnabled is true, the keep rule that Tinker needs to place in the main dex will be automatically generated. Before tinker 1.7.6, you You need to manually copy the generated rules to your multiDexKeepProguard file 。 For example, in Sample multiDexKeepProguard file("keep_in_main_dex.txt") 。 After 1.7.6, it will be automatically processed through script, and there is no need to fill in manually.

4. Open the jumboMode of dexOptions.

The output path is: build/intermediate/tinker_intermediates/linker_multidexkeep.pro. Then you can build/outputs/tinkerPatch The output file was found in.

Sometimes we want to package through the Flavor method. A simple usage example is provided in sample:

1. Compile through Flavor. At this time, we can see that the bakApk path is a directory distinguished by the name of Flavor;

2. Fill the compilation directory path into sample tinkerBuildFlavorDirectory , other fields do not need to be filled in, but will be automatically spliced according to the path;

 ext { tinkerBuildFlavorDirectory = "${bakPath}/app-1014-13-35-12" }

3. Operation tinkerPatchAllFlavorDebug perhaps tinkerPatchAllFlavorRelease You can get all the patches of Flavor.

In tinkerPatch output directory build/outputs/tinkerPatch The documents we are interested in are:

At the end of each compilation, we should check the relevant logs to understand the final files in the patch package. In particular, the patch files of dex, even 1k dex patch files, will also have two impacts: time consumption during synthesis and the ROM space volume of the synthesized complete dex files!

Command Line Tools tinker-patch-cli.jar It provides the function of generating patch packages by making differences between the benchmark package and the new installation package. The specific command parameters are as follows:

 java - jar  tinker - patch - cli . jar - old  old . apk - new  new . apk - config  tinker_config . xml - out  output_path

The parameters are basically the same as those of gradle. For the new sign parameter, we need to enter the signature path and signature information.

Unlike gradle, we need to insert TINKER_ID into AndroidManifest.xml when compiling. for example

 < meta-data  android : name = " TINKER_ID "  android : value = " tinker_id_b168b32 " />

At the same time, we need to ensure that the guard file and the main dex class are correct. Refer to the following documents for specific configuration:

• tinker_config.xml example
• tinker_proguard.pro Example of proguard configuration
• tinker_multidexkeep.pro Main dex configuration instance

use tinker-git:buildTinkerSdk The task can be found in the buildSdk Get all the required files in the folder.

These include:

1. build; The tools used in compiling are tinker-patch-cli.jar and some configuration information that may be used;
2. android； It needs to be placed in the dependency library on the mobile phone, where tinker-android-anno.jar As an optional library, only those that use Tinker's annotation need to be imported.

Demo Please refer to tinker-sample-android , its use method is as follows:

1. call assembleDebug Compile. We will save the compiled package in build/bakApk. Then we install it to the phone, click SHOW INFO Button, you can see that the patch has not been loaded

   

2. Modify the code, such as changing MainActivity in I am on patch onCreate The Log of is opened. Then we need to modify build.gradle Copy the path of the installation package compiled and saved in Step 1 to tinkerPatch In oldApk Parameter.

   

3. call tinkerPatchDebug , the patch package and related logs will be saved in /build/outputs/tinkerPatch/ 。 Then we will patch_signed_7zip.apk Push to the sdcard of the mobile phone.

    adb  push ./ app / build / outputs / tinkerPatch / debug / patch_signed_7zip . apk / storage / sdcard0 /

4. click LOAD PATCH Button, if you see patch success, please restart process To lock the screen or click KILL SELF Button

   

5. We can see that it does appear I am on patch onCreate Log, and click SHOW INFO The button shows that the patch package has been loaded successfully.

   

Tinker is used as follows. Take the release packet accessed by gradle as an example:

1. Backup the installation package and mapping file for each compilation or contracting;
2. If there is a need for patch packs, modify your code, library files, etc. according to your own needs;
3. Input the backup benchmark installation package and mapping file into the configuration of tinkerPatch;
4. Run tinkerPatchRelease to automatically compile the latest installation package and make a difference from the input benchmark package to get the final patch package.

Tinker debugging source code is very simple. You need to run tinker group in the main project of tinker buildAndPublishTinkerToLocalMaven Task is enough.

In addition, since localmaven cannot transfer dependencies, the following libraries need to be explicitly referenced where they are used:

 compile ( "com.tencent.tinker:tinker-android-loader:${TINKER_VERSION}" ) { changing = true } compile ( "com.tencent.tinker:aosp-dexutils:${TINKER_VERSION}" ) { changing = true } compile ( "com.tencent.tinker:bsdiff-util:${TINKER_VERSION}" ) { changing = true } compile ( "com.tencent.tinker:tinker-commons:${TINKER_VERSION}" ) { changing = true }

github/Tinker The default branch of is the master branch. The meanings of the following are:

1. Master branch; The last release of stable code, we tag the master branch;
2. Dev branch; The development branch will contain the code of the next version. We can only provide pr for the dev branch and verify that some of the repaired issues have been repaired;
3. Hotfix branch; To fix the branch of tinker's emergency bug.

For tinker branch management, issue and pr specifications, please read Tinker Contributing Guide 。

www.tinkerpatch.com It is the background of patch management developed by a third party based on CDN distribution. It provides functions such as script background hosting, version management, and transmission security, so that you can use Tinker immediately without setting up a background and caring about deployment operations.

In addition, TinkerPatch platform has added functions such as one click fool like access/compilation management optimization. Its Github address is TinkerPatch 。

In general, we recommend gradle as the access method. Then we continue to learn how to Tinker custom extension 。