API Exception Handling

Exceptions are the main problems often encountered in the development process. Here are some common exceptions that may be encountered during the use of YukiHookAPI and how to deal with them.

The exception description here will only synchronize the latest API version, and the exception of the older API version will not be described again, please always keep the API version up-to-date.

Non-Blocking Exceptions

These exceptions will not cause the app to stop running (FC), but will print E level logs on the console, and may also stop continuing to execute related functions.

exception

loggerE

Could not found any available Hook APIs in current environment! Aborted

Abnormal

Your Hook Framework is not working or did not successfully load the current Hook API.

Solution

Please make sure you have loaded the encase method of YukiHookAPI in the correct place. For details, please refer to Use as Xposed Module Configs and Use as Hook API Configs.

exception

loggerE

You cannot load a hooker in "onInit" or "onXposedEvent" method! Aborted

Abnormal

You try to load the encase method in the onInit or onXposedEvent method of the Hook entry class that implements IYukiHookXposedInit.

The following example

object HookEntry : IYukiHookXposedInit {

    override fun onInit() {
        //  Wrong usage
        YukiHookAPI.encase {
            // Your code here.
        }
    }

    override fun onXposedEvent() {
        //  Wrong usage
        YukiHookAPI.encase {
            // Your code here.
        }
    }

    override fun onHook() {
        // Your code here.
    }
}

Solution

Please load the encase method in the onHook method.

The following example

object HookEntry : IYukiHookXposedInit {

    override fun onInit() {
        // Only the configs method can be loaded here
        YukiHookAPI.configs {
            // Your code here.
        }
    }

    override fun onHook() {
        // ✅ Correct usage
        YukiHookAPI.encase {
            // Your code here.
        }
    }
}

exception

loggerE

An exception occurred in the Hooking Process of YukiHookAPI

Abnormal

YukiHookAPI exception occurred while loading Xposed entry method.

Solution

This is an exception summary.

If any exception occurs in your current Hook Process (Hook Process crashes), it will be printed to the console using this method.

Please trace the stack where the exception occurred to locate your code problem.

exception

loggerE

An exception occurred when hooking internal function

Abnormal

YukiHookAPI throws an exception during its own initialization hook.

Solution

Usually, this kind of error does not happen easily. If this error occurs, you can directly submit the log for feedback.

exception

loggerE

YukiHookAPI try to load hook entry class failed

Abnormal

YukiHookAPI encountered an unhandled exception or the entry class could not be found when trying to load the hook entry class onInit or onHook method.

Solution

Usually, this kind of error does not occur easily.

If this error occurs, please check the log printed on the console to locate the problem.

After confirming that the problem is not caused by your own code, you can submit the log for feedback.

exception

loggerE

An exception occurred when YukiHookAPI loading Xposed Module

Abnormal

YukiHookAPI encountered an unhandled exception when trying to load a Xposed Module using the Xposed native interface.

Solution

Usually, this kind of error does not occur easily.

If this error occurs, please check the log printed on the console to locate the problem.

After confirming that the problem is not caused by your own code, you can submit the log for feedback.

exception

loggerE

Failed to execute method "NAME", maybe your Hook Framework not support Resources Hook

Abnormal

YukiHookAPI An error occurred while trying to do a Resources Hook.

Solution

Please double check the error log for details.

If a Resources$NotFoundException occurs, you may be looking for an incorrect Resources Id.

If ClassNotFound or NoClassDefFoundError occurs, it may be that Hook Framework does not support Resources Hook.

exception

loggerE

HookClass [NAME] not found

Abnormal

The Class currently being hooked was not found.

Solution

Please check if the target Class exists, to ignore this error use the ignoredHookClassNotFoundFailure method.

exception

loggerE

Hook Member [NAME] failed

Abnormal

An error occurred while hooking the target method, constructor.

Solution

This problem is usually caused by Hook Framework.

Please check the corresponding log content.

If the problem persists, please bring detailed logs for feedback.

exception

loggerE

Hooked Member with a finding error / by CLASS

Abnormal

After the Hook is executed, the member of the Hook is null and the target Hook method and constructed class have been set.

Solution

Please check the previous error log before this error occurs, maybe there is an error that the method and constructor cannot be found when searching for methods and constructors.

exception

loggerE

Hooked Member cannot be null / by CLASS

Abnormal

After the Hook is executed, the member of the Hook is null and the target Hook method and constructed class are not set.

The following example

injectMember {
    // There are no search conditions for methods and constructors that require hooks
    after {
        // ...
    }
}

Solution

Please confirm that you have correctly set the method to be hooked and the way to find the constructor before hooking.

The following example

injectMember {
    // ✅ Examples of correct usage
    method {
        // Your code here.
    }
    after {
        // ...
    }
}

exception

loggerE

Hooked method return type match failed, required [TYPE] but got [TYPE]

Abnormal

HookParam.result is set in the Hook callback method body or replaceHook is used but the return value type of the hooked method does not match the original return value type.

The following example

Suppose this is the method being Hooked.

private boolean test()

Below is an error case.

method {
    name = "test"
    emptyParam()
}.hook {
    // <Scenario 1> Set the wrong type, the original type is Boolean
    before {
        result = 0
    }
    // <Scenario 2> Return the wrong type, the original type is Boolean
    replaceAny {
        0
    }
    // <Scenario 3> Use the wrong type directly, the original type is Boolean
    replaceTo(any = 0)
}

Notice

If the above scenario occurs in before or after, it will cause the Host App to throw an exception from XposedBridge (which will expose the fact of being Hooked).

Solution

Please confirm the correct return value type of the current Hook method, modify it and try again.

exception

loggerE

Hook initialization failed because got an exception

Abnormal

An arbitrary exception occurred while preparing the Hook.

Solution

This is a reminder that an exception occurred during the Hook preparation stage, please carefully check what the specific exception is to re-determine the problem.

exception

loggerE

Try to hook NAME[NAME] got an exception

Abnormal

An arbitrary exception occurred at the start of the Hook.

Solution

This is a reminder that an exception occurred at the beginning of the Hook, please check carefully what the specific exception is to re-determine the problem.

exception

loggerE

Method/Constructor/Field match type "TYPE" not allowed

Abnormal

A disallowed parameter type was set when looking up methods, constructors, and variables.

The following example

// Find a method
method {
    //  Invalid type example is set
    param(false, 1, 0)
    //  Invalid type example is set
    returnType = false
}

// Find a variable
field {
    //  Invalid type example is set
    type = false
}

Solution

In the search, param, returnType, type only accept Class, String, VariousClass types, and parameter instances cannot be passed in.

The following example

// Find a method
method {
    // ✅ Examples of correct usage
    param(BooleanType, IntType, IntType)
    // ✅ Examples of correct usage
    returnType = BooleanType
    // ✅ The following scheme is also correct
    returnType = "java.lang.Boolean"
}

// Find a variable
field {
    // ✅ Examples of correct usage
    type = BooleanType
}

exception

loggerE

NoSuchMethod/NoSuchConstructor/NoSuchField happend in [NAME]

Abnormal

The target method, constructor, and variable were not found when looking for methods, constructors, and variables.

Solution

Please confirm that your search criteria can correctly match the specified methods, constructors and variables in the target Class.

exception

loggerE

Trying COUNT times and all failure by RemedyPlan

Abnormal

When using RemedyPlan to search for methods, constructors, and variables, the methods, constructors, and variables are still not found.

Solution

Please confirm the RemedyPlan parameter you set and the Class that exists in the Host App, and try again.

exception

loggerE

Can't find this Class in [CLASSLOADER]: CONTENT Generated by YukiHookAPI#ReflectionTool

Abnormal

The Class object to be searched for was not found via ClassLoader.searchClass or PackageParam.searchClass.

The following example

customClassLoader?.searchClass {
    from(...)
    // ...
}.get()

Solution

This is a security exception, please check the conditions you set, use the relevant tools to view the Class and bytecode object characteristics in the Dex and try again.

exception

loggerE

Can't find this Method/Constructor/Field in [CLASS]: CONTENT Generated by YukiHookAPI#ReflectionTool

Abnormal

The methods, constructors, and variables that need to be found cannot be found by specifying conditions.

The following example

TargetClass.method {
    name = "test"
    param(BooleanType)
}

Solution

This is a security exception, please check the conditions you set, use the relevant tools to view the bytecode object characteristics in the Class, and try again.

exception

loggerE

The number of VagueType must be at least less than the count of paramTypes

Abnormal

Incorrect use of VagueType in Method, Constructor lookup conditions.

The following example

TargetClass.method {
    name = "test"
    // <Scenario 1>
    param(VagueType)
    // <Scenario 2>
    param(VagueType, VagueType ...)
}

Solution

VagueType cannot be completely filled in method and constructor parameters. If there is such a requirement, please use paramCount.

exception

loggerE

Field match type class is not found

Abnormal

An instance of Class for type was not found in the lookup criteria set when looking up the variable.

The following example

field {
    name = "test"
    // Assume that the Class of the type set here does not exist
    type = "com.example.TestClass"
}

Solution

Please check if Class of type in the lookup condition exists and try again.

exception

loggerE

Method match returnType class is not found

Abnormal

An instance of Class of returnType was not found in the search criteria set when looking up the method.

The following example

method {
    name = "test"
    // Assume that the Class of returnType set here does not exist
    returnType = "com.example.TestClass"
}

Solution

Please check if Class of returnType in the lookup condition exists and try again.

exception

loggerE

Method/Constructor match paramType[INDEX] class is not found

Abnormal

The Class instance subscripted by the index number of param was not found in the search conditions set when searching for methods and constructors.

method {
    name = "test"
    // Assume that the Class with subscript "No.1" set here does not exist
    param(StringClass, "com.example.TestClass", BooleanType)
}

Solution

Please check if the Class subscripted by the index number of param in the lookup condition exists and try again.

exception

loggerE

Invoke original Member [MEMBER] failed

Abnormal

An error occurred when using HookParam.callOriginal, HookParam.invokeOriginal, method { ... }.get(...).original() to call the original method without Hook.

Solution

Under normal circumstances, this error will basically not occur.

If this error occurs, it may be a problem with the currently used Hook Framework.

After troubleshooting your own code problems, please provide detailed logs for feedback.

exception

loggerE

Failed to got Host Resources

Abnormal

Failed to obtain the Host App's original Resources instance object when using replaceTo { ... } or replaceToModuleResource { ... } when finding Resources.

The following example

conditions {
    name = "test"
    string()
}
replaceTo { "${it}_some_text" }

Solution

Under normal circumstances, this error will basically not occur.

If this error occurs, it may be a problem with the currently used Hook Framework.

After troubleshooting your own code problems, please provide detailed logs for feedback.

exception

loggerE

Resources Hook condition name/type cannot be empty [TAG]

Abnormal

No conditions were set when looking for Resources.

The following example

// Case 1
conditions {
    // No conditions are set here
}
// Case 2
conditions {
    name = "test"
    // The type condition is missing here
}

Solution

The Hook of Resources is not a Hook similar to a method.

It must have a complete name and type description in order to find it successfully.

Please complete the search conditions and try again.

exception

loggerE

Resources Hook type is invalid [TAG]

Abnormal

An exception of the wrong type occurred while Hooking Resources.

Solution

YukiHookAPI will try to load Resources Hook in initZygote and handleInitPackageResources.

If all loading fails, this exception may occur.

The current Hook Framework needs to support and enable the Resources Hook function, please check and try again.

exception

loggerE

Resources Hook got an exception [TAG]

Abnormal

An arbitrary exception occurred while Hooking Resources.

Solution

This is a summary of exceptions, please check down the log for the specific exception, such as the problem that the Resources Id cannot be found.

exception

loggerE

Received action "ACTION" failed

Abnormal

Callback broadcast event exception when using YukiHookDataChannel.

Solution

This exception is mostly caused by some related exceptions.

Please check whether there is any problem in your own code.

After troubleshooting your own code, please bring detailed logs to give feedback.

exception

loggerE

Received data type TYPE is not a vailed YukiHookDataChannel's data

Abnormal

When using YukiHookDataChannel, the callback broadcast received data that does not belong to YukiHookDataChannel.

Solution

In order to ensure data security, YukiHookDataChannel will wrap the sent data, any third-party broadcast events cannot be received by YukiHookDataChannel, please check whether your code is correct.

exception

loggerE

Unsupported segments data key of "KEY"'s type

Abnormal

Callback broadcast received unsupported segments data type when using YukiHookDataChannel.

Solution

Under normal circumstances, this error cannot occur, because the segments data type supported by YukiHookDataChannel is fixed and will not change dynamically.

If this happens, please check whether the API-related code has been changed.

exception

loggerE

YukiHookDataChannel cannot merge this segments data key of "KEY"

Abnormal

When using YukiHookDataChannel, the callback broadcast received segments data that could not be processed, so the segments data could not be merged.

Solution

Under normal circumstances, this error will basically not occur, unless you receive broadcasts that are continuously sent or repeatedly sent (timing exceptions) or you set the wrong generic type when receiving data, after troubleshooting your own code problems, please bring detailed logs give feedback.

exception

loggerE

YukiHookDataChannel cannot calculate the byte size of the data key of "KEY" to be sent, so this data cannot be sent

If you want to lift this restriction, use the allowSendTooLargeData function when calling, but this may cause the app crash

Abnormal

Failed to calculate data size when sending broadcast data using YukiHookDataChannel.

Solution

Under normal circumstances, this error will basically not occur.

After troubleshooting your own code problems, please bring detailed logs for feedback.

exception

loggerE

YukiHookDataChannel cannot send this data key of "KEY" type TYPE, because it is too large (total TOTAL KB, limit LIMIT KB) and cannot be segmented

SUGGESTION_MESSAGE

If you want to lift this restriction, use the allowSendTooLargeData function when calling, but this may cause the app crash

Abnormal

When using YukiHookDataChannel to send broadcast data, the data is too large, but this data type does not support being sent in segments.

Solution

When the data you send exceeds the upper limit of the system broadcast, YukiHookDataChannel will send the data in segments by default, but only supports processing List, Map, Set, String automatic segmentation function for common types.

Tips

If you still want to use this feature, please refer to YukiHookDataChannel.NameSpace.allowSendTooLargeData method.

But it is strongly recommended not to do this, this may cause the system to not allow too large data to be sent and cause the app crash.

exception

loggerE

Failed to sendBroadcast like "KEY", because got null context in "PACKAGENAME"

Abnormal

Sending a broadcast when using YukiHookDataChannel got an empty context instance.

Solution

Under normal circumstances, this error basically does not occur.

In the latest version, the problems that may occur when the host is used have been fixed.

If the latest version still has errors, after eliminating the problem of your own code, please bring detailed logs for feedback.

exception

loggerE

Failed to inject module resources into [RESOURCES]

Abnormal

An exception occurred when injecting Module App's Resources using injectModuleAppResources in a (Xposed) Host environment.

Solution

Under normal circumstances, this error basically does not occur. After eliminating the problem of your own code, please bring detailed logs for feedback.

exception

loggerE

You cannot inject module resources into yourself

Abnormal

Use injectModuleAppResources in the (Xposed) Host environment (the Module App's own Xposed Environment) to inject the Module App's own resources into itself.

Solution

Since the Module App itself can also be Hooked by itself, you cannot inject yourself into the Module App itself (you cannot recurse its own resources).

If you must obtain the resources of the Module App itself, please use it directly without any other operations.

exception

loggerE

Activity Proxy initialization failed because got an exception

Abnormal

An exception occurred when injecting a Module App's Activity using registerModuleAppActivities in a (Xposed) Host environment.

Solution

Please check the next error log after this error occurs.

Maybe some problems may have occurred in the configuration parameters.

If you cannot find the description of the relevant error log, after eliminating the problem of your own code, please bring the detailed log for feedback.

exception

loggerE

Activity Proxy got an exception in msg.what [WHAT]

Abnormal

An exception occurred when injecting a Module App's Activity using registerModuleAppActivities in a (Xposed) Host environment.

Solution

Under normal circumstances, this error basically does not occur, but according to the difference of the system version, no detailed testing has been done.

After eliminating the problem of your own code, please bring detailed logs for feedback.

exception

loggerE

This proxy [TYPE] type is not allowed

Abnormal

Invalid parameters were filled in when injecting Module App's Activity using registerModuleAppActivities in a (Xposed) Host environment.

The following example

//  The content filled in here is just an example
// And the proxy is filled with invalid parameters that cannot be understood
registerModuleAppActivities(proxy = false)

Solution

The proxy parameter in the method only accepts String, CharSequence, Class types, please refer to the related usage method to fill in the method parameters correctly.

exception

loggerE

Cound not got launch intent for package "NAME"

Abnormal

When injecting Module App's Activity using registerModuleAppActivities in a (Xposed) Host environment, the Host App's launching Activity cannot be found.

The following example

// Register directly with default parameters
registerModuleAppActivities()

Solution

The default parameter (no parameter) can only be used for the app that can be launched.

If the app does not declare the startup entry Activity, you need to manually specify the proxy parameter of the method.

exception

loggerE

Could not found "NAME" or Class is not a type of Activity

Abnormal

When injecting Module App's Activity with registerModuleAppActivities in a (Xposed) Host environment, the Activity filled with the parameter proxy cannot be found.

The following example

registerModuleAppActivities(proxy = "com.demo.test.TestActivity")

Solution

Please make sure that the Activity name you fill in really and effectively exists in the Host App, and the target Class extends Activity.

exception

loggerE

You cannot register Activity Proxy into yourself

Abnormal

Use registerModuleAppActivities to inject the Module App's own Activity into itself in the (Xposed) Host environment (the Module App's own Xposed Environment).

Solution

Since the Module App itself can also be Hooked by itself, you cannot inject yourself into the Module App itself (you cannot recurse its own resources).

If you must obtain the resources of the Module App itself, please use it directly without any other operations.

exception

loggerE

Activity Proxy only support for Android 7.0 (API 24) or higher

Abnormal

Use registerModuleAppActivities in the (Xposed) Host environment but the current system version does not meet the minimum requirements of Android 7.0 (API 24).

Solution

Activity Proxy only supports systems higher than or equal to Android 7.0 (API 24).

Please try to upgrade your system or make requirements for the minimum api version compatibility of the Module App, for example, set the minimum api to 24.

exception

loggerE

An exception occurred during AppLifecycle event

Abnormal

Use onAppLifecycle in the (Xposed) Host environment to listen for exceptions during the Host App's lifecycle.

Solution

This exception is thrown in onAppLifecycle.

Since you set the parameter isOnFailureThrowToApp = false, the exception is not thrown in the Host App but printed in the (Xposed) Host environment.

This is not an API exception, please be careful check your own code for problems.

Blocking Exceptions

These exceptions will directly cause the app to stop running (FC), at the same time print E level logs on the console, and also cause the Hook process to "die".

exception

IllegalStateException

YukiHookAPI cannot support current Hook API or cannot find any available Hook APIs in current environment

Abnormal

YukiHookAPI does not support the Hook API used by the current environment or there is no Hook API that can be called.

Solution

Please make sure you have loaded the encase method of YukiHookAPI in the correct place. For details, please refer to Use as Xposed Module Configs and Use as Hook API Configs.

exception

NoClassDefFoundError

Can't find this Class in [CLASSLOADER]: CONTENT Generated by YukiHookAPI#ReflectionTool

Abnormal

The Class object you were looking for was not found via String.toClass(...) or classOf<...>().

The following example

"com.demo.Test".toClass()

Solution

Please check if the Class matched by the current string or entity exists in the current ClassLoader and try again.

exception

IllegalStateException

ClassLoader [CLASSLOADER] is not a DexClassLoader

Abnormal

Use ClassLoader.searchClass or PackageParam.searchClass to find Class but currently ClassLoader does not extends BaseDexClassLoader.

Solution

This situation basically does not exist, unless the current app references a Non-ART platform executable (which not realistic) or the current ClassLoader is null.

exception

IllegalStateException

Failed to got SystemContext

Abnormal

systemContext was called in the Host App but the instance object was not successfully obtained.

The following example

encase {
    // This variable is called
    systemContext...
}

Solution

This situation should not exist, since systemContext is obtained from ActivityThread through reflection, unless the system process fails, the obtained object will not be null.

exception

IllegalStateException

App is dead, You cannot call to appContext

Abnormal

The first case

The appContext of the ModuleApplication is called within the Hook App.

The following example

encase {
    // This variable is called
    ModuleApplication.appContext...
}

The second case

appContext was called when using ModuleApplication but the app may have been destroyed or not started correctly.

The following example

// This variable is called but the app may have been destroyed or not started correctly
ModuleApplication.appContext...

Solution

The first case

You can only use the appContext of ModuleApplication in the Module App, please use the appContext in the PackageParam in the Host App, please make sure you use it correctly.

The second case

This situation basically does not exist, because appContext is assigned in onCreate, unless the onCreate method of the parent class is called by reflection before multi-process concurrent startup or app is not started and completed.

exception

IllegalStateException

YukiHookPrefsBridge not allowed in Custom Hook API

Abnormal

YukiHookPrefsBridge is used in Hook's own app (not Xposed Module).

The following example

class MyApplication : Application() {

    override fun attachBaseContext(base: Context?) {
        YukiHookAPI.encase(base) {
            //  Can't use prefs in this case
            prefs.getBoolean("test_data")
        }
        super.attachBaseContext(base)
    }
}

Solution

You can only use YukiHookPrefsBridge when Use as Xposed Module Configs, please use the native Sp storage in the Hook's own app.

exception

IllegalStateException

Cannot load the XSharedPreferences, maybe is your Hook Framework not support it

Abnormal

Using YukiHookPrefsBridge in (Xposed) Host environment but unable to get XSharedPreferences object.

The following example

encase {
    // This variable is called
    prefs...
}

Solution

Under normal circumstances, this problem does not occur.

If you continue to fail to obtain the XSharedPreferences object, it may be that the Hook Framework you are using does not support this function or has an error.

exception

IllegalStateException

YukiHookDataChannel not allowed in Custom Hook API

Abnormal

YukiHookDataChannel is used in Hook's own app (not Xposed Module).

The following example

class MyApplication : Application() {

    override fun attachBaseContext(base: Context?) {
        YukiHookAPI.encase(base) {
            //  dataChannel cannot be used in this case
            dataChannel.wait(key = "test_data") {
                // ...
            }
        }
        super.attachBaseContext(base)
    }
}

Solution

You can only use YukiHookDataChannel when Use as Xposed Module Configs.

exception

IllegalStateException

Xposed modulePackageName load failed, please reset and rebuild it

Abnormal

When using YukiHookPrefsBridge or YukiHookDataChannel in the Hook process, the modulePackageName at load time cannot be read, resulting in the package name of the own Module App cannot be determined.

Solution

Please read the help document here carefully, and configure the Module App's Hook entry class package name correctly.

exception

IllegalStateException

YukiHookPrefsBridge missing Context instance

Abnormal

YukiHookPrefsBridge is used in the Module App to store data but no Context instance is passed in.

The following example

class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        //  Wrong usage
        // Constructor has been set to private in API 1.0.88 and later
        YukiHookPrefsBridge().getBoolean("test_data")
    }
}

Solution

It is recommended to use the prefs(...) method to load YukiHookPrefsBridge in Activity.

The following example

class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        // ✅ Correct usage
        prefs().getBoolean("test_data")
    }
}

exception

IllegalStateException

The Host App's Context has not yet initialized successfully, the native function cannot be used at this time

Abnormal

In the (Xposed) Host environment PackageParam, YukiHookPrefsBridge is used and the native method is called, but the lifecycle of the Host App is not initialized at this time.

The following example

encase {
    // This method was called
    prefs.native()
}

Solution

The native method requires an existing Context object to store data in, and you can use this method in listening to the Host App lifecycle state.

exception

IllegalStateException

Key-Value type TYPE is not allowed

Abnormal

An unsupported storage type was passed in when using the get or put methods of YukiHookPrefsBridge or the wait or put methods of YukiHookDataChannel.

Solution

The supported types of YukiHookPrefsBridge are only String, Set<String>, Int, Float, Long, Boolean, please pass in the supported types.

The supported types of YukiHookDataChannel are the types restricted by Intent.putExtra, please pass in the supported types.

IllegalStateException

loadApp/loadZygote/loadSystem/withProcess method need a "NAME" param

Abnormal

The variable array variable parameter that needs to be filled is missing in loadApp, loadZygote, loadSystem, withProcess.

The following example

// <Scenario 1>
loadApp()
// <Scenario 2>
loadZygote()
// <Scenario 3>
loadSystem()
// <Scenario 4>
withProcess()

Solution

Please see the usage in PackageParam to use this function correctly.

exception

IllegalStateException

YukiHookDataChannel cannot be used in zygote

Abnormal

YukiHookDataChannel is used in loadZygote.

The following example

loadZygote {
    // This variable is called
    dataChannel...
}

Solution

YukiHookDataChannel can only be used in loadSystem, loadApp.

exception

IllegalStateException

Custom Hooking Members is empty

Abnormal

members() is called in MemberHookCreator but the Member instance that requires the Hook is not set.

The following example

injectMember {
    // Method parameters in parentheses are left blank
    members()
    after {
        // ...
    }
}

Solution

To use members() to set a custom Hook method, you must ensure that the Member array object in its method parameter cannot be empty.

exception

IllegalStateException

HookParam Method args index must be >= 0

Abnormal

args().last() is called in HookParam but the target param is empty or the index in args is set to a value less than 0.

The following example

injectMember {
    // ...
    after {
        // Assume param is empty
        args().last()...
        // Set an index less than 0
        args(index = -5)...
    }
}

Solution

Please make sure that the number of method parameters of the target method and constructor of your Hook is not empty, and the subscript of args cannot be set to a value less than 0.

exception

IllegalStateException

HookParam instance got null! Is this a static member?

Abnormal

An object that calls an instance variable or instance method in a HookParam but cannot get the current instance.

The following example

injectMember {
    // ...
    after {
        // This variable is called
        instance...
        // This method is called
        instance<Any>()...
    }
}

Solution

Please confirm whether the method of your Hook is a static type.

The static type method has no instance and cannot use this function.

If it is not a static method, please check whether the instance has been destroyed.

exception

IllegalStateException

Current hooked Member args is null

Abnormal

The args variable is called in HookParam, but the parameter array of the current instance method and constructor cannot be obtained.

The following example

injectMember {
    // ...
    after {
        // This variable is called
        args...
    }
}

Solution

This kind of problem generally does not occur.

If this problem does occur, please bring detailed logs for feedback.

exception

IllegalStateException

Current hooked Member is null

Abnormal

Call the member variable in HookParam but cannot get the method and constructor instance of the current instance.

The following example

injectMember {
    // ...
    after {
        // This variable is called
        member...
    }
}

Solution

This kind of problem generally does not occur.

If this problem does occur, please bring detailed logs for feedback.

exception

IllegalStateException

Current hooked Member is not a Method

Abnormal

Calling the method variable in HookParam but not getting the method instance of the current instance.

The following example

injectMember {
    // ...
    after {
        // This variable is called
        method...
    }
}

Solution

Please confirm whether the method of your Hook is a constructor or a common method and use the method of the corresponding type to obtain the specified instance.

If you do not know the type of the bytecode, you can directly use member to obtain it.

exception

IllegalStateException

Current hooked Member is not a Constructor

Abnormal

A method instance for calling a constructor variable in a HookParam but not getting the current instance.

The following example

injectMember {
    // ...
    after {
        // This variable is called
        constructor...
    }
}

Solution

Please confirm whether the method of your Hook is a common method or a constructor method and use the method of the corresponding type to obtain the specified instance.

If you do not know the type of the bytecode, you can directly use member to obtain it.

exception

IllegalStateException

HookParam instance cannot cast to TYPE

Abnormal

Invoking the instance method in a HookParam specifies the wrong type.

The following example

injectMember {
    // ...
    after {
        // The type is cast to Activity
        // But assumes the current instance's type is not this type
        instance<Activity>()...
    }
}

Solution

Please confirm the correct type of the current Hook instance and refill the type in the generic.

If you are not sure, please use Any or directly use the instance variable.

exception

IllegalStateException

HookParam Method args is empty, mabe not has args

Abnormal

The ArgsModifyer.set method is called in HookParam but the method parameter array for the current instance is empty.

The following example

injectMember {
    // ...
    after {
        // This method is called
        args(...).set(...)
    }
}

Solution

Please make sure that the number of method parameters of the target method and constructor of your Hook is not empty, otherwise you cannot use this function.

exception

IllegalStateException

HookParam Method args index out of bounds, max is NUMBER

Abnormal

Calling the ArgsModifyer.set method in HookParam specifies an array number beyond the subscript of the method parameter.

The following example

injectMember {
    // ...
    after {
        // The subscript starts from 0
        // Assuming the original parameter subscript is 5, but fill in 6 here
        args(index = 6).set(...)
    }
}

Solution

Please confirm the target method of your Hook, the number of method parameters of the constructor, and reset the array subscript.

exception

IllegalStateException

Current Hook Framework not support moduleAppResources

Abnormal

The moduleAppResources variable was called in PackageParam but the instance object could not be obtained.

The following example

encase {
    // This variable is called
    moduleAppResources...
}

Solution

This situation hardly exists, unless there is a problem with the target Hook Framework itself.

If this problem does occur, please provide feedback with detailed logs.

exception

IllegalStateException

VariousClass match failed of those CLASSES

Abnormal

All Class were not found when creating indeterminate Class objects using VariousClass.

Solution

After checking whether there is a matching Class in the Host App of the current Hook, try again.

exception

IllegalStateException

Cannot get hook class "NAME" cause THROWABLE

Abnormal

The instanceClass variable is called in the hook method body other than the onPrepareHook method and the Class of the current Hook does not exist.

The following example

TargetClass.hook {
    // The possible case is that the instanceClass variable
    // Who is called in the body of the non-onPrepareHook method to print the log
    loggerD(msg = "$instanceClass hook start")
}

Solution

Using instanceClass directly in hook is very dangerous, if the Class does not exist, it will directly cause the Hook process to "die".

For details, please refer to Status Monitor.

exception

IllegalStateException

Use of searchClass { ... }.hook { ... } is an error, please use like searchClass { ... }.get()?.hook { ... }

Abnormal

The Hook instance are created directly using the searchClass { ... }.hook { ... } method.

Solution

Please use searchClass { ... }.get()?.hook { ... } to create a Hook instance.

exception

IllegalStateException

This type [TYPE] not support to hook, supported are Constructors and Methods

Abnormal

Using Member.hook { ... } creates member objects that do not support Hooks, such as Field.

Solution

You can only Hook Constructor and Method.

exception

IllegalStateException

LayoutInflatedParam View instance got null

Abnormal

currentView was called in the layout hook callback but no instance object was obtained.

The following example

injectResource {
    conditions {
        name = "activity_main"
        layout()
    }
    injectAsLayout {
        // This variable is called
        currentView...
    }
}

Solution

This situation basically does not exist, unless the current Activity of the Host App has been destroyed or there is a problem with the Hook Framework itself.

exception

IllegalStateException

XResForwarder is invalid

Abnormal

resources was called in YukiResForwarder but no instance object was obtained.

The following example

// This variable is called
moduleAppResources.fwd(...).resources

Solution

This basically doesn't exist unless there is a problem with the Hook Framework itself.

exception

IllegalStateException

paramTypes is empty, please use emptyParam() instead

Abnormal

The empty param method is preserved when looking up methods, constructors.

The following example

method {
    name = "test"
    // No parameters are filled in parentheses
    param()
}

Solution

To identify this method, the constructor has no parameters, you can have a setter method as follows.

The first way, set emptyParam (recommended)

The following example

method {
    name = "test"
    emptyParam()
}

The second way, set paramCount = 0

The following example

method {
    name = "test"
    paramCount = 0
}

exception

IllegalStateException

Invalid YukiHookCallback type

Abnormal

The core Hook functionality of YukiHookAPI is broken.

Solution

This situation basically does not exist.

If the above problem occurs, after confirming that the problem is not in your own code, you can submit a log for feedback.

exception

IllegalStateException

ModuleContextThemeWrapper already loaded

Abnormal

Called repeatedly when using the applyModuleTheme method in the Context.

The following example

// Assume this is the current Context object
context.applyModuleTheme(R.style.Theme_AppCompat).applyModuleTheme(R.style.Theme_AppCompat)

Solution

The ModuleContextThemeWrapper can only be created once in the Context, please check the code for loop call problems.

exception

IllegalStateException

Cannot create classes cache for "android", please remove "name" param

Abnormal

The DexClassFinder cache function searchClass(name = ...) is used in the System Framework ("android") Host App.

The following example

loadSystem {
    searchClass(name = "test") {
        from(...)
        // ...
    }.get()
}

Solution

Since the cache will store the found Class name in SharedPreferences, but the data directory does not exist in the System Framework, so please do not use this function in the System Framework.

exception

IllegalStateException

Target Class type cannot cast to TYPE

Abnormal

Wrong type declared when converting string class name to target Class using Class.toClass, Class.toClassOrNull, GenericClass.argument methods.

The following uses the Class.toClass method as an example.

The following example

// Assume the target type is Activity but it was wrongly cast to WrongClass type
val clazz = "android.app.Activity".toClass<WrongClass>()

Solution

The following example

// <Solution 1> Fill in the correct type
val clazz1 = "android.app.Activity".toClass<Activity>()
// <Solution 2> Do not fill in the generic declaration
val clazz2 = "android.app.Activity".toClass()

Please ensure that the generic type declared after executing the method is the specified target Class type, and you do not need to fill in the generic declaration if the target type is not sure.