docs: update move-to-new-api

This commit is contained in:
2025-01-13 12:56:05 +08:00
parent 7f97ad7197
commit d6db8925c9
2 changed files with 87 additions and 0 deletions

View File

@@ -260,6 +260,50 @@ override fun replaceHookedMethod(param: MethodHookParam) = null
:::
::::
### Notes on Migrating XposedHelpers
The reflection functionality provided in `YukiHookAPI` differs from the reflection functionality of `XposedHelpers`.
Here is a guide to avoid common pitfalls.
Methods like `XposedHelpers.callMethod` and `XposedHelpers.callStaticMethod` automatically search and invoke all public methods (including those in superclasses), which is a feature of native Java reflection. In contrast, the reflection solution provided by `YukiHookAPI` first searches and then calls, and by default, the search process does not automatically look for methods in superclasses.
For example, class `A` inherits from `B`, and `B` has a public method `test`, while `A` does not.
```java
public class B {
public void test(String a) {
// ...
}
}
public class A extends B {
// ...
}
```
Usage with `XposedHelpers`.
```kotlin
val instance: A = ...
XposedHelpers.callMethod(instance, "test", "some string")
```
Usage with `YukiHookAPI`.
```kotlin
val instance: A = ...
instance.current().method {
name = "test"
// Note that you need to add this search condition to ensure it searches for methods in superclasses.
superClass()
}.call("some string")
// Or directly call the superClass() method.
instance.current().superClass()?.method {
name = "test"
}?.call("some string")
```
## Migrate More Functions Related to Hook API
`YukiHookAPI` is a brand new Hook API, which is fundamentally different from other Hook APIs, you can refer to [API Document](../api/home) and [Special Features](../api/special-features/reflection) to determine some functional Migration and use.

View File

@@ -260,6 +260,49 @@ override fun replaceHookedMethod(param: MethodHookParam) = null
:::
::::
### 迁移 XposedHelpers 注意事项
`YukiHookAPI` 中提供的反射功能与 `XposedHelpers` 的反射功能有所不同,这里提供一个误区指引。
`XposedHelpers.callMethod``XposedHelpers.callStaticMethod` 等方法自动查找的方法会自动调用所有公开的方法 (包括 `super` 超类),这是 Java 原生反射的特性,
`YukiHookAPI` 提供的反射方案为先反射查找再调用,而查找过程默认不会自动查找 `super` 超类的方法。
例如,类 `A` 继承于 `B` `B` 中存在公开的方法 `test`,而 `A` 中并不存在。
```java
public class B {
public void test(String a) {
// ...
}
}
public class A extends B {
// ...
}
```
此时 `XposedHelpers` 的用法。
```kotlin
val instance: A = ...
XposedHelpers.callMethod(instance, "test", "some string")
```
`YukiHookAPI` 的用法。
```kotlin
val instance: A = ...
instance.current().method {
name = "test"
// 请注意,这里需要添加此查找条件以确保其会查找超类的方法
superClass()
}.call("some string")
// 或者直接调用 superClass() 方法
instance.current().superClass()?.method {
name = "test"
}?.call("some string")
```
## 迁移更多有关 Hook API 的功能
`YukiHookAPI` 是一套全新的 Hook API与其它 Hook API 存在着本质区别,你可以参考 [API 文档](../api/home) 以及 [特色功能](../api/special-features/reflection) 来决定一些功能性的迁移和使用。