Skip to content

HChenX/HookTool

BranchesTags

Repository files navigation

HookTool

stars Github repo size GitHub release (latest by date) GitHub Release Date last commit language

English | 简体中文

Java 版 Hook 工具！

✨ 工具特性

1. 链式调用

2. 泛型转换

3. 全面丰富

Tip: 重构声明: v.1.0.0 版本和之前版本有较大不同，新版本工具完成静态化，更符合工具特征，拥有更好的使用体验和性能。

🔧 使用方法

1. 向项目 settings.gradle 文件添加如下代码。

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        mavenCentral()
        maven { url 'https://jitpack.io' }
    }
}

2. 向项目 app 内 build.gradle 文件添加如下代码。

dependencies {
    // jitpack
    implementation 'com.github.HChenX:HookTool:v.1.0.5'
    // maven
    implementation 'io.github.hchenx:hooktool:v.1.0.5'
    // 二选一即可
}

3. 同步项目，下载依赖即可在代码内调用。

4. 使用工具。

  • HCInit 介绍。
public void init() {
    HCinit.initBasicData(); // 初始化模块基本信息
    HCinit.initStartupParam(); // 在 zygote 阶段初始化工具
    HCinit.initLoadPackageParam(); // 在 loadPackage 阶段初始化工具
    HCinit.xPrefsAutoReload(); // 是否自动更新共享首选项，默认开启
    HCinit.useLogExpand(); // 是否使用日志增强功能，具体参见方法注解
}
  • 在 Xposed 入口处初始化本工具。
@Override
public void initZygote(IXposedHookZygoteInit.StartupParam startupParam) {
    HCInit.initBasicData(new BasicData()
            .setModulePackageName("com.hchen.demo") // 模块包名
            .setTag("HChenDemo") // 日志 tag
            .setLogLevel(LOG_D) // 日志等级
            .setPrefsName("hchen_prefs") // prefs 存储文件名 (可选)
    ); // 若有 initZygote 建议配置在这里，因为时机很早。
    HCInit.initStartupParam(startupParam); // 在 zygote 阶段初始化工具
}

@Override
public void handleLoadPackage(XC_LoadPackage.LoadPackageParam lpparam) {
    HCInit.initLoadPackageParam(lpparam); // 在 loadPackage 阶段初始化工具
}
  • 如果需要使用 prefs 工具或者在模块内使用本工具的 log 类，那么你还需要在模块主界面初始化。
public static class MainActivity {
    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        HCInit.initBasicData(new BasicData()
                .setModulePackageName("com.hchen.demo") // 模块包名
                .setTag("HChenDemo") // 日志 tag
                .setLogLevel(LOG_D) // 日志等级
                .setPrefsName("hchen_prefs") // prefs 存储文件名。Tip: 请保持与 Xposed 内填写的文件名一致 (可选)
        );
    }
}
  • 在代码处调用
public class MainTest {
    public void test() {
        CoreTool.hook(/* 内容 */); // 即可 hook
        CoreTool.findClass().get(); // 查找类
        CoreTool.callMethod(); // 调用方法
        ChainTool.chain("com.hchen.demo", new ChainTool()
                .method("method")
                .hook()

                .method("method")
                .hook()
        ); // 即可链式调用
        PrefsTool.prefs().getString(); // 即可读取共享首选项
        // ......
    }
}
  • 当然你也可以直接继承本工具打包好的类。
  • // 强烈建议继承 BaseHC 使用！
// Hook 方
public class MainTest extends BaseHC {
    @Override
    public void init() {
        // BaseHC 继承了 CoreTool 工具，直接调用即可。
    }

    // 可选项。
    // 时机为 zygote。
    // 使用 initZygote 必须在 hook 入口处初始化 HCInit.initStartupParam(startupParam);
    @Override
    public void initZygote(IXposedHookZygoteInit.StartupParam startupParam) {
        findClass("com.hchen.demo.Main").get();
    }
}

// 执行方
public class RunHook implements IXposedHookLoadPackage, IXposedHookZygoteInit {
    @Override
    public void handleLoadPackage(XC_LoadPackage.LoadPackageParam loadPackageParam) {
        new MainTest().onLoadPackage(); // 即可在 loadPackage 阶段执行 Hook。
    }

    @Override
    public void initZygote(StartupParam startupParam) {
        new MainTest().onZygote(); // 即可在 initZygote 阶段 Hook。
    }
}
  • 混淆配置:
// 如果你不需要使用日志增强功能，也可以只加入（对于继承 BaseHC 使用的情况）:
-keep class * extends com.hchen.hooktool.BaseHC
 
// 假如你存放 hook 文件的目录为 com.hchen.demo.hook
// 如果需要使用日志增强功能，那么建议加入混淆规则:
// 如果有多个存放的目录，建议都分别加入。
-keep class com.hchen.demo.hook.**
-keep class com.hchen.demo.hook.**$*

// 如果既不继承 BaseHC 使用，也不使用日志增强功能则不需要配置混淆规则。
  • 到此完成全部工作，可以愉快的使用了！

💡 链式调用

  • 本工具支持链式调用，使用 chain() 方法创建链式。
  • 这是本工具重构提供的全新链式方案，是否更简洁高效了呢？
  • 代码示例:
// 链式调用
public class MainTest extends BaseHC {
    public void test() {
        // 看！是不是很简洁易懂？
        chain("com.hchen.demo", method("test")
                .hook(new IAction() {
                    @Override
                    public void before() {
                        super.before();
                    }
                })

                .anyMethod("test")
                .hook(new IAction() {
                    @Override
                    public void after() {
                        super.after();
                    }
                })

                .constructor()
                .returnResult(false)
        );
    }
}

🔥 泛型转换

  • 传统 Xposed MethodHookParam 的各种方法返回都是 Object。 这就使得我们必须显性的进行类型转换才能使用。
  • 本工具则充分使用泛型，就不需要显性的进行类型转换啦！
public class MainTest extends BaseHC {
    @Override
    public void init() {
        new XC_MethodHook() {
            @Override
            protected void beforeHookedMethod(MethodHookParam param) {
                Context context = (Context) param.thisObject;
                String string = (String) param.args[0];
                param.args[1] = 1;
                String result = (String) XposedHelpers.callMethod(param.thisObject, "call",
                        param.thisObject, param.args[0]);
                XposedHelpers.callStaticMethod(XposedHelpers.findClass("com.demo.Main", ClassLoader.getSystemClassLoader()),
                        "callStatic", param.thisObject, param.args[1]);
                int i = (int) XposedHelpers.getStaticObjectField(XposedHelpers.findClass("com.demo.Main", ClassLoader.getSystemClassLoader()),
                        "field");
            }
        };

        new IAction() {
            @Override
            public void before() {
                Context context = thisObject(); // 无需显式转换
                String string = first(); // 更符合直觉的参数获取 :)
                second(1); // 更符合直觉的参数设置 :)
                // 非静态本类内
                setThisField("demo", 1);
                callThisMethod("method",...);
                // 非静态本类外
                setField(obj, "demo", 1);
                callMethod(obj, "method");

                // 静态需要 class
                callStaticMethod("com.demo.Main", "callStatic", thisObject(), second());
                int i = getStaticField("com.demo.Main", "field");
                setStaticField("com.demo.Main", "test", true);

                removeSelf(); // 你可调用此方法，使得挂钩自己失效
                observeCall();  // 观察调用
                getStackTrace(); // 获取堆栈
            }
        };
    }
}

📌 全面丰富

  • 工具提供了全面丰富的方法供你调用。
  • 包括:
  • ContextTool 类:
  • 更方便的获取 context 。
public class MainTest {
    public void test() {
        // 即可最简单的获取 context
        Context context = ContextTool.getContext(ContextUtils.FLAG_ALL);
    }
}
  • InvokeTool 类:
  • 更方便稳健的反射类。
public class MainTest {
    public void test() {
        // 即可反射调用方法，其他反射操作同理。
        InvokeTool.callMethod(InvokeTool.findClass("com.hchen.demo.Main",
                getClass().getClassLoader()), "test", new Class[]{});
    }
}
  • PropTool 类:
  • 更方便的 prop 读取修改工具。
public class MainTest {
    public void test() {
        // 只能在系统框架中调用才能设置 prop
        PropTool.setProp("ro.test.prop", "1");
        // 获取可以随意
        String result = PropTool.getProp("ro.test.prop");
    }
}
  • PrefsTool 类:
  • 提供 prefs 读取修改功能。
// 寄生应用内
public class MainTest extends BaseHC {
    @Override
    public void init() {
        // xprefs 模式：
        // 注意 xprefs 模式，寄生应用不能修改配置只能读取。
        String s = prefs().getString("test", "1");  // 即可读取
        s = prefs("myPrefs").getString("test", "1");  // 可指定读取文件名

        // sprefs 模式：
        // 配置会保存到寄生应用的私有目录，读取也会从寄生应用私有目录读取。
        prefs(context).editor().putString("test", "1").commit();
        // 如果没有继承 BaseHC 可以这样调用。
        PrefsTool.prefs(context).editor().putString("test", "2").commit();
        // 注意 sprefs 模式 是和 xprefs 模式相互独立的，可共同存在。

        // 如果不方便获取 context 可用使用此方法，异步获取寄生应用上下文后再设置。
        asyncPrefs(new PrefsTool.IAsyncPrefs() {
            @Override
            public void async(Context context) {
                prefs(context).editor().putString("test", "1").commit();
            }
        });
    }
}

// 模块内
public static class MainActivity {
    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        // ！！！如果使用 xprefs 模式，请在模块主界面调用 PrefsTool.prefs(context); 初始化一下，否则可能不可用！！！
        PrefsTool.prefs(this); // 或
        PrefsTool.prefs(this,/* 你自己的 prefs 名称 */);

        // 使用方法
        prefs(this).editor().putString("test", "1").commit();
        prefs(this, "myPrefs").editor().putString("test", "1").commit();
    }
}
  • CoreTool 类:
  • 提供完善的 Hook 方法！
  • 绝对满足需求！
  • DeviceTool 类:
  • 方便的获取系统基本信息。
  • 具体参见源代码和注释。
  • ResTool 类:
  • 将模块资源注入目标作用域。
  • 具体参见源代码与注释。
  • PackagesTool 类:
  • 快速获取软件包信息！
  • BitmapTool 类:
  • Drawable 转 Bitmap。
  • 其他更多精彩正在加载···

💕 工具使用者

  • 以下项目使用了本工具！
项目名称 项目链接
ForegroundPin ForegroundPin
AutoSEffSwitch AutoSEffSwitch
  • 如果你的项目使用了本工具，可以告诉我，我将会把其加入表格。
  • 想要详细了解本工具也可以参考上述项目，希望给你带来帮助！

📢 项目声明

  • 本工具基于：

  • LSPosed

  • 使用本工具请注明。

🎉 结尾

  • 感谢您愿意使用本工具！Enjoy your day! ♥️

About

Java 版 Hook 工具！

Resources

Readme

License

GPL-3.0 license
Activity

Stars

17 stars

Watchers

1 watching

Forks

2 forks
Report repository

Releases 18

HookTool v.1.0.5 Latest
Oct 29, 2024
+ 17 releases

Packages

No packages published

Contributors 2

  •  
  •  

Languages