YukiMemberHookCreator - class

class YukiMemberHookCreator internal constructor(private val packageParam: PackageParam, private val hookClass: HookClass)

变更记录

v1.0 添加

v1.0.80 修改

对 hookClass 进行 inline 处理

v1.1.0 修改

修正拼写错误的 Creater 命名到 Creator

v1.1.5 修改

私有化构造方法

功能描述

YukiHookAPI 的 Member 核心 Hook 实现类。

PRIORITY_DEFAULT - field

变更记录

v1.0.80 新增

v1.2.0 作废

请迁移到 YukiHookPriority

PRIORITY_LOWEST - field

变更记录

v1.0.80 新增

v1.2.0 作废

请迁移到 YukiHookPriority

PRIORITY_HIGHEST - field

变更记录

v1.0.80 新增

v1.2.0 作废

请迁移到 YukiHookPriority

instanceClass - field

变更记录

v1.0 添加

v1.0.2 修改

thisClass 更名为 instanceClass

v1.2.0 作废

不再推荐使用

injectMember - method

变更记录

v1.0 添加

v1.0.80 修改

将方法体进行 inline

增加 priority Hook 优先级

v1.2.0 作废

请迁移到另一个 injectMember

injectMember - method

inline fun injectMember(priority: YukiHookPriority, initiate: MemberHookCreator.LegacyCreator.() -> Unit): MemberHookCreator.Result

变更记录

v1.2.0 新增

功能描述

注入要 Hook 的 Method、Constructor。

useDangerousOperation - method

变更记录

v1.1.0 新增

v1.2.0 作废

此功能已被弃用

MemberHookCreator - class

inner class MemberHookCreator internal constructor(private val priority: YukiHookPriority, private val hookMode: HookMode)

变更记录

v1.0 添加

v1.0.80 修改

增加 priority Hook 优先级

v1.0.81 修改

增加 packageName 当前 Hook 的 APP 包名

v1.1.0 修改

移除 packageName

修正拼写错误的 Creater 命名到 Creator

v1.2.0 修改

移除 tag

priority 类型由 Int 变更为 YukiHookPriority

增加 hookMode Hook 模式

功能描述

Hook 核心功能实现类，查找和处理需要 Hook 的 Method、Constructor。

before - method

fun before(initiate: HookParam.() -> Unit): HookCallback

变更记录

v1.2.0 新增

功能描述

在 Member 执行完成前 Hook。

after - method

fun after(initiate: HookParam.() -> Unit): HookCallback

变更记录

v1.2.0 新增

功能描述

在 Member 执行完成后 Hook。

replaceAny - method

fun replaceAny(initiate: HookParam.() -> Any?)

变更记录

v1.0 添加

功能描述

拦截并替换此 Member 内容，给出返回值。

replaceUnit - method

fun replaceUnit(initiate: HookParam.() -> Unit)

变更记录

v1.0 添加

功能描述

拦截并替换此 Member 内容，没有返回值，可以称为 Void。

replaceTo - method

fun replaceTo(any: Any?)

变更记录

v1.0 添加

功能描述

拦截并替 Member 返回值。

replaceToTrue - method

fun replaceToTrue()

变更记录

v1.0 添加

功能描述

拦截并替换 Member 返回值为 true。

特别注意

确保替换 Member 的返回对象为 Boolean。

replaceToFalse - method

fun replaceToFalse()

变更记录

v1.0 添加

功能描述

拦截并替换 Member 返回值为 false。

特别注意

确保替换 Member 的返回对象为 Boolean。

intercept - method

fun intercept()

变更记录

v1.0 添加

功能描述

拦截此 Member 。

这将会禁止此 Member 执行并返回 null。

特别注意

例如 Int、Long、Boolean 常量返回值的 Member 一旦被设置为 null 可能会造成 Hook APP 抛出异常。

removeSelf - method

fun removeSelf(result: (Boolean) -> Unit)

变更记录

v1.1.0 新增

功能描述

移除当前注入的 Hook Method、Constructor (解除 Hook)。

特别注意

你只能在 Hook 回调方法中使用此功能。

LegacyCreator - class

inner class LegacyCreator internal constructor()

变更记录

v1.2.0 新增

功能描述

使用 injectMember 创建的 Hook 核心功能实现类 (旧版本)。

注意

大部分旧版 API 已被迁移至此处，将不再特殊说明其中包含的旧版 API。

HookCallback - class

inner class HookCallback internal constructor()

变更记录

v1.1.0 新增

功能描述

Hook 方法体回调实现类。

onFailureThrowToApp - method

fun onFailureThrowToApp()

变更记录

v1.1.0 新增

功能描述

当回调方法体内发生异常时将异常抛出给当前 Hook APP。

Result - class

inner class Result internal constructor()

变更记录

v1.0 添加

功能描述

监听 Hook 结果实现类。

result - method

inline fun result(initiate: Result.() -> Unit): Result

变更记录

v1.0 添加

v1.0.5 修改

failures 修改为 result

v1.0.80 修改

将方法体进行 inline

功能描述

创建监听失败事件方法体。

by - method

inline fun by(condition: () -> Boolean): Result

变更记录

v1.0.5 新增

v1.0.80 修改

将方法体进行 inline

功能描述

添加执行 Hook 需要满足的条件，不满足条件将直接停止 Hook。

onHooked - method

fun onHooked(result: (Member) -> Unit): Result

变更记录

v1.0.70 新增

功能描述

监听 members Hook 成功的回调方法。

在首次 Hook 成功后回调。

在重复 Hook 时会回调 onAlreadyHooked。

onAlreadyHooked - method

fun onAlreadyHooked(result: (Member) -> Unit): Result

变更记录

v1.0.89 新增

功能描述

监听 members 重复 Hook 的回调方法。

注意

同一个 hookClass 中的同一个 members 不会被 API 重复 Hook，若由于各种原因重复 Hook 会回调此方法。

onNoSuchMemberFailure - method

fun onNoSuchMemberFailure(result: (Throwable) -> Unit): Result

变更记录

v1.0.5 新增

功能描述

监听 members 不存在发生错误的回调方法。

onConductFailure - method

fun onConductFailure(result: (HookParam, Throwable) -> Unit): Result

变更记录

v1.0 添加

功能描述

监听 Hook 进行过程中发生错误的回调方法。

onHookingFailure - method

fun onHookingFailure(result: (Throwable) -> Unit): Result

变更记录

v1.0 添加

功能描述

监听 Hook 开始时发生的错误的回调方法。

onAllFailure - method

fun onAllFailure(result: (Throwable) -> Unit): Result

变更记录

v1.0 添加

功能描述

监听全部 Hook 过程发生错误的回调方法。

ignoredNoSuchMemberFailure - method

fun ignoredNoSuchMemberFailure(): Result

变更记录

v1.0.5 新增

功能描述

忽略 members 不存在发生的错误。

ignoredConductFailure - method

fun ignoredConductFailure(): Result

变更记录

v1.0 添加

功能描述

忽略 Hook 进行过程中发生的错误。

ignoredHookingFailure - method

fun ignoredHookingFailure(): Result

变更记录

v1.0 添加

功能描述

忽略 Hook 开始时发生的错误。

ignoredAllFailure - method

fun ignoredAllFailure(): Result

变更记录

v1.0 添加

功能描述

忽略全部 Hook 过程发生的错误。

remove - method

fun remove(result: (Boolean) -> Unit)

变更记录

v1.1.0 新增

功能描述

移除当前注入的 Hook Method、Constructor (解除 Hook)。

注意

你只能在 Hook 成功后才能解除 Hook，可监听 onHooked 事件。

Result - class

inner class Result internal constructor()

变更记录

v1.0.3 新增

功能描述

监听全部 Hook 结果实现类。

result - method

inline fun result(initiate: Result.() -> Unit): Result

变更记录

v1.0.3 新增

v1.0.5 修改

failures 修改为 result

v1.0.80 修改

将方法体进行 inline

功能描述

创建监听事件方法体。

by - method

inline fun by(condition: () -> Boolean): Result

变更记录

v1.0.5 新增

v1.0.80 修改

将方法体进行 inline

功能描述

添加执行 Hook 需要满足的条件，不满足条件将直接停止 Hook。

onPrepareHook - method

fun onPrepareHook(callback: () -> Unit): Result

变更记录

v1.0.70 新增

功能描述

监听 hookClass 存在时准备开始 Hook 的操作。

onHookClassNotFoundFailure - method

fun onHookClassNotFoundFailure(result: (Throwable) -> Unit): Result

变更记录

v1.0.3 新增

功能描述

监听 hookClass 找不到时发生错误的回调方法。

ignoredHookClassNotFoundFailure - method

fun ignoredHookClassNotFoundFailure(): Result

变更记录

v1.0.3 新增

功能描述

忽略 hookClass 找不到时出现的错误。