Bytecode-Viewer插件开发API文档：核心类与方法解析

Bytecode-Viewer插件开发API文档：核心类与方法解析

【免费下载链接】bytecode-viewer A Java 8+ Jar & Android APK Reverse Engineering Suite (Decompiler, Editor, Debugger & More) 项目地址: https://gitcode.com/gh_mirrors/by/bytecode-viewer

1. 插件开发概述

Bytecode-Viewer（BCV）是一个功能强大的Java 8+ Jar和Android APK逆向工程套件，支持反编译、编辑和调试等功能。插件系统是其核心扩展机制，允许开发者通过编写自定义插件实现特定逆向分析需求。本文档详细解析BCV插件开发的核心API，包括Plugin基类、BCV工具类及相关辅助组件，帮助开发者快速构建功能丰富的插件。

1.1 插件工作流程

1.2 开发环境准备

1. 克隆项目仓库：

   git clone https://gitcode.com/gh_mirrors/by/bytecode-viewer
   

2. 依赖要求：

   • JDK 8+
   • Maven 3.6+
   • IDE（IntelliJ IDEA推荐）

3. 项目结构：

   bytecode-viewer/
   ├── src/main/java/the/bytecode/club/bytecodeviewer/api/  # API核心包
   ├── plugins/                                           # 插件示例
   └── pom.xml                                            # 依赖配置
   

2. 核心API类解析

2.1 Plugin类（插件基类）

Plugin类是所有BCV插件的基类，位于the.bytecode.club.bytecodeviewer.api包下。开发者需继承此类并实现核心方法。

2.1.1 主要方法

方法签名	功能描述
public abstract void execute(List<ClassNode> classNodeList)	插件入口点，接收加载的类节点列表
public void run()	线程执行方法，自动管理插件生命周期
public void setFinished()	标记插件完成状态（用于异步任务）
public boolean isFinished()	检查插件是否执行完毕

2.1.2 生命周期管理

// 插件执行流程伪代码
public class SamplePlugin extends Plugin {
    @Override
    public void execute(List<ClassNode> classNodeList) {
        // 1. 初始化操作
        BCV.log("插件开始执行");
        
        // 2. 处理类节点
        for (ClassNode cn : classNodeList) {
            BCV.log("处理类: " + cn.name);
            // 自定义逻辑...
        }
        
        // 3. 完成标记（异步任务需手动调用）
        setFinished();
    }
}

2.2 BCV类（核心工具类）

BCV类提供静态方法集，是插件与BCV核心交互的主要接口，封装了类加载、反编译、日志等核心功能。

2.2.1 类节点操作

方法	功能	参数说明
getClassNode(String name)	获取指定类名的ClassNode	name: 类全限定名（如"com/example/Test"）
getLoadedClasses()	获取所有加载的ClassNode	-
getCurrentlyOpenedClassNode()	获取当前选中的类节点	-

示例：

// 获取指定类节点
ClassNode cn = BCV.getClassNode("com/example/TargetClass");
if (cn != null) {
    BCV.log("找到类: " + cn.name);
    // 操作类节点...
}

2.2.2 反编译服务

BCV集成多种反编译器，可通过BCV类直接调用：

方法	反编译器类型
getProcyonDecompiler()	Procyon（推荐Java反编译）
getJADXDecompiler()	JADX（Android APK反编译）
getKrakatauDisassembler()	Krakatau（字节码反汇编）

示例：

// 反编译当前选中类
AbstractDecompiler decompiler = BCV.getProcyonDecompiler();
String code = BCV.decompileCurrentlyOpenedClassNode(decompiler);
BCV.log("反编译结果:\n" + code);

2.2.3 日志与UI交互

方法	功能
log(String s)	输出日志到控制台
logE(String s)	输出错误日志到控制台
showMessage(String message)	显示弹窗消息
setBusy(boolean busy)	设置忙碌状态（显示/隐藏进度图标）

2.3 ASMResourceUtil类（ASM工具类）

提供基于ASM的类/方法/字段操作工具，简化字节码修改流程。

主要方法：

方法	功能
renameClassNode(String oldName, String newName)	重命名类
renameMethodNode(String originalParentName, String originalMethodName, String originalMethodDesc, String newParent, String newName, String newDesc)	重命名方法
renameFieldNode(String originalParentName, String originalFieldName, String originalFieldDesc, String newFieldParent, String newFieldName, String newFieldDesc)	重命名字段
findMainMethod(String defaultFQN)	查找主方法入口

示例：重命名类和方法

// 将"com/example/OldClass"重命名为"com/example/NewClass"
ASMResourceUtil.renameClassNode("com/example/OldClass", "com/example/NewClass");

// 重命名方法: void test() -> void newTest()
ASMResourceUtil.renameMethodNode(
    "com/example/NewClass",  // 类名
    "test",                  // 原方法名
    "()V",                   // 原方法描述符
    "com/example/NewClass",  // 新类名
    "newTest",               // 新方法名
    "()V"                    // 新方法描述符
);

3. 插件开发实战

3.1 字符串解密插件示例

以下实现一个简单的字符串解密插件，演示核心API使用流程：

import org.objectweb.asm.tree.ClassNode;
import org.objectweb.asm.tree.MethodNode;
import the.bytecode.club.bytecodeviewer.api.ASMUtil;
import the.bytecode.club.bytecodeviewer.api.BCV;
import the.bytecode.club.bytecodeviewer.api.Plugin;
import java.util.List;

public class StringDecrypterPlugin extends Plugin {
    @Override
    public void execute(List<ClassNode> classNodeList) {
        BCV.log("字符串解密插件启动，处理类数量: " + classNodeList.size());
        
        // 遍历所有类节点
        for (ClassNode cn : classNodeList) {
            // 查找解密方法 (假设方法名为"decrypt"，参数为String)
            MethodNode decryptMethod = ASMUtil.getMethodByName(cn, "decrypt");
            
            if (decryptMethod != null) {
                BCV.log("找到解密方法: " + cn.name + "." + decryptMethod.name);
                
                // TODO: 实现解密逻辑（使用ASM修改字节码）
                processDecryption(cn, decryptMethod);
            }
        }
        
        BCV.showMessage("解密完成！处理类: " + classNodeList.size());
        setFinished(); // 标记完成
    }
    
    private void processDecryption(ClassNode cn, MethodNode method) {
        // 1. 解析方法指令
        // 2. 识别加密字符串模式
        // 3. 替换为解密后的值
        BCV.log("处理解密: " + cn.name + "." + method.name);
    }
}

3.2 插件打包与部署

1. 编译插件： 将Java文件编译为.class文件，确保依赖BCV的api包。

2. 打包结构：

   MyPlugin.jar/
   ├── com/
   │   └── example/
   │       └── StringDecrypterPlugin.class
   └── META-INF/
       └── MANIFEST.MF  # 可选，指定主类
   

3. 部署方法：

   • 将插件JAR放入BCV的plugins/目录
   • 通过UI菜单 Plugins > Load Plugin 加载

4. 高级功能

4.1 字节码钩子（BytecodeHook）

通过BCV.insertHook(BytecodeHook hook)方法可注入自定义字节码钩子，实现方法拦截与修改。

示例：

BytecodeHook hook = new BytecodeHook() {
    @Override
    public String getOwner() { return "com/example/Target"; }
    
    @Override
    public String getName() { return "processData"; }
    
    @Override
    public String getDesc() { return "(Ljava/lang/String;)V"; }
    
    @Override
    public String getHookCode() {
        // ASM字节码指令，实现参数打印
        return "ALOAD 1\n" +          // 加载参数String
               "INVOKESTATIC java/lang/System.out.println (Ljava/lang/String;)V\n" +
               "RETURN";              // 返回
    }
};

BCV.insertHook(hook); // 注册钩子

4.2 多语言插件支持

BCV支持多种脚本语言开发插件，包括：

• JavaScript
• Python
• Ruby
• Groovy

JavaScript示例（plugins/javascript/ExampleStringDecrypter.js）：

function execute(classNodeList) {
    print("JavaScript插件启动，处理类数量: " + classNodeList.length);
    
    // 遍历类节点
    for (var i = 0; i < classNodeList.length; i++) {
        var cn = classNodeList[i];
        print("处理类: " + cn.name);
    }
}

4.3 与UI组件交互

通过BCV.getTaskManager()可获取任务管理器，实现UI进度更新：

TaskManager taskManager = BCV.getTaskManager();
taskManager.addTask("解密字符串", classNodeList.size(), () -> {
    for (int i = 0; i < classNodeList.size(); i++) {
        // 处理任务...
        taskManager.setProgress(i + 1); // 更新进度
    }
});

5. 最佳实践与注意事项

5.1 性能优化

1. 批量处理：对大量类操作时使用BCV.getTaskManager()进行异步处理
2. 缓存复用：复用ClassNodeLoader实例，避免重复加载
3. 指令优化：ASM操作时使用ClassWriter.COMPUTE_FRAMES自动计算栈帧

5.2 错误处理

try {
    // 可能抛出异常的代码
    ClassNode cn = BCV.getClassNode("com/example/NonExistentClass");
    ASMResourceUtil.renameClassNode(cn.name, "NewName");
} catch (Exception e) {
    BCV.logE("操作失败: " + e.getMessage());
    ExceptionUI.buildErrorLogHeader("插件作者"); // 生成错误日志
}

5.3 兼容性考虑

• 确保插件使用Java 8兼容语法
• 避免直接依赖BCV内部非API类（如BytecodeViewer）
• 处理ClassNode为空的边界情况

6. 常用API速查表

功能分类	核心方法
类操作	BCV.getClassNode(), ASMResourceUtil.renameClassNode()
方法操作	ASMUtil.getMethodByName(), ASMResourceUtil.renameMethodNode()
反编译	BCV.getProcyonDecompiler(), BCV.decompileCurrentlyOpenedClassNode()
日志输出	BCV.log(), BCV.logE()
插件管理	BCV.startPlugin(), Plugin.setFinished()

7. 扩展学习资源

1. 官方示例插件：

   • plugins/java/ExampleStringDecrypter.java（字符串解密）
   • plugins/java/XposedGenerator.java（Xposed模块生成）

2. ASM文档：

   • ASM官方文档（字节码操作基础）

3. BCV源码分析：

   • src/main/java/the/bytecode/club/bytecodeviewer/decompilers/（反编译器实现）
   • src/main/java/the/bytecode/club/bytecodeviewer/plugin/（插件管理器）

8. 常见问题解答

Q1: 插件如何获取当前选中的类？
A: 使用BCV.getCurrentlyOpenedClassNode()方法：

ClassNode currentClass = BCV.getCurrentlyOpenedClassNode();
if (currentClass != null) {
    BCV.log("当前选中类: " + currentClass.name);
}

Q2: 如何实现自定义反编译逻辑？
A: 继承AbstractDecompiler类，实现decompileClassNode()方法，并通过BCV注册。

Q3: 插件支持多线程吗？
A: 支持，可通过BCV.getTaskManager().addTask()提交后台任务，避免UI阻塞。

---

【免费下载链接】bytecode-viewer A Java 8+ Jar & Android APK Reverse Engineering Suite (Decompiler, Editor, Debugger & More) 项目地址: https://gitcode.com/gh_mirrors/by/bytecode-viewer