Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eleme/amigo
A hotfix library for Android platform, and not just this...
https://github.com/eleme/amigo
android hotfix
Last synced: 5 days ago
JSON representation
A hotfix library for Android platform, and not just this...
- Host: GitHub
- URL: https://github.com/eleme/amigo
- Owner: eleme
- License: other
- Created: 2016-08-25T08:43:36.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-03-21T17:19:30.000Z (almost 5 years ago)
- Last Synced: 2025-02-16T16:58:08.286Z (5 days ago)
- Topics: android, hotfix
- Language: Java
- Size: 726 KB
- Stars: 1,362
- Watchers: 66
- Forks: 213
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[中文版](https://github.com/eleme/Amigo/blob/master/README_zh.md#amigo)
[wiki](https://github.com/eleme/Amigo/wiki) (deprecated)
[changelog](https://github.com/eleme/Amigo/blob/master/CHANGELOG.md)
~~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`
```groovy
buildscript {
repositories {
jcenter()
}
dependencies {
classpath 'me.ele:amigo:0.6.8'
}
}
```
In your module's `build.gradle`
```groovy
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 :v:
- 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:
```xml
```
**Note**:
- These three `meta-data` is defined in your personal `AndroidManifest.xml` of app module if necessary
- orientation's value must be in [screenOrientation](https://developer.android.com/guide/topics/manifest/activity-element.html#screen)
### 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
```java
Amigo.workLater(context, patchApkFile, callback);
```
* work immediately, App will restart immediately
```java
Amigo.work(context, patchApkFile);
```
### Remove patch
```java
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**"
```xml
```
* change the uri used to do the query, insert, delete operations:
```java
// 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` & `widget`is 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](https://github.com/eleme/bspatch) (`support whole apk diff & fine-grained diff in apk`)is an option for you
## Inspired by
[Android Patch 方案与持续交付](http://dev.qq.com/topic/57a31921ac3a1fb613dd40f3)
[DroidPlugin](https://github.com/DroidPluginTeam/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.