当前位置：首页 > news >正文

【BurpSuite 2025最新版插件开发】基础篇10（完）：日志记录与调试

news 2025/7/13 6:33:25

1 前言

在 BurpSuite 插件开发过程中，日志记录和代码调试是保障插件稳定性、提升开发效率的核心环节。无论是追踪代码执行流程、排查异常问题，还是向用户反馈插件状态，合理的日志策略和熟练的调试技巧都至关重要。

本文基于 BurpSuite 的 Montoya API，详细介绍日志记录的两种核心方式（流日志与事件日志），并结合代码案例讲解插件代码的调试方法，帮助开发者快速定位问题、优化插件功能。

历史章节：

【BurpSuite 2025最新版插件开发】基础篇1：环境搭建

【BurpSuite 2025最新版插件开发】基础篇2：插件生命周期与核心接口

【BurpSuite 2025最新版插件开发】基础篇3：请求拦截和修改简单示例

【BurpSuite 2025最新版插件开发】基础篇4：HTTP流量处理

【BurpSuite 2025最新版插件开发】基础篇5：UI组件开发

【BurpSuite 2025最新版插件开发】基础篇6：UI组件与数据传输

【BurpSuite 2025最新版插件开发】基础篇7：数据的持久化存储

【BurpSuite 2025最新版插件开发】基础篇8：多线程与异步处理（1）

【BurpSuite 2025最新版插件开发】基础篇9：多线程与异步处理（2）

2 官方接口

接口文档

接口类型

标准输出流
标准错误流
关键事件日志
调试事件日志
错误事件日志
信息事件日志

3 输出流

产生日志时，插件页面下方的菜单会变红。
在这里插入图片描述

3.1 标准流

// 标准流打印字符串
montoyaApi.logging().logToOutput("输出流日志");// 打印对象
montoyaApi.logging().logToOutput(new Object());

在这里插入图片描述

3.2 错误流

// 错误流打印字符串
montoyaApi.logging().logToError("错误流日志");// 错误流打印堆栈跟踪
montoyaApi.logging().logToError(new Exception("错误流堆栈日志"));

在这里插入图片描述
插件程序本身产生错误时，也会输出错误流日志：

示例代码：

import burp.api.montoya.MontoyaApi;
import burp.api.montoya.ui.contextmenu.ContextMenuEvent;
import burp.api.montoya.ui.contextmenu.ContextMenuItemsProvider;import javax.swing.*;
import java.awt.*;
import java.util.ArrayList;
import java.util.List;public class Logger implements ContextMenuItemsProvider {private final MontoyaApi montoyaApi;public Logger(MontoyaApi montoyaApi) {this.montoyaApi = montoyaApi;}@Overridepublic List<Component> provideMenuItems(ContextMenuEvent event) {List<Component> menuItems = new ArrayList<>();JMenuItem streamItem = new JMenuItem("输出流日志");streamItem.addActionListener(e -> {streamLog();});menuItems.add(streamItem);return menuItems;}private void streamLog() {// 系统自己产生的错误流simulateSystemError();}private void simulateSystemError() {try {// 模拟一个运行时异常int result = 10 / 0;} catch (Exception e) {montoyaApi.logging().logToError("模拟的系统错误: " + e.getMessage());montoyaApi.logging().logToError(e);}}
}

在这里插入图片描述

4 事件日志

montoyaApi.logging().raiseCriticalEvent("关键事件日志");
montoyaApi.logging().raiseDebugEvent("调试事件日志");
montoyaApi.logging().raiseInfoEvent("信息事件日志");
montoyaApi.logging().raiseErrorEvent("错误事件日志");

在插件底部的 Event log 面板中独立展示，是一个全局菜单。

在这里插入图片描述

5 日志总结

项目	流日志	事件日志
目的	输出调试信息	记录关键事件
日志内容	流式日志（变量、流程、状态）	事件驱动（操作、触发、状态变更）
是否结构化	否	是（有统一格式）
常见用途	开发调试、流程追踪	行为审计、插件生命周期记录
是否需要单独封装	否（封装意义不大）	推荐封装为独立方法，便于统一管理
是否常用于异常处理	否	否
是否需线程安全	否	否

实践建议：

流日志适用于快速调试和临时日志输出，适合开发者查看当前代码执行情况。
事件日志适用于记录重要行为或状态变化，适合长期维护、审计或插件使用者理解插件行为。

6 插件调试

6.1 环境参数

当前演示版本：

BurpSuite Community Edition v2025.5.6
IDEA 2025.1.3 Community Edition
JDK 23.0.2
Gradle 8.14

6.2 调试步骤

编辑调试配置：
在这里插入图片描述
新建配置：选择创建 Remote JVM Debug

保存配置：配置好后，先不要启动 Debug，当前配置的端口还未启动服务。

在这里插入图片描述
启动脚本
根据你自己的本地配置，修改下面脚本中配置变量的参数值。

@echo off
setlocal:: 配置变量
set "DEBUG_PORT=5005"
set "BURP_JAR=D:\DEV\BurpSuiteCommunity\burpsuite_community.jar"
set "JAVA_CMD=D:\DEV\Java\Java23.0.2\bin\java.exe"
set "JAVA_OPTS=-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:%DEBUG_PORT% -Dfile.encoding=utf-8":: 启动Burp Suite
echo Starting Burp Suite with remote debugging on port %DEBUG_PORT%...
start "burpsuite" /B "%JAVA_CMD%" %JAVA_OPTS% -jar "%BURP_JAR%" %*:: 检查端口占用情况
echo Checking port %DEBUG_PORT% status...
timeout /t 2 /nobreak >nulnetstat -ano | findstr ":%DEBUG_PORT% " >nul
if %errorlevel% equ 0 (echo Port %DEBUG_PORT% is LISTENING - Debugger ready.
) else (echo WARNING: Port %DEBUG_PORT% is not being listened on. Debugging may not work.
)pause