tinker README

The project's README from github.com/Tencent/tinker. As one markdown file: README.md.

Tinker

license Release Version PRs Welcome WeChat Approved

中文说明

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

tinker.png

Getting started

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

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.

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 rather than Application:

-public class YourApplication extends Application {
+public class SampleApplicationLike extends DefaultApplicationLike {

Now you should change your Application class, make it a subclass of TinkerApplication. 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:

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 class

@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.

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.

Ark Support

How to run tinker on the Ark?

building patch

Just use the following command:

bash build_patch_dexdiff.sh old=xxx new=xxx

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.

<issue id="arkHot">
   <path value="arkHot"/>         // path of patch
   <name value="patch.apk"/>      // name of patch
</issue>

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

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:

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.
  2. Read the source code.
  3. Read the wiki or FAQ for help.
  4. Contact us for help.

Contributing

For more information about contributing issues or pull requests, see our Tinker Contributing Guide.

License

Tinker is under the BSD license. See the LICENSE file for details.

tinker (Tencent/tinker)

Searching Database…

17.7K ·GitHub
Tinker
Что это такое?Tinker — это библиотека для хотфиксов в Android, которая позволяет доставлять пользователям обновления dex, нативных библиотек и ресурсов без переустановки APK.
Это отдельное приложение или то, что я добавляю в свой проект?Это библиотека и Gradle-плагин (tinker-gradle-plugin), который вы встраиваете в существующую сборку Android-приложения.
Как добавить Tinker в моё приложение?Добавьте tinker-gradle-plugin в корневой build.gradle, примените плагин и добавьте зависимости в app/build.gradle, перенесите логику вашего подкласса Application в класс SampleApplicationLike, а ваш основной класс Application сделайте наследником TinkerApplication с конструктором без аргументов.
Нужно ли что-то ещё, кроме добавления плагина?Нужен класс Android Application, который можно перестроить, и по желанию tinker-android-anno для автоматической генерации подключения Application; конфигурацию Proguard плагин обрабатывает автоматически.
Что Tinker не может обновить через хотфикс?Tinker не может обновлять AndroidManifest.xml (например, добавлять новые компоненты), есть проблемы на некоторых устройствах Samsung с Android 21, а Соглашение о распространении для разработчиков Google Play блокирует динамические обновления APK.
Для какой платформы это предназначено?Только для Android-приложений, которые собираются через Java/Gradle.
Что такое поддержка Ark, о которой говорится в README?Ark — это режим компиляции, при котором патчи собираются через инструмент командной строки и упаковываются в APK, содержащий и classes.dex (для обычного Android), и файл .so (для Ark). Саму компиляцию Ark выполняет команда Ark compiler.
Можно ли собирать и упаковывать патчи без Gradle?Да, в качестве альтернативы Gradle-плагину поддерживается tinker-cli, а настройка патчей может задаваться через файл tinkerconfig.xml.
What are similar projects?MVPArms, ARouter, androidannotations, glide, Android-PickerView, QMUI_Android, okhttp-OkGo, MPAndroidChart
Which topics is it in?android-library, wechat, mobile-app, bsd, china, java, mobile, android, framework, chinese, library, open-source
Creator
Tencent
Size
7.1 MB
Stars
17.7K
Updated
CommitOct 12Releasev1.9.15.2Jul 07
Age
10y
Commits · 90 Days