Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Tencent/tinker

Tinker is a hot-fix solution library for Android, it supports dex, library and resources update without reinstall apk.
https://github.com/Tencent/tinker

android dynamic hotfix wechat

Last synced: about 2 months ago
JSON representation

Tinker is a hot-fix solution library for Android, it supports dex, library and resources update without reinstall apk.

Awesome Lists containing this project

README 

        
## Tinker

[![license](http://img.shields.io/badge/license-BSD3-brightgreen.svg?style=flat)](https://github.com/Tencent/tinker/blob/master/LICENSE)

[![Release Version](https://img.shields.io/badge/release-1.9.14.25-red.svg)](https://github.com/Tencent/tinker/releases)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Tencent/tinker/pulls)

[![WeChat Approved](https://img.shields.io/badge/Wechat_Approved-1.9.14.25.3-red.svg)](https://github.com/Tencent/tinker/wiki)



[中文说明](https://github.com/Tencent/tinker/wiki)



Tinker is a hot-fix solution library for Android, it supports dex, library and resources update without reinstalling apk.



![tinker.png](assets/tinker.png)



## Getting started

Add tinker-gradle-plugin as a dependency in your main `build.gradle` in the root of your project:



```gradle

buildscript {

    dependencies {

        classpath ('com.tencent.tinker:tinker-patch-gradle-plugin:1.9.1')

    }

}

```



Then you need to "apply" the plugin and add dependencies by adding the following lines to your `app/build.gradle`.



```gradle

dependencies {

    //optional, help to generate the final application

    provided('com.tencent.tinker:tinker-android-anno:1.9.1')

    //tinker's main Android lib

    compile('com.tencent.tinker:tinker-android-lib:1.9.1')

}

...

...

apply plugin: 'com.tencent.tinker.patch'

```



If your app has a class that subclasses android.app.Application, then you need to modify that class, and move all its implements to [SampleApplicationLike](https://github.com/Tencent/tinker/blob/master/tinker-sample-android/app/src/main/java/tinker/sample/android/app/SampleApplicationLike.java) rather than Application:



```java

-public class YourApplication extends Application {

+public class SampleApplicationLike extends DefaultApplicationLike {

```



Now you should change your `Application` class, make it a subclass of [TinkerApplication](https://github.com/Tencent/tinker/blob/master/tinker-android/tinker-android-loader/src/main/java/com/tencent/tinker/loader/app/TinkerApplication.java). As you can see from its API, it is an abstract class that does not have a default constructor, so you must define a no-arg constructor:



```java

public class SampleApplication extends TinkerApplication {

    public SampleApplication() {

      super(

        //tinkerFlags, which types is supported

        //dex only, library only, all support

        ShareConstants.TINKER_ENABLE_ALL,

        // This is passed as a string so the shell application does not

        // have a binary dependency on your ApplicationLifeCycle class.

        "tinker.sample.android.app.SampleApplicationLike");

    }

}

```



Use `tinker-android-anno` to generate your `Application` is recommended, you just need to add an annotation for your [SampleApplicationLike](https://github.com/Tencent/tinker/blob/master/tinker-sample-android/app/src/main/java/tinker/sample/android/app/SampleApplicationLike.java) class



```java

@DefaultLifeCycle(

application = "tinker.sample.android.app.SampleApplication",             //application name to generate

flags = ShareConstants.TINKER_ENABLE_ALL)                                //tinkerFlags above

public class SampleApplicationLike extends DefaultApplicationLike

```



How to install tinker? learn more at the sample [SampleApplicationLike](https://github.com/Tencent/tinker/blob/master/tinker-sample-android/app/src/main/java/tinker/sample/android/app/SampleApplicationLike.java).



For proguard, we have already made the proguard config automatic, and tinker will also generate the multiDex keep proguard file for you.



For more tinker configurations, learn more at the sample [app/build.gradle](https://github.com/Tencent/tinker/blob/master/tinker-sample-android/app/build.gradle).



## Ark Support

How to run tinker on the Ark?

### building patch

Just use the following command:

```buildconfig

bash build_patch_dexdiff.sh old=xxx new=xxx

```

* `old` indicates the absolute path of android apk(not compiled by Ark) with bugs

* `new` indicates the absolute path of android apk(not compiled by Ark) with fixing



The patch file is packaged in APK.

### compiling in Ark

TODO



At present it's compiled by Ark compiler team. The output patch is still packaged in APK format without signature.

### packaging the patch

For tinker-cli, add the following lines to your `tinker_config.xml`. Otherwise, the default configure will be used.

```xml



            // path of patch

         // name of patch



```

For gradle, add the following lines to your `app/build.gradle`. Otherwise, the default configure will be used.

```gradle

ark {

   path = "arkHot"         // path of patch

   name = "patch.apk"      // name of patch

}

```

The patch is compiled by Ark and placed on the above path. all subsequent operations are same as tinker-cli or gradle.



The ultimated patch APK consists of two patch files:



* `classes.dex` for android

* `patch.apk` with so for Ark.



## Tinker Known Issues

There are some issues which Tinker can't dynamic update.



1. Can't update AndroidManifest.xml, such as add Android Component.

2. Do not support some Samsung models with os version android-21.

3. Due to Google Play Developer Distribution Agreement, we can't dynamic update our apk.



## Tinker Support

Any problem?



1. Learn more from [tinker-sample-android](https://github.com/Tencent/tinker/tree/master/tinker-sample-android).

2. Read the [source code](https://github.com/Tencent/tinker/tree/master).

3. Read the [wiki](https://github.com/Tencent/tinker/wiki) or [FAQ](https://github.com/Tencent/tinker/wiki/Tinker-%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98) for help.

4. Contact us for help.



## Contributing

For more information about contributing issues or pull requests, see our [Tinker Contributing Guide](https://github.com/Tencent/tinker/blob/master/CONTRIBUTING.md).



## License

Tinker is under the BSD license. See the [LICENSE](https://github.com/Tencent/tinker/blob/master/LICENSE) file for details.