https://github.com/iqiyi/neptune
A flexible, powerful and lightweight plugin framework for Android
https://github.com/iqiyi/neptune
android dynamic lightweight plugin-framework
Last synced: 7 months ago
JSON representation
A flexible, powerful and lightweight plugin framework for Android
- Host: GitHub
- URL: https://github.com/iqiyi/neptune
- Owner: iqiyi
- License: apache-2.0
- Created: 2018-09-19T15:26:14.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-08-19T14:13:43.000Z (about 6 years ago)
- Last Synced: 2025-03-28T23:03:12.979Z (7 months ago)
- Topics: android, dynamic, lightweight, plugin-framework
- Language: Java
- Homepage:
- Size: 74.8 MB
- Stars: 766
- Watchers: 37
- Forks: 113
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Neptune
**Neptune is a flexible, powerful and lightweight plugin framework for Android.**
It now runs plugins dynamically on billions of devices every day and carries many separated business modules of IQIYI such as Reader, Movie Tickets and etc..
Especially, Neptune is greatly compatible with Android P . It can run on Android P devices seamlessly and stably. Only few APIs in light greylist are used.
[中文文档](README_CN.md)
# Supported Features
| Feature | Detail |
| :------ | :-----: |
| Supported Components | Activity/Service/Receiver |
| Component registration in Host Manifest.xml | No Need |
| Share Host App Class | Supported |
| Share Host App Resources | Supported |
| Resources Isolation | Supported |
| Run individual App | Supported |
| Android Features | Almost all features |
| Compatibility | Almost all roms |
| Process Isolation | Supported |
| Plugin Dependency | Supported |
| Plugin Development | like normal app |
| Supported Android versions | API Level 14+ |
# Architecture
# Getting Started
## Host Project
compile Neptune in application module of `build.gradle`.
```Gradle
implementation 'org.qiyi.video:neptune:2.7.0'
```
Initialize sdk in your `Application#onCreate()`.
```Java
public class XXXApplication extends Application {
@Override
public void onCreate() {
NeptuneConfig config = new NeptuneConfig.NeptuneConfigBuilder()
.configSdkMode(NeptuneConfig.INSTRUMENTATION_MODE)
.enableDebug(BuildConfig.DEBUG)
.build();
Neptune.init(this, config);
}
}
```
more details and developer guide see wiki
## Plugin Project
If plugin app wants to share resources with host app, you need add dependency in the `buildscript` block of `build.gradle` in root of plugin project as following.
```Gradle
dependencies {
classpath 'com.iqiyi.tools.build:neptune-gradle:1.4.0'
}
```
Apply gradle plugin in application module of `build.gradle` and config it.
```Gradle
apply plugin: 'com.qiyi.neptune.plugin'
neptune {
pluginMode = true // In plugin apk build mode
packageId = 0x30 // The package id of Resources
hostDependencies = "{group1}:{artifact1};{group2}:{artifact2}" // host app resources dependencies
}
```
# Developer Guide
* [API document wiki](https://github.com/iqiyi/Neptune/wiki)
* [Host App Sample Project](samples/HostApp)
* [Plugin App Sample Project](samples/PluginApp)
* [Read SDKLibrary source code](SdkLibrary)
# Contribution
We sincerely appreciate your PR contribution of any kind , including codes, suggestions or documentation to improve our project.
# License
Neptune is [Apache v2.0 Licensed](LICENSE).