eleme / Amigo

中文版

wiki (deprecated)

changelog

Amigo Service Platform (Amigo backend service is no longer supported)

Amigo is a hotfix library which can fix everything for your Android app

How to use

Download

In your project's build.gradle

buildscript {
    repositories {
        jcenter()
    }

    dependencies {
        classpath 'me.ele:amigo:0.6.8'
    }
}

In your module's build.gradle

apply plugin: 'me.ele.amigo'

android {
...
}

dependencies {
    ...
    compile 'me.ele:amigo-lib:0.6.7'
}

//if you don't want use amigo in dev, set this value to true
//you can define this extension in your mybuild.gradle as to distinguish debug & release build
amigo {
    disable false //default false
    autoDisableInInstantRunMode true // default false
}

Compatibility

• Supports All Devices From ECLAIR 2.1 to Nougat 7.1
• Even support next Android version, no matter small or big change. So Cool, Aha ✌️
• Android 3.0 isn't supported

Customize loading page(optional)

Some time-consuming tasks are handled in a separate process to avoid ANR, you can customize the loading activity by add the follow code into your AndroidManifest.xml:

<meta-data
    android:name="amigo_layout"
    android:value="{your-layout-name}" />

<meta-data
    android:name="amigo_theme"
    android:value="{your-theme-name}" />

<meta-data
    android:name="amigo_orientation"
    android:value="{your-custom-orientation}"/>

Note:

• These three meta-data is defined in your personal AndroidManifest.xml of app module if necessary
• orientation's value must be in screenOrientation

Make hotfix work

There are two ways to make hotfix work.

• if you don't need hotfix work immediately

  you just need to download new apk file, hotfix apk will be loaded as fresh as new when app restarts next time

   Amigo.workLater(context, patchApkFile, callback);
  

• work immediately, App will restart immediately

   Amigo.work(context, patchApkFile);
  

Remove patch

Amigo.clear(context);

note：All patch files would be deleted on the next start up.

Demo

And there is an Demo page in the app demonstrating how to apply patch apk. Run the task ./gradlew runHost preparePatch, and navigate to the demo page.

Development

Amigo gradle plugin

The plugin was put into buildSrc directory, which means the plugin code change will work immediately each time you build.

Amigo lib

The amigo plugin will select the right amigo lib automatically.

Run tests

There are two gradle tasks provided in the app/build.gradle, :app:runHost, :app:preparePatch, which can accelerate development.

• ./gradlew runHost, launch the host app
• ./gradlew preparePatch, build and push the patch apk to the device
• apply the patch apk in the Demo page

Limits

• have to change the way using a content provider

  • declare a new provider: the authorities string must start with "${youPackageName}.provider"

    <provider
        android:name="me.ele.demo.provider.StudentProvider"
        android:authorities="${youPackageName}.provider.student" />
    

  • change the uri used to do the query, insert, delete operations:

    // 1. inside your app process, no modifications need:
    Cursor cursor = getContentResolver().query(Uri.parse("content://" + getPackageName() + ".provider.student?id=0"), null, null, null, null);
    // 2. in another process, have to change the authorities uri like the following :
    Cursor cursor = getContentResolver().query(Uri.parse("content://" + targetPackageName + ".provider/student?id=0"), null, null, null, null);
    

• Instant Run conflicts with Amigo, so disable Instant Run when used with amigo(Or use autoDisableInInstantRunMode to auto disable amigo in instant run mode)

• Amigo doesn't support Honeycomb 3.0

  • Android 3.0 is a version with full of bugs, & Google has closed Android 3.0 Honeycomb.

• RemoteViews's layout change in notification & widgetis not support

  • any resource id in here should be used with java RCompat.getHostIdentifier(Context context, int id)

Retrieve hotfix file

• make it simple, you just need a fully new apk

• to save the internet traffic, you may just want to download a diff file bspatch (support whole apk diff & fine-grained diff in apk)is an option for you

Inspired by

Android Patch 方案与持续交付

DroidPlugin

License

  Copyright 2016 ELEME Inc.

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.