---
pageClass: code-page
---

::: warning

由于维护成本，`YukiHookAPI` 从 `1.3.0` 版本开始将不再会对此文档进行更新且在 `2.0.0` 版本切换为 Dokka 插件自动生成的 API 文档。

:::

# ReflectionFactory <span class="symbol">- kt</span>

**变更记录**

`v1.0` `添加`

**功能描述**

> 这是自定义 `Member` 和 `Class` 相关功能的查找匹配以及 `invoke` 的封装类。

## MembersType <span class="symbol">- class</span>

```kotlin:no-line-numbers
enum class MembersType
```

**变更记录**

`v1.1.0` `新增`

**功能描述**

> 定义一个 `Class` 中的 `Member` 类型

### ALL <span class="symbol">- enum</span>

```kotlin:no-line-numbers
ALL
```

**变更记录**

`v1.1.0` `新增`

**功能描述**

> 全部 `Method` 与 `Constructor`。

### METHOD <span class="symbol">- enum</span>

```kotlin:no-line-numbers
METHOD
```

**变更记录**

`v1.1.0` `新增`

**功能描述**

> 全部 `Method`。

### CONSTRUCTOR <span class="symbol">- enum</span>

```kotlin:no-line-numbers
CONSTRUCTOR
```

**变更记录**

`v1.1.0` `新增`

**功能描述**

> 全部 `Constructor`。

## LazyClass <span class="symbol">- class</span>

```kotlin:no-line-numbers
open class LazyClass<T> internal constructor(
    private val instance: Any,
    private val initialize: Boolean,
    private val loader: ClassLoaderInitializer?
)
```

**变更记录**

`v1.2.0` `新增`

**功能描述**

> 懒装载 `Class` 实例。

## ClassLoader.listOfClasses <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
fun ClassLoader.listOfClasses(): List<String>
```

**变更记录**

`v1.1.2` `新增`

**功能描述**

> 写出当前 `ClassLoader` 下所有 `Class` 名称数组。

::: warning

此方法在 **Class** 数量过多时会非常耗时。

若要按指定规则查找一个 **Class**，请使用 [ClassLoader.searchClass](#classloader-searchclass-ext-method) 方法。

:::

## ClassLoader.searchClass <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
inline fun ClassLoader.searchClass(name: String, async: Boolean, initiate: ClassConditions): DexClassFinder.Result
```

**变更记录**

`v1.1.0` `新增`

**功能描述**

> 通过当前 `ClassLoader` 按指定条件查找并得到 **Dex** 中的 `Class`。

::: danger

此方法在 **Class** 数量过多及查找条件复杂时会非常耗时。

建议启用 **async** 或设置 **name** 参数，**name** 参数将在 Hook APP (宿主) 不同版本中自动进行本地缓存以提升效率。

此功能尚在实验阶段，性能与稳定性可能仍然存在问题，使用过程遇到问题请向我们报告并帮助我们改进。

:::

## ClassLoader.onLoadClass <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
fun ClassLoader.onLoadClass(result: (Class<*>) -> Unit)
```

**变更记录**

`v1.1.0` `新增`

**功能描述**

> 监听当前 `ClassLoader` 的 `ClassLoader.loadClass` 方法装载。

::: danger

只有当前 **ClassLoader** 有主动使用 **ClassLoader.loadClass** 事件时才能被捕获。

这是一个实验性功能，一般情况下不会用到此方法，不保证不会发生错误。

只能在 (Xposed) 宿主环境使用此功能，其它环境下使用将不生效且会打印警告信息。

:::

**功能示例**

针对一些使用特定 `ClassLoader` 装载 `Class` 的宿主应用，你可以使用此方法来监听 `Class` 加载情况。

::: warning

为了防止发生问题，你需要<u>**得到一个存在的 ClassLoader 实例**</u>来使用此功能。

:::

比如我们在 `PackageParam` 中使用 `appClassLoader`。

> 示例如下

```kotlin
appClassLoader.onLoadClass { clazz ->
    // 得到 clazz 即加载对象
    clazz... // 这里进行你需要的操作
}
```

或使用你得到的存在的 `ClassLoader` 实例，可以通过 Hook 获取。

> 示例如下

```kotlin
val customClassLoader: ClassLoader? = ... // 假设这个就是你的 ClassLoader
customClassLoader?.onLoadClass { clazz ->
    // ...
}
```

在判断到这个 `Class` 被装载成功时，开始执行你的 Hook 功能。

> 示例如下

```kotlin
val customClassLoader: ClassLoader? = ... // 假设这个就是你的 ClassLoader
customClassLoader?.onLoadClass { clazz ->
    if(clazz.name == /** 你需要的 Class 名称 */) {
        clazz.hook {
            // ...
        }
    }
}
```

<h2 class="deprecated">hookClass - field</h2>

**变更记录**

`v1.0` `添加`

`v1.1.0` `移除`

`HookClass` 相关功能不再对外开放

<h2 class="deprecated">normalClass - field</h2>

**变更记录**

`v1.0` `添加`

`v1.1.0` `移除`

`HookClass` 相关功能不再对外开放

<h2 class="deprecated">hasClass - field</h2>

**变更记录**

`v1.0` `添加`

`v1.1.0` `移除`

请直接使用 `hasClass()` 无参方法

## Class.hasExtends <span class="symbol">- ext-field</span>

```kotlin:no-line-numbers
val Class<*>.hasExtends: Boolean
```

**变更记录**

`v1.0.80` `新增`

**功能描述**

> 当前 `Class` 是否有继承关系，父类是 `Any` 将被认为没有继承关系。

## Class?.extends <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
infix fun Class<*>?.extends(other: Class<*>?): Boolean
```

**变更记录**

`v1.1.5` `新增`

**功能描述**

> 当前 `Class` 是否继承于 `other`。

如果当前 `Class` 就是 `other` 也会返回 `true`。

如果当前 `Class` 为 `null` 或 `other` 为 `null` 会返回 `false`。

**功能示例**

你可以使用此方法来判断两个 `Class` 是否存在继承关系。

> 示例如下

```kotlin
// 假设下面这两个 Class 就是你需要判断的 Class
val classA: Class<*>?
val classB: Class<*>?
// 判断 A 是否继承于 B
if (classA extends classB) {
    // Your code here.
}
```

## Class?.notExtends <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
infix fun Class<*>?.notExtends(other: Class<*>?): Boolean
```

**变更记录**

`v1.1.5` `新增`

**功能描述**

> 当前 `Class` 是否不继承于 `other`。

此方法相当于 `extends` 的反向判断。

**功能示例**

你可以使用此方法来判断两个 `Class` 是否不存在继承关系。

> 示例如下

```kotlin
// 假设下面这两个 Class 就是你需要判断的 Class
val classA: Class<*>?
val classB: Class<*>?
// 判断 A 是否不继承于 B
if (classA notExtends classB) {
    // Your code here.
}
```

## Class?.implements <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
infix fun Class<*>?.implements(other: Class<*>?): Boolean
```

**变更记录**

`v1.1.5` `新增`

**功能描述**

> 当前 `Class` 是否实现了 `other` 接口类。

如果当前 `Class` 为 `null` 或 `other` 为 `null` 会返回 `false`。

**功能示例**

你可以使用此方法来判断两个 `Class` 是否存在依赖关系。

> 示例如下

```kotlin
// 假设下面这两个 Class 就是你需要判断的 Class
val classA: Class<*>?
val classB: Class<*>?
// 判断 A 是否实现了 B 接口类
if (classA implements classB) {
    // Your code here.
}
```

## Class?.notImplements <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
infix fun Class<*>?.notImplements(other: Class<*>?): Boolean
```

**变更记录**

`v1.1.5` `新增`

**功能描述**

> 当前 `Class` 是否未实现 `other` 接口类。

此方法相当于 `implements` 的反向判断。

**功能示例**

你可以使用此方法来判断两个 `Class` 是否不存在依赖关系。

> 示例如下

```kotlin
// 假设下面这两个 Class 就是你需要判断的 Class
val classA: Class<*>?
val classB: Class<*>?
// 判断 A 是否未实现 B 接口类
if (classA notImplements classB) {
    // Your code here.
}
```

## Class.toJavaPrimitiveType <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
fun Class<*>.toJavaPrimitiveType(): Class<*>
```

**变更记录**

`v1.1.5` `新增`

**功能描述**

> 自动转换当前 `Class` 为 Java 原始类型 (Primitive Type)。

如果当前 `Class` 为 Java 或 Kotlin 基本类型将自动执行类型转换。

当前能够自动转换的基本类型如下。

- `kotlin.Unit`
- `java.lang.Void`
- `java.lang.Boolean`
- `java.lang.Integer`
- `java.lang.Float`
- `java.lang.Double`
- `java.lang.Long`
- `java.lang.Short`
- `java.lang.Character`
- `java.lang.Byte`

<h2 class="deprecated">classOf - method</h2>

**变更记录**

`v1.0` `添加`

`v1.1.0` `作废`

请转到 `toClass(...)` 方法

## String.toClass <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
fun String.toClass(loader: ClassLoader?, initialize: Boolean): Class<*>
```

```kotlin:no-line-numbers
inline fun <reified T> String.toClass(loader: ClassLoader?, initialize: Boolean): Class<T>
```

**变更记录**

`v1.1.0` `新增`

`v1.1.5` `修改`

新增泛型返回值 `Class<T>` 方法

新增 `initialize` 参数

**功能描述**

> 通过字符串类名转换为 `loader` 中的实体类。

**功能示例**

你可以直接填写你要查找的目标 `Class`，必须在默认 `ClassLoader` 下存在。

> 示例如下

```kotlin
"com.example.demo.DemoClass".toClass()
```

你还可以自定义 `Class` 所在的 `ClassLoader`。

> 示例如下

```kotlin
val customClassLoader: ClassLoader? = ... // 假设这个就是你的 ClassLoader
"com.example.demo.DemoClass".toClass(customClassLoader)
```

你还可以指定 `Class` 的目标类型。

> 示例如下

```kotlin
// 指定的 DemoClass 必须存在或为可访问的 stub
"com.example.demo.DemoClass".toClass<DemoClass>()
```

你还可以设置在获取到这个 `Class` 时是否自动执行其默认的静态方法块，默认情况下不会执行。

> 示例如下

```kotlin
// 获取并执行 DemoClass 默认的静态方法块
"com.example.demo.DemoClass".toClass(initialize = true)
```

默认的静态方法块在 Java 中使用如下方式定义。

> 示例如下

```java:no-line-numbers
public class DemoClass {

    static {
        // 这里是静态方法块的内容
    }

    public DemoClass() {
        // ...
    }
}
```

## String.toClassOrNull <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
fun String.toClassOrNull(loader: ClassLoader?, initialize: Boolean): Class<*>?
```

```kotlin:no-line-numbers
inline fun <reified T> String.toClassOrNull(loader: ClassLoader?, initialize: Boolean): Class<T>?
```

**变更记录**

`v1.1.0` `新增`

`v1.1.5` `修改`

新增泛型返回值 `Class<T>` 方法

新增 `initialize` 参数

**功能描述**

> 通过字符串类名转换为 `loader` 中的实体类。

找不到 `Class` 会返回 `null`，不会抛出异常。

**功能示例**

用法请参考 [String.toClass](#string-toclass-ext-method) 方法。

## classOf <span class="symbol">- method</span>

```kotlin:no-line-numbers
inline fun <reified T> classOf(loader: ClassLoader?, initialize: Boolean): Class<T>
```

**变更记录**

`v1.1.0` `新增`

`v1.1.5` `修改`

将返回类型由 `Class<*>` cast 为 `Class<T>`

新增 `initialize` 参数

**功能描述**

> 通过 `T` 得到其 `Class` 实例并转换为实体类。

**功能示例**

我们要获取一个 `Class` 在 Kotlin 下不通过反射时应该这样做。

> 示例如下

```kotlin
DemoClass::class.java
```

现在，你可以直接 `cast` 一个实例并获取它的 `Class` 对象，必须在当前 `ClassLoader` 下存在。

> 示例如下

```kotlin
classOf<DemoClass>()
```

若目标存在的 `Class` 为 `stub`，通过这种方式，你还可以自定义 `Class` 所在的 `ClassLoader`。

> 示例如下

```kotlin
val customClassLoader: ClassLoader? = ... // 假设这个就是你的 ClassLoader
classOf<DemoClass>(customClassLoader)
```

## lazyClass <span class="symbol">- method</span>

```kotlin:no-line-numbers
fun lazyClass(name: String, initialize: Boolean, loader: ClassLoaderInitializer?): LazyClass.NonNull<Any>
```

```kotlin:no-line-numbers
inline fun <reified T> lazyClass(name: String, initialize: Boolean, loader: ClassLoaderInitializer?): LazyClass.NonNull<T>
```

```kotlin:no-line-numbers
fun lazyClass(variousClass: VariousClass, initialize: Boolean, loader: ClassLoaderInitializer?): LazyClass.NonNull<Any>
```

**变更记录**

`v1.2.0` `新增`

**功能描述**

> 懒装载 `Class`。

## lazyClassOrNull <span class="symbol">- method</span>

```kotlin:no-line-numbers
fun lazyClassOrNull(name: String, initialize: Boolean, loader: ClassLoaderInitializer?): LazyClass.Nullable<Any>
```

```kotlin:no-line-numbers
inline fun <reified T> lazyClassOrNull(name: String, initialize: Boolean, loader: ClassLoaderInitializer?): LazyClass.Nullable<T>
```

```kotlin:no-line-numbers
fun lazyClassOrNull(variousClass: VariousClass, initialize: Boolean, loader: ClassLoaderInitializer?): LazyClass.Nullable<Any>
```

**变更记录**

`v1.2.0` `新增`

**功能描述**

> 懒装载 `Class`。

## String.hasClass <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
fun String.hasClass(loader: ClassLoader?): Boolean
```

**变更记录**

`v1.0` `添加`

`v1.1.0` `修改`

支持直接使用空参数方法使用默认 `ClassLoader` 进行判断

**功能描述**

> 通过字符串类名使用指定的 `ClassLoader` 查找是否存在。

**功能示例**

你可以轻松的使用此方法判断字符串中的类是否存在，效果等同于直接使用 `Class.forName`。

> 示例如下

```kotlin
if("com.example.demo.DemoClass".hasClass()) {
    // Your code here.
}
```

填入方法中的 `loader` 参数可判断指定的 `ClassLoader` 中的 `Class` 是否存在。

> 示例如下

```kotlin
val customClassLoader: ClassLoader? = ... // 假设这个就是你的 ClassLoader
if("com.example.demo.DemoClass".hasClass(customClassLoader)) {
    // Your code here.
}
```

## Class.hasField <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
inline fun Class<*>.hasField(initiate: FieldConditions): Boolean
```

**变更记录**

`v1.0.4` `新增`

`v1.0.67` `修改`

合并到 `FieldFinder`

`v1.0.80` `修改`

将方法体进行 inline

**功能描述**

> 查找变量是否存在。

## Class.hasMethod <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
inline fun Class<*>.hasMethod(initiate: MethodConditions): Boolean
```

**变更记录**

`v1.0` `添加`

`v1.0.1` `修改`

新增 `returnType` 参数

`v1.0.67` `修改`

合并到 `MethodFinder`

`v1.0.80` `修改`

将方法体进行 inline

**功能描述**

> 查找方法是否存在。

## Class.hasConstructor <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
inline fun Class<*>.hasConstructor(initiate: ConstructorConditions): Boolean
```

**变更记录**

`v1.0.2` `新增`

`v1.0.67` `修改`

合并到 `ConstructorFinder`

`v1.0.80` `修改`

将方法体进行 inline

**功能描述**

> 查找构造方法是否存在。

## Member.hasModifiers <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
inline fun Member.hasModifiers(conditions: ModifierConditions): Boolean
```

**变更记录**

`v1.0.67` `新增`

`v1.0.80` `修改`

将方法体进行 inline

`v1.1.0` `修改`

合并到 `ModifierConditions`

**功能描述**

> 查找 `Member` 中匹配的描述符。

## Class.hasModifiers <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
inline fun Class<*>.hasModifiers(conditions: ModifierConditions): Boolean
```

**变更记录**

`v1.1.0` `新增`

**功能描述**

> 查找 `Class` 中匹配的描述符。

<h2 class="deprecated">obtainStaticFieldAny - method</h2>

**变更记录**

`v1.0` `添加`

`v1.0.1` `移除`

<h2 class="deprecated">obtainFieldAny - method</h2>

**变更记录**

`v1.0` `添加`

`v1.0.1` `移除`

<h2 class="deprecated">modifyStaticField - method</h2>

**变更记录**

`v1.0` `添加`

`v1.0.1` `移除`

<h2 class="deprecated">modifyField - method</h2>

**变更记录**

`v1.0` `添加`

`v1.0.1` `移除`

## Class.field <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
inline fun Class<*>.field(initiate: FieldConditions): FieldFinder.Result
```

**变更记录**

`v1.0.2` `新增`

`v1.0.80` `修改`

将方法体进行 inline

**功能描述**

> 查找并得到变量。

## Class.method <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
inline fun Class<*>.method(initiate: MethodConditions): MethodFinder.Result
```

**变更记录**

`v1.0` `添加`

`v1.0.1` `修改`

~~`obtainMethod`~~ 更名为 `method`

新增 `returnType` 参数

`v1.0.2` `修改`

合并到 `MethodFinder` 方法体

`v1.0.80` `修改`

将方法体进行 inline

**功能描述**

> 查找并得到方法。

## Class.constructor <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
inline fun Class<*>.constructor(initiate: ConstructorConditions): ConstructorFinder.Result
```

**变更记录**

`v1.0` `添加`

`v1.0.1` `修改`

~~`obtainConstructor`~~ 更名为 `constructor`

`v1.0.2` `修改`

合并到 `ConstructorFinder` 方法体

`v1.0.80` `修改`

将方法体进行 inline

**功能描述**

> 查找并得到构造方法。

<h2 class="deprecated">callStatic - method</h2>

**变更记录**

`v1.0` `添加`

`v1.0.1` `修改`

~~`invokeStatic`~~ 更名为 `callStatic`

`v1.0.2` `移除`

<h2 class="deprecated">call - method</h2>

**变更记录**

`v1.0` `添加`

`v1.0.1` `修改`

~~`invokeAny`~~ 更名为 `call`

`v1.0.2` `移除`

## Class.generic <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
fun Class<*>.generic(): GenericClass?
```

**变更记录**

`v1.1.0` `新增`

**功能描述**

> 获得当前 `Class` 的泛型父类。

如果当前实例不存在泛型将返回 `null`。

## Class.generic <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
inline fun Class<*>.generic(initiate: GenericClass.() -> Unit): GenericClass?
```

**变更记录**

`v1.1.0` `新增`

**功能描述**

> 获得当前 `Class` 的泛型父类。

如果当前实例不存在泛型将返回 `null`。

## Any.current <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
inline fun <reified T : Any> T.current(ignored: Boolean): CurrentClass
```

```kotlin:no-line-numbers
inline fun <reified T : Any> T.current(ignored: Boolean, initiate: CurrentClass.() -> Unit): T
```

**变更记录**

`v1.0.70` `新增`

`v1.1.0` `新增`

新增 `ignored` 参数，可以忽略在 `CurrentClass` 中出现的异常

新增不使用 `current { ... }` 调用域直接使用 `current()` 得到实例的类操作对象

**功能描述**

> 获得当前实例的类操作对象。

<h2 class="deprecated">Class.buildOfAny - ext-method</h2>

**变更记录**

`v1.0.70` `新增`

`v1.0.80` `修改`

将方法体进行 inline

`v1.1.0` `作废`

请迁移到 `buildOf` 方法

## Class.buildOf <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
inline fun Class<*>.buildOf(vararg args: Any?, initiate: ConstructorConditions): Any?
```

```kotlin:no-line-numbers
inline fun <T> Class<*>.buildOf(vararg args: Any?, initiate: ConstructorConditions): T?
```

**变更记录**

`v1.0.70` `新增`

`v1.0.80` `修改`

将方法体进行 inline

`v1.1.0` `修改`

加入无泛型方法 `buildOf`

`v1.1.6` `修改`

修改参数命名 `param` 为 `args`

**功能描述**

> 通过构造方法创建新实例，指定类型 `T` 或任意类型 `Any`。

## Class.allMethods <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
inline fun Class<*>.allMethods(isAccessible: Boolean, result: (index: Int, method: Method) -> Unit)
```

**变更记录**

`v1.0.70` `新增`

`v1.0.80` `修改`

将方法体进行 inline

`v1.1.5` `修改`

新增 `isAccessible` 参数

**功能描述**

> 遍历当前类中的所有方法。

## Class.allConstructors <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
inline fun Class<*>.allConstructors(isAccessible: Boolean, result: (index: Int, constructor: Constructor<*>) -> Unit)
```

**变更记录**

`v1.0.70` `新增`

`v1.0.80` `修改`

将方法体进行 inline

`v1.1.5` `修改`

新增 `isAccessible` 参数

**功能描述**

> 遍历当前类中的所有构造方法。

## Class.allFields <span class="symbol">- ext-method</span>

```kotlin:no-line-numbers
inline fun Class<*>.allFields(isAccessible: Boolean, result: (index: Int, field: Field) -> Unit)
```

**变更记录**

`v1.0.70` `新增`

`v1.0.80` `修改`

将方法体进行 inline

`v1.1.5` `修改`

新增 `isAccessible` 参数

**功能描述**

> 遍历当前类中的所有变量。