SpringBoot結合Vue實現(xiàn)Python在線調試器
項目概述
Python 在線調試器是一個基于 Web 的 Python 代碼執(zhí)行和調試工具,支持在線編寫、運行和交互式調試 Python 代碼。項目采用前后端分離架構,前端負責用戶界面和交互,后端負責代碼執(zhí)行和調試邏輯。
技術棧
后端技術棧
| 技術/框架 | 版本 | 用途 |
|---|---|---|
| Java | 17 | 編程語言 |
| Spring Boot | 3.1.5 | Web框架 |
| Spring Web | - | RESTful API支持 |
| Spring Validation | - | 參數(shù)驗證 |
| Jackson | - | JSON序列化/反序列化 |
| Maven | 3.6+ | 項目構建和依賴管理 |
| Python | 3.x | 代碼執(zhí)行環(huán)境 |
核心依賴:
spring-boot-starter-web: Web開發(fā)支持spring-boot-starter-websocket: WebSocket支持(預留擴展)spring-boot-starter-validation: 參數(shù)驗證jackson-databind: JSON處理
前端技術棧
| 技術/框架 | 版本 | 用途 |
|---|---|---|
| Vue.js | 3.3.4 | 前端框架 |
| Vite | 5.0.0 | 構建工具和開發(fā)服務器 |
| CodeMirror 6 | 6.x | 代碼編輯器 |
| Axios | 1.6.0 | HTTP客戶端 |
| Node.js | 16+ | 運行環(huán)境 |
| npm | - | 包管理器 |
核心依賴:
@codemirror/lang-python: Python語言支持@codemirror/view: 編輯器視圖@codemirror/state: 編輯器狀態(tài)管理@codemirror/theme-one-dark: 深色主題@vitejs/plugin-vue: Vite Vue插件
架構設計
整體架構
┌─────────────────────────────────────────────────────────┐
│ 瀏覽器 (Browser) │
│ ┌──────────────────────────────────────────────────┐ │
│ │ Vue 3 前端應用 │ │
│ │ ┌──────────────┐ ┌──────────────────┐ │ │
│ │ │ CodeMirror 6 │ │ Axios HTTP │ │ │
│ │ │ 編輯器 │ │ 客戶端 │ │ │
│ │ └──────────────┘ └──────────────────┘ │ │
│ └──────────────────────────────────────────────────┘ │
└─────────────────┬───────────────────────────────────────┘
│ HTTP/REST API
┌─────────────────┴───────────────────────────────────────┐
│ Spring Boot 后端 (Port: 8080) │
│ ┌──────────────────────────────────────────────────┐ │
│ │ PythonController │ │
│ │ (REST API 端點) │ │
│ └────────────────┬─────────────────────────────────┘ │
│ │ │
│ ┌────────────────┴─────────────────────────────────┐ │
│ │ PythonExecutionService │ │
│ │ (代碼執(zhí)行和調試邏輯) │ │
│ └────────────────┬─────────────────────────────────┘ │
│ │ │
│ ┌────────────────┴─────────────────────────────────┐ │
│ │ ProcessBuilder + Python Process │ │
│ │ (執(zhí)行Python代碼) │ │
│ └────────────────┬─────────────────────────────────┘ │
│ │ │
│ ┌────────────────┴─────────────────────────────────┐ │
│ │ Python 3.x (系統(tǒng)安裝) │ │
│ │ - pdb (Python調試器) │ │
│ │ - 代碼執(zhí)行 │ │
│ └──────────────────────────────────────────────────┘ │
└──────────────────────────────────────────────────────────┘
分層架構
后端分層
Controller層 (PythonController)
↓
Service層 (PythonExecutionService)
↓
Process層 (Java ProcessBuilder)
↓
Python運行時環(huán)境
前端分層
視圖層 (App.vue Template)
↓
邏輯層 (App.vue Script - Composition API)
↓
編輯器層 (CodeMirror 6)
↓
HTTP層 (Axios)
核心實現(xiàn)方法
1. 代碼執(zhí)行實現(xiàn)
1.1 后端實現(xiàn) (PythonExecutionService.executeCode)
核心步驟:
創(chuàng)建臨時文件
Path pythonFile = Paths.get(tempDir, "python_" + sessionId + ".py");
Files.write(pythonFile, code.getBytes("UTF-8"));
啟動Python進程
ProcessBuilder processBuilder = new ProcessBuilder(pythonCmd, pythonFile.toString());
processBuilder.environment().put("PYTHONIOENCODING", "utf-8");
Process process = processBuilder.start();
讀取輸出
BufferedReader reader = new BufferedReader(
new InputStreamReader(process.getInputStream(), "UTF-8"));
// 設置30秒超時
boolean finished = process.waitFor(30, TimeUnit.SECONDS);
清理資源
Files.deleteIfExists(pythonFile); runningProcesses.remove(sessionId);
關鍵技術點:
- 使用
ProcessBuilder創(chuàng)建獨立的Python進程 - 設置
PYTHONIOENCODING=utf-8確保中文輸出正確 - 使用臨時文件存儲用戶代碼
- 設置執(zhí)行超時防止死循環(huán)
- UTF-8編碼處理確保字符正確傳輸
2. 調試功能實現(xiàn)
2.1 斷點插入機制
實現(xiàn)方法:
行號映射表構建
Map<Integer, Integer> lineMapping = new HashMap<>(); // 實際行號 -> 原始行號
斷點代碼注入
// 在斷點行之前插入 pdb.set_trace()
result.append(indentStr).append("pdb.set_trace() # Breakpoint at line ")
.append(originalLineNumber).append("\n");
行號映射記錄
- 為所有插入的代碼行建立映射
- 包括
import pdb、空行、pdb.set_trace()等 - 確保能準確還原原始行號
2.2 交互式調試會話管理
DebugSession 類:
private static class DebugSession {
Process process; // Python進程
BufferedWriter stdin; // 標準輸入流(發(fā)送pdb命令)
Path pythonFile; // 臨時Python文件
boolean isActive; // 會話是否激活
int currentLine; // 當前執(zhí)行行號
StringBuilder outputBuffer; // 輸出緩沖區(qū)
StringBuilder errorBuffer; // 錯誤緩沖區(qū)
Map<Integer, Integer> lineMapping; // 行號映射表
}
會話管理:
- 使用
ConcurrentHashMap存儲多個調試會話 - 支持并發(fā)調試多個用戶
- 自動清理會話資源
2.3 PDB命令映射
支持的調試操作:
| 操作 | PDB命令 | 說明 |
|---|---|---|
| 繼續(xù)執(zhí)行 | c\n | continue - 繼續(xù)到下一個斷點 |
| 單步執(zhí)行 | n\n | next - 執(zhí)行下一行(不進入函數(shù)) |
| 步入 | s\n | step - 進入函數(shù)內部 |
| 步出 | u\n | up - 返回到調用者 |
實現(xiàn)方式:
String pdbCommand;
switch (action) {
case "continue": pdbCommand = "c\n"; break;
case "step": pdbCommand = "s\n"; break;
case "stepOver": pdbCommand = "n\n"; break;
case "stepOut": pdbCommand = "u\n"; break;
}
session.stdin.write(pdbCommand);
session.stdin.flush();
2.4 行號解析和映射
PDB輸出格式解析:
// PDB輸出格式: > /path/to/file.py(行號)function_name()
Pattern pattern = Pattern.compile(">\\s+[^\\(]*\\(\\s*(\\d+)\\s*\\)[^\n]*");
行號轉換:
- 從PDB輸出中提取實際行號
- 通過映射表轉換為原始行號
- 如果沒有精確匹配,向上查找最接近的行號
- 返回給前端顯示
3. 前端編輯器實現(xiàn)
3.1 CodeMirror 6 集成
編輯器初始化:
editorView.value = new EditorView({
doc: codeContent,
extensions: [
basicSetup, // 基礎功能
python(), // Python語言支持
oneDark, // 深色主題
breakpointGutter, // 斷點gutter
currentLineHighlight // 當前行高亮
],
parent: editorContainer.value
})
3.2 斷點可視化
實現(xiàn)原理:
- 使用
GutterMarker創(chuàng)建斷點標記 - 使用
StateField管理斷點狀態(tài) - 使用
RangeSet存儲斷點位置 - 支持點擊gutter區(qū)域切換斷點
關鍵代碼:
// 斷點標記類
class BreakpointMarker extends GutterMarker {
toDOM() {
const span = document.createElement('span')
span.className = 'breakpoint-marker'
span.textContent = '●'
return span
}
}
// 斷點狀態(tài)字段
const breakpointState = StateField.define({
create() { return RangeSet.empty },
update(breakpoints, tr) {
// 處理斷點變更
}
})
3.3 當前行高亮
實現(xiàn)方法:
// 當前行裝飾器
const currentLineDecoration = Decoration.line({
class: 'cm-current-line'
})
// 當前行狀態(tài)字段
const currentLineState = StateField.define({
create() { return RangeSet.empty },
update(currentLine, tr) {
// 更新當前行位置
},
provide: f => EditorView.decorations.from(f)
})
樣式定義:
.cm-current-line {
background-color: rgba(78, 148, 255, 0.15);
outline: 1px solid rgba(78, 148, 255, 0.3);
}
關鍵技術點
1. 進程管理
進程啟動:
- 使用
ProcessBuilder創(chuàng)建獨立進程 - 分離標準輸出和錯誤輸出
- 設置環(huán)境變量確保編碼正確
進程控制:
- 使用
Process.waitFor(timeout)實現(xiàn)超時控制 - 使用
Process.destroyForcibly()強制終止 - 使用
ConcurrentHashMap管理多個進程
2. 異步I/O處理
輸出讀?。?/strong>
Thread outputThread = new Thread(() -> {
try (BufferedReader reader = ...) {
String line;
while ((line = reader.readLine()) != null && session.isActive) {
synchronized (session.outputBuffer) {
session.outputBuffer.append(line).append("\n");
}
}
}
});
outputThread.start();
關鍵點:
- 使用獨立線程讀取進程輸出
- 使用同步塊保證線程安全
- 實時解析行號并更新狀態(tài)
3. 行號映射算法
問題:
- 插入
import pdb和pdb.set_trace()后行號會偏移 - PDB顯示的是插入后的行號,需要轉換為原始行號
解決方案:
- 構建完整的行號映射表
- 精確匹配優(yōu)先
- 向上查找最接近的行號(最多10行)
- 如果找不到,使用估算方法
4. 編碼處理
UTF-8編碼設置:
// 后端
processBuilder.environment().put("PYTHONIOENCODING", "utf-8");
Files.write(pythonFile, code.getBytes("UTF-8"));
new InputStreamReader(process.getInputStream(), "UTF-8")
// 前端
// Axios自動處理UTF-8編碼
配置文件:
server.servlet.encoding.charset=UTF-8 server.servlet.encoding.enabled=true server.servlet.encoding.force=true spring.http.encoding.charset=UTF-8 spring.http.encoding.enabled=true spring.http.encoding.force=true
5. 會話管理
會話存儲:
ConcurrentHashMap<String, DebugSession> debugSessions ConcurrentHashMap<String, Process> runningProcesses
會話生命周期:
- 開始調試時創(chuàng)建會話
- 執(zhí)行調試命令時更新會話
- 調試完成或停止時清理會話
- 自動清理臨時文件
API接口設計
1. 代碼執(zhí)行接口
接口: POST /api/python/execute
請求體:
{
"code": "print('Hello, World!')",
"sessionId": "session_123"
}
響應:
{
"output": "Hello, World!\n",
"error": "",
"success": true,
"sessionId": "session_123"
}
2. 調試接口
接口: POST /api/python/debug
請求體:
{
"code": "def func():\n x = 10\n return x",
"sessionId": "session_123",
"breakpoints": [2, 3],
"action": "start" | "continue" | "step" | "stepOver" | "stepOut"
}
響應:
{
"output": "> file.py(2)func()\n-> x = 10",
"error": "",
"success": true,
"currentLine": 2,
"sessionId": "session_123"
}
3. 停止執(zhí)行接口
接口: POST /api/python/stop/{sessionId}
響應:
執(zhí)行已停止
調試功能實現(xiàn)原理
1. 斷點插入流程
原始代碼 插入后代碼
───────────────── ─────────────────
1 def func(): 1 import pdb
2 x = 10 2
3 return x 3 def func():
4 pdb.set_trace() # Breakpoint at line 2
5 x = 10
6 return x
行號映射:
實際行號 -> 原始行號
4 -> 2
5 -> 2
2. PDB交互流程
前端 后端 Python進程
│ │ │
│-- startDebug ---->│ │
│ │-- 創(chuàng)建臨時文件 ----->│
│ │-- 啟動進程 --------->│
│ │<-- PDB暫停在第N行 ---│
│<-- 返回行號N -----│ │
│ │ │
│-- step ---------->│ │
│ │-- 發(fā)送 's\n' ------->│
│ │ │-- 步入函數(shù)
│ │<-- PDB暫停在第M行 ---│
│<-- 返回行號M -----│ │
3. 行號解析流程
PDB輸出: "> file.py(15)func()\n-> x = 10"
↓
正則匹配: Pattern.compile(">\s+[^\(]*\(\s*(\d+)\s*\)")
↓
提取行號: 15
↓
查找映射: lineMapping.get(15) = 12
↓
返回前端: currentLine = 12
前端交互實現(xiàn)
1. Vue 3 Composition API
響應式狀態(tài):
const breakpoints = ref([]) const currentDebugLine = ref(null) const isInDebugMode = ref(false)
生命周期管理:
onMounted(() => {
initEditor()
sessionId.value = generateSessionId()
window.addEventListener('keydown', handleKeyPress)
})
onUnmounted(() => {
window.removeEventListener('keydown', handleKeyPress)
})
2. 斷點管理
添加斷點:
const addBreakpoint = () => {
if (newBreakpoint.value && newBreakpoint.value > 0) {
if (!breakpoints.value.includes(lineNum)) {
breakpoints.value.push(lineNum)
breakpoints.value.sort((a, b) => a - b)
syncBreakpointsToEditor()
}
}
}
斷點同步:
watch(breakpoints, () => {
nextTick(() => {
syncBreakpointsToEditor()
})
}, { deep: true })
3. 調試控制
調試命令執(zhí)行:
const executeDebugCommand = async (action) => {
const response = await axios.post(`${API_BASE}/debug`, {
code: '',
sessionId: sessionId.value,
breakpoints: [],
action: action // 'continue', 'step', 'stepOver', 'stepOut'
})
// 更新當前行號并高亮
if (result.currentLine) {
currentDebugLine.value = result.currentLine
highlightCurrentLine(result.currentLine)
}
}
鍵盤快捷鍵:
- F5: 繼續(xù)執(zhí)行
- F7: 步入
- F8: 單步執(zhí)行
- Shift+F8: 步出
4. 實時更新機制
當前行高亮更新:
const highlightCurrentLine = (lineNum) => {
const view = editorView.value
const line = view.state.doc.line(lineNum)
view.dispatch({
effects: [
EditorView.scrollIntoView(line.from, { y: 'center' }),
setCurrentLineEffect.of(line.from)
]
})
}
部署方案
附代碼倉庫鏈接:https://gitee.com/ghostmen/python-debug-demo
開發(fā)環(huán)境
后端:
- 端口:8080
- 啟動:
mvn spring-boot:run - 或使用:
start-backend.bat/start-backend.sh
前端:
- 端口:3000
- 啟動:
npm run dev - 或使用:
start-frontend.bat/start-frontend.sh - Vite代理:
/api→http://localhost:8080
生產(chǎn)環(huán)境建議
后端:
- 打包:
mvn clean package - 運行:
java -jar target/python-debug-backend-1.0.0.jar - 配置:修改
application.properties - 反向代理:Nginx
前端:
- 構建:
npm run build - 輸出目錄:
dist/ - 靜態(tài)資源服務器:Nginx / Apache
- 或集成到后端靜態(tài)資源
安全建議
代碼執(zhí)行限制
- 添加沙箱機制
- 限制系統(tǒng)調用
- 限制資源使用(CPU、內存)
網(wǎng)絡安全
- 配置具體的CORS允許域名
- 使用HTTPS
- 添加身份驗證
輸入驗證
- 驗證代碼長度
- 過濾危險操作
- 設置執(zhí)行超時
性能優(yōu)化
1. 進程管理優(yōu)化
- 限制并發(fā)執(zhí)行的進程數(shù)
- 及時清理已完成的進程
- 使用線程池管理I/O操作
2. 前端優(yōu)化
- 代碼編輯器懶加載
- 輸出內容虛擬滾動(大量輸出時)
- 防抖處理頻繁的斷點操作
3. 緩存策略
- 緩存Python命令檢測結果
- 復用調試會話(如果可能)
擴展方案
1. WebSocket實時交互
優(yōu)勢:
- 實時雙向通信
- 更好的調試體驗
- 支持斷點處的變量查看
實現(xiàn)方向:
- 使用 Spring WebSocket
- 前端使用 WebSocket API
- 實時推送調試狀態(tài)
2. 使用debugpy替代pdb
優(yōu)勢:
- 更專業(yè)的調試協(xié)議(DAP)
- 更好的性能
- 支持更多調試功能
實現(xiàn)方向:
- 集成debugpy庫
- 實現(xiàn)DAP協(xié)議客戶端
- 支持變量查看、表達式求值等
3. 多文件支持
實現(xiàn)方向:
- 文件管理器組件
- 多標簽編輯器
- 文件間依賴管理
4. 代碼補全
實現(xiàn)方向:
- 集成Python語言服務器(如Pyright)
- CodeMirror自動補全擴展
- 提供代碼提示和錯誤檢查
技術難點與解決方案
難點1: 行號映射準確性
問題: 插入調試代碼后,行號偏移,需要準確映射回原始行號。
解決方案:
- 建立完整的行號映射表
- 使用向上查找算法作為備選
- 智能匹配最接近的行號
難點2: PDB輸出解析
問題: PDB輸出格式多樣,需要準確提取當前行號。
解決方案:
- 使用正則表達式匹配多種格式
- 從后往前查找最新的PDB提示符
- 容錯處理,支持多種輸出格式
難點3: 異步I/O同步
問題: 異步讀取輸出與同步操作之間的時序問題。
解決方案:
- 使用同步塊保護共享資源
- 合理的等待時間
- 狀態(tài)標志控制異步讀取
難點4: 編碼問題
問題: Windows系統(tǒng)默認GBK編碼,導致中文亂碼。
解決方案:
- 設置
PYTHONIOENCODING=utf-8環(huán)境變量 - 統(tǒng)一使用UTF-8編碼
- Spring Boot配置UTF-8響應編碼
總結
本項目采用前后端分離架構,使用Spring Boot 3.x和Vue 3構建,通過ProcessBuilder執(zhí)行Python代碼,使用pdb實現(xiàn)交互式調試。核心特點:
- 技術選型合理:現(xiàn)代化的技術棧,易于維護和擴展
- 實現(xiàn)方案可行:使用成熟的ProcessBuilder和pdb,穩(wěn)定性好
- 用戶體驗良好:可視化斷點、當前行高亮、快捷鍵支持
- 擴展性強:預留WebSocket接口,可升級到更專業(yè)的調試方案
改進方向:
- 使用debugpy實現(xiàn)更專業(yè)的調試
- 添加WebSocket實現(xiàn)實時交互
- 增強安全性和性能優(yōu)化
- 支持更多調試功能(變量查看、表達式求值等)
以上就是SpringBoot結合Vue實現(xiàn)Python在線調試器的詳細內容,更多關于SpringBoot在線調試Python的資料請關注腳本之家其它相關文章!
相關文章
springboot多節(jié)點應用里的雪花算法唯一性詳解
雪花算法在單節(jié)點下唯一,但在多副本Kubernetes環(huán)境中可能重復,通過修改Pod名稱生成workId,解決了這個問題,同時避免了第三方組件和網(wǎng)絡請求,本文給大家介紹springboot多節(jié)點應用里的雪花算法唯一性,感興趣的朋友一起看看吧2024-12-12
教你開發(fā)腳手架集成Spring?Boot?Actuator監(jiān)控的詳細過程
這篇文章主要介紹了開發(fā)腳手架集成Spring?Boot?Actuator監(jiān)控的詳細過程,集成包括引入依賴配置文件及訪問驗證的相關知識,本文給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2022-05-05
使用AOP攔截Controller獲取@PathVariable注解傳入的參數(shù)
這篇文章主要介紹了使用AOP攔截Controller獲取@PathVariable注解傳入的參數(shù),具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-08-08

