Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RikkaApps/HiddenApiRefinePlugin
A Gradle plugin that improves the experience when developing Android apps, especially system tools, that use hidden APIs.
https://github.com/RikkaApps/HiddenApiRefinePlugin
android
Last synced: about 2 months ago
JSON representation
A Gradle plugin that improves the experience when developing Android apps, especially system tools, that use hidden APIs.
- Host: GitHub
- URL: https://github.com/RikkaApps/HiddenApiRefinePlugin
- Owner: RikkaApps
- License: mit
- Created: 2021-04-29T03:38:40.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-29T06:21:05.000Z (11 months ago)
- Last Synced: 2024-06-01T23:37:25.049Z (4 months ago)
- Topics: android
- Language: Java
- Homepage:
- Size: 228 KB
- Stars: 247
- Watchers: 12
- Forks: 15
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# HiddenApiRefinePlugin
A Gradle plugin that improves the experience when developing Android apps, especially system tools, that use hidden APIs.
## Background
When developing system tools, it's inevitable to use hidden APIs. There are two ways to use hidden APIs, the reflection way and the linking way. For some types of system tools, a large amount of hidden APIs is required, using the reflection way is too inconvenient. So the linking way is commonly used in those projects.
In short, the linking way is to create Java-only modules with stub classes and then `compileOnly` them in the main Android modules. This is the same as what Android SDK's `android.jar` does.
However, the linking way, or "the stub way", have some problems:
1. "Bridge classes" is required if only some members of the class are hidden.
2. Kotlin will try to link public classes from the stub module, `implementation` a second Java-only which `compileOnly` the stub module can workaround the problem.
3. Interface implementation will be removed by R8 if the stub module is not `compileOnly` directly from the main module, however doing this will bring back problem 2.
This plugin is to solve these problems.
## What do this plugin do
This plugin uses the Transform API of the Android Gradle Plugin to create a transform that modifies class names, the names are user specified by annotation `@RefineAs`. So that all the problems will be gone and the stub module does not need to be a Java-only module.
The idea and the implementation is from [@Kr328](https://github.com/Kr328).
## Usage
Replace all the `` below with the version shows here.
### Create "hidden-api" module
1. Create a new Android library module
2. Add annotation dependency
```gradle
dependencies {
annotationProcessor 'dev.rikka.tools.refine:annotation-processor:'
compileOnly 'dev.rikka.tools.refine:annotation:'
}
```
3. Add the hidden classes
Here, we use a hidden `PackageManager` API as the example.
```java
package android.content.pm;
import dev.rikka.tools.refine.RefineAs;
@RefineAs(PackageManager.class)
public class PackageManagerHidden {
public interface OnPermissionsChangedListener {
void onPermissionsChanged(int uid);
}
public void addOnPermissionsChangeListener(OnPermissionsChangedListener listener) {
throw new RuntimeException("Stub!");
}
public void removeOnPermissionsChangeListener(OnPermissionsChangedListener listener) {
throw new RuntimeException("Stub!");
}
}
```
This line `@RefineAs(PackageManager.class)` will let the plugin renames `android.app.PackageManagerHidden`/`android.app.PackageManagerHidden.OnPermissionsChangedListener` to `android.app.PackageManager`/`android.app.PackageManager.OnPermissionsChangedListener`.
### Use hidden API
1. Apply this plugin in the final Android application module
```groovy
plugins {
id('dev.rikka.tools.refine') version ''
}
```
If your project includes mulitple modules, you need to apply this plugin to all the module that uses hidden APIs.
There is a convenient way to do this, add this to your root `build.gradle`:
```groovy
subprojects {
plugins.withId("com.android.base") {
plugins.apply('dev.rikka.tools.refine')
}
}
```
2. Import "hidden-api" module with `compileOnly`
```groovy
dependencies {
compileOnly project(':hidden-api')
}
```
3. Import the "Refine" class (Optional, if you don't need the "unsafeCast" method)
```gradle
dependencies {
implementation("dev.rikka.tools.refine:runtime:")
}
```
4. Use the hidden API
```java
Refine.unsafeCast(context.getPackageManager())
.addOnPermissionsChangeListener(new PackageManagerHidden.OnPermissionsChangedListener() {
@Override
public void onPermissionsChanged(int uid) {
// do staff
}
});
```
After R8, this "cast" will be "removed" or "inlined". This line will be identical to a normal method call.