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 impossible 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, 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:
- "Bridge classes" is required if only some members of the class are hidden.
- Kotlin will try to link public classes from the stub module,
implementationa second Java-only whichcompileOnlythe stub module can workaround the problem. - Interface implementation will be removed by R8 if the stub module is not
compileOnlydirectly 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 removes specific prefixes from class names. So we can add a special prefix (e.g., '$') to stub classes, and all the problems will be gone and the stub module does not need to be a Java-only module.
The idea is from @Kr328.
Usage
Root project:
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'dev.rikka.tools:hidden-api-refine:1.0.0'
}
}
Module:
plugins {
id('dev.rikka.tools.hidden-api-refine')
}
hiddenApiRefine {
// Prefix to remove, default is ['$']
refinePrefix = ['$']
// Print log, default is true
log = true
}
![[Ask for help]ApplicationPackageManager cannot be cast to android.view.SurfaceControl](https://avatars.githubusercontent.com/u/34941512?v=4)
![[FR] Support Gradle's configuration cache](https://avatars.githubusercontent.com/u/25247117?v=4)
27 Dec 20, 2022
2 Mar 8, 2022
0 Apr 10, 2022
142 Dec 29, 2022
1 Feb 26, 2022
56 Nov 18, 2022
228 Jan 2, 2023
1.1k Dec 28, 2022
4 Oct 11, 2021
3 May 15, 2022
38 Jan 6, 2023
306 Dec 30, 2022
235 Jan 3, 2023
28 Nov 13, 2022
502 Dec 31, 2022
491 Dec 23, 2022
8 Nov 26, 2022
110 Dec 19, 2022
262 Jan 5, 2023