通用

InjectApi

top.katton.api.injectcommon/src/main/kotlin/top/katton/api/inject/InjectApi.kt

注册注入的句柄，用于回滚操作。

成员

直接跳转到本页的声明。

• InjectionHandle类
• InjectionInvocationContext类
• InjectionInvocationContext.method属性
• InjectionInvocationContext.instance属性
• InjectionInvocationContext.arguments属性
• InjectionInvocationContext.owner属性
• InjectionInvocationContext.setArgument函数
• InjectionInvocationContext.cancel函数
• InjectionInvocationContext.cancelWith函数
• InjectionInvocationContext.setReturnValue函数
• ConstructorInvocationContext类
• ConstructorInvocationContext.constructor属性
• ConstructorInvocationContext.instance属性
• ConstructorInvocationContext.arguments属性
• ConstructorInvocationContext.owner属性
• injectBefore函数
• injectBefore函数
• injectAfter函数
• injectConstructorBefore函数
• injectConstructorBefore函数
• injectConstructorAfter函数
• injectConstructorAfter函数
• injectAfter函数
• replace函数
• replace函数
• redirect函数
• redirect函数
• rollbackUnsafe函数
• rollbackUnsafeByOwner函数

InjectionHandle

InjectionHandle通用类

class InjectionHandle internal constructor( val id: String )

注册注入的句柄，用于回滚操作。

属性

属性	说明
id	注入注册 ID，用于回滚。

InjectionInvocationContext

InjectionInvocationContext通用类

class InjectionInvocationContext internal constructor( private val delegate: InjectionManager.InjectionInvocation )

传给不安全回调的调用上下文。

可访问正在调用的方法、接收实例、参数，并控制调用流程。

属性

属性	说明
delegate	底层的注入调用委托。

InjectionInvocationContext.method

InjectionInvocationContext.method通用属性

val method: Method

当前正在调用的方法。

InjectionInvocationContext.instance

InjectionInvocationContext.instance通用属性

val instance: Any?

方法接收实例；对于静态方法则为 null。

InjectionInvocationContext.arguments

InjectionInvocationContext.arguments通用属性

val arguments: Array<Any?>

原始参数数组。

InjectionInvocationContext.owner

InjectionInvocationContext.owner通用属性

val owner: String?

这次调用绑定的脚本归属。

InjectionInvocationContext.setArgument

InjectionInvocationContext.setArgument通用函数

fun setArgument(index: Int, value: Any?)

修改当前调用中指定位置的参数。

参数

参数	说明
index	要修改的参数下标。
value	参数的新值。

InjectionInvocationContext.cancel

InjectionInvocationContext.cancel通用函数

fun cancel()

取消当前调用。若未覆写返回值，则使用该类型的默认值。

InjectionInvocationContext.cancelWith

InjectionInvocationContext.cancelWith通用函数

fun cancelWith(returnValue: Any?)

取消当前调用，并立即指定返回值。

参数

参数	说明
returnValue	用来替代方法执行结果的返回值。

InjectionInvocationContext.setReturnValue

InjectionInvocationContext.setReturnValue通用函数

fun setReturnValue(returnValue: Any?)

在 after 阶段覆写返回值。

参数

参数	说明
returnValue	用来替代原始结果的返回值。

ConstructorInvocationContext

ConstructorInvocationContext通用类

class ConstructorInvocationContext internal constructor( private val delegate: InjectionManager.ConstructorInvocation )

传给不安全构造器回调的构造器调用上下文。

属性

属性	说明
delegate	底层的构造器调用委托。

ConstructorInvocationContext.constructor

ConstructorInvocationContext.constructor通用属性

val constructor: Constructor<*>

当前正在调用的构造器。

ConstructorInvocationContext.instance

ConstructorInvocationContext.instance通用属性

val instance: Any?

已构造的实例（this），如果可用。

ConstructorInvocationContext.arguments

ConstructorInvocationContext.arguments通用属性

val arguments: Array<Any?>

Raw constructor argument array.

ConstructorInvocationContext.owner

ConstructorInvocationContext.owner通用属性

val owner: String?

Bound script owner for this invocation.

injectBefore

injectBefore通用函数

fun injectBefore(targetClassName: String, methodName: String, parameterTypeNames: List<String> = emptyList(), owner: String? = null, handler: (InjectionInvocationContext) -> Unit): InjectionHandle

Injects a callback before target method execution (string-based overload).

参数

参数	说明
targetClassName	target class fully-qualified name
methodName	target method name
parameterTypeNames	parameter type names, e.g. int, java.lang.String
owner	script owner (nullable, auto-resolved from script context if null)
handler	before callback

返回值

injection handle, usable by [rollbackUnsafe]

injectBefore

injectBefore通用函数

fun injectBefore(method: Method, owner: String? = null, handler: (InjectionInvocationContext) -> Unit): InjectionHandle

Injects a callback before target method execution (Method overload).

Prefer this overload when a reflected [Method] is already available, to avoid string-signature assembly errors.

injectAfter

injectAfter通用函数

fun injectAfter(targetClassName: String, methodName: String, parameterTypeNames: List<String> = emptyList(), owner: String? = null, handler: (InjectionInvocationContext, Any?, Throwable?) -> Unit): InjectionHandle

Injects a callback after target method execution (string-based overload).

参数

参数	说明
targetClassName	target class fully-qualified name
methodName	target method name
parameterTypeNames	parameter type names, e.g. int, java.lang.String
owner	script owner (nullable, auto-resolved from script context if null)
handler	after callback with result and throwable

返回值

injection handle, usable by [rollbackUnsafe]

injectConstructorBefore

injectConstructorBefore通用函数

fun injectConstructorBefore(targetClassName: String, parameterTypeNames: List<String> = emptyList(), owner: String? = null, handler: (ConstructorInvocationContext) -> Unit): InjectionHandle

Injects a callback before constructor execution (string-based overload).

参数

参数	说明
targetClassName	target class fully-qualified name
parameterTypeNames	constructor parameter type names, e.g. int, java.lang.String
owner	script owner (nullable, auto-resolved from script context if null)
handler	constructor-before callback

返回值

injection handle, usable by [rollbackUnsafe]

injectConstructorBefore

injectConstructorBefore通用函数

fun injectConstructorBefore(constructor: Constructor<*>, owner: String? = null, handler: (ConstructorInvocationContext) -> Unit): InjectionHandle

Injects a callback before constructor execution (Constructor overload).

injectConstructorAfter

injectConstructorAfter通用函数

fun injectConstructorAfter(targetClassName: String, parameterTypeNames: List<String> = emptyList(), owner: String? = null, handler: (ConstructorInvocationContext) -> Unit): InjectionHandle

Injects a callback after constructor execution (string-based overload).

参数

参数	说明
targetClassName	target class fully-qualified name
parameterTypeNames	constructor parameter type names, e.g. int, java.lang.String
owner	script owner (nullable, auto-resolved from script context if null)
handler	constructor-after callback

返回值

injection handle, usable by [rollbackUnsafe]

injectConstructorAfter

injectConstructorAfter通用函数

fun injectConstructorAfter(constructor: Constructor<*>, owner: String? = null, handler: (ConstructorInvocationContext) -> Unit): InjectionHandle

Injects a callback after constructor execution (Constructor overload).

injectAfter

injectAfter通用函数

fun injectAfter(method: Method, owner: String? = null, handler: (InjectionInvocationContext, Any?, Throwable?) -> Unit): InjectionHandle

Injects a callback after target method execution (Method overload).

Prefer this overload when a reflected [Method] is already available.

参数

参数	说明
method	The target Method to inject into
owner	Script owner (nullable, auto-resolved from script context if null)
handler	After callback with result and throwable

返回值

Injection handle, usable by [rollbackUnsafe]

replace

replace通用函数

fun replace(targetClassName: String, methodName: String, parameterTypeNames: List<String> = emptyList(), owner: String? = null, handler: (InjectionInvocationContext) -> Any?): InjectionHandle

Replaces entire target method body (string-based overload).

The handler return value becomes the method return value. This completely bypasses the original method implementation.

参数

参数	说明
targetClassName	Target class fully-qualified name
methodName	Target method name
parameterTypeNames	Parameter type names, e.g. int, java.lang.String
owner	Script owner (nullable, auto-resolved from script context if null)
handler	Replacement handler that returns the method result

返回值

Injection handle, usable by [rollbackUnsafe]

replace

replace通用函数

fun replace(method: Method, owner: String? = null, handler: (InjectionInvocationContext) -> Any?): InjectionHandle

Replaces entire target method body (Method overload).

参数

参数	说明
method	The target Method to replace
owner	Script owner (nullable, auto-resolved from script context if null)
handler	Replacement handler that returns the method result

返回值

Injection handle, usable by [rollbackUnsafe]

redirect

redirect通用函数

fun redirect(sourceClassName: String, sourceMethodName: String, sourceParameterTypeNames: List<String> = emptyList(), targetClassName: String, targetMethodName: String, targetParameterTypeNames: List<String> = emptyList(), owner: String? = null): InjectionHandle

Redirects a source method to another target method (string-based overload).

All calls to the source method will be redirected to the target method instead.

参数

参数	说明
sourceClassName	Source class fully-qualified name
sourceMethodName	Source method name to redirect from
sourceParameterTypeNames	Source method parameter type names
targetClassName	Target class fully-qualified name
targetMethodName	Target method name to redirect to
targetParameterTypeNames	Target method parameter type names
owner	Script owner (nullable, auto-resolved from script context if null)

返回值

Injection handle, usable by [rollbackUnsafe]

redirect

redirect通用函数

fun redirect(sourceMethod: Method, targetMethod: Method, owner: String? = null): InjectionHandle

Redirects a source method to another target method (Method overload).

参数

参数	说明
sourceMethod	The source Method to redirect from
targetMethod	The target Method to redirect to
owner	Script owner (nullable, auto-resolved from script context if null)

返回值

Injection handle, usable by [rollbackUnsafe]

rollbackUnsafe

rollbackUnsafe通用函数

fun rollbackUnsafe(handle: InjectionHandle): Boolean

Rolls back one unsafe injection by handle.

参数

参数	说明
handle	The injection handle to roll back

返回值

true if the injection was found and removed, false otherwise

rollbackUnsafeByOwner

rollbackUnsafeByOwner通用函数

fun rollbackUnsafeByOwner(owner: String)

Rolls back all unsafe injections by owner.

参数

参数	说明
owner	The script owner whose injections should be removed