Local Tomcat 扩展设置与调试和启动配置使用教學
概述
此文檔說明如何在 Visual Studio Code 中使用 Local Tomcat 擴展設置和調試與啟動配置。這些設置允許您輕鬆管理本地 Tomcat 伺服器實例，並進行遠程調試。
Settings.json 配置示例
要在 VS Code 中使用這些功能，您需要在工作區的 .vscode/settings.json 文件中添加相應的配置。以下是完整的配置示例：
{
"_comment_local_tomcat": "Local Tomcat 扩展设置",
"local-tomcat.tomcatInstances": [
{
"name": "ERPCOM",
"catalinaHome": "D:\\wpg\\tomcat\\apache-tomcat-9.0.112",
"deploymentPort": 8080,
"javaHome": "D:\\java\\jdk11",
"logs": [
{
"name": "Catalina Log",
"path": "logs/catalina.out"
},
{
"name": "Access Log",
"path": "logs/localhost_access_log.txt"
}
]
}
],
"local-tomcat.warDir": "build/libs",
"local-tomcat.terminalMode": true,
"_comment_debug": "调试和启动配置",
"files.encoding": "utf8",
"launch": {
"configurations": [
{
"type": "java",
"name": "Debug Tomcat (Remote)",
"request": "attach",
"hostName": "localhost",
"port": 8000,
"projectName": "ERPOM"
}
]
}
}
配置步驟
- 打開或創建 settings.json 文件：
- 在 VS Code 中，按
Ctrl+Shift+P打開命令面板。 - 輸入 "Preferences: Open Workspace Settings (JSON)" 並選擇。
-
這會打開
.vscode/settings.json文件。 -
添加 Local Tomcat 配置：
- 複製上述
local-tomcat.*相關設置到您的 settings.json 中。 -
修改路徑以匹配您的本地環境。
-
添加調試配置：
- 複製
files.encoding和launch部分到您的 settings.json 中。 -
確保
projectName與您的項目名稱一致。 -
保存文件：
- 保存 settings.json 文件後，重新加載 VS Code 窗口以使設置生效。
注意：路徑中的反斜槓 \ 在 JSON 中需要轉義為 \\，或使用正斜槓 /。
Local Tomcat 扩展设置
配置說明
Local Tomcat 擴展允許您在 VS Code 中直接管理 Tomcat 伺服器實例。
local-tomcat.tomcatInstances
定義可用的 Tomcat 實例列表。每個實例包含以下配置：
"name": 實例名稱，例如 "ERPCOM""catalinaHome": Tomcat 安裝目錄路徑，例如 "D:\wpg\tomcat\apache-tomcat-9.0.112""deploymentPort": 部署端口，通常為 8080"javaHome": Tomcat 使用的 JDK 路徑，例如 "D:\java\jdk11""logs": 日誌配置數組"name": 日誌名稱，例如 "Catalina Log""path": 日誌文件相對路徑，例如 "logs/catalina.out"
local-tomcat.warDir
指定 WAR 文件的目錄路徑，例如 "build/libs"。擴展會在此目錄中查找 WAR 文件進行部署。
local-tomcat.terminalMode
設置為 true 時，在終端中運行 Tomcat 命令，便於查看輸出和調試。
使用教學
- 安裝 Local Tomcat 擴展：
-
在 VS Code 擴展市場中搜索 "Local Tomcat" 並安裝。
-
配置 Tomcat 實例：
- 在
.vscode/settings.json中添加local-tomcat.tomcatInstances配置。 - 確保
catalinaHome指向正確的 Tomcat 安裝目錄。 -
設置適當的
javaHome（建議使用 JDK 11 或更高版本）。 -
啟動 Tomcat：
- 在 VS Code 命令面板中運行 "Local Tomcat: Start" 命令。
-
選擇要啟動的實例。
-
部署應用：
- 確保 WAR 文件位於
warDir指定的目錄中。 -
使用 "Local Tomcat: Deploy" 命令部署應用。
-
查看日誌：
-
使用 "Local Tomcat: Show Logs" 命令查看配置的日誌文件。
-
停止 Tomcat：
- 使用 "Local Tomcat: Stop" 命令停止運行中的實例。
调试和启动配置
调试配置說明
調試配置允許您附加到運行中的 Tomcat 實例進行遠程調試。
files.encoding
設置文件編碼為 UTF-8，確保中文字符正確顯示。
launch.configurations
定義啟動配置數組。每個配置是一個對象，包含以下字段：
"type": 配置類型，必須設為 "java"，表示這是 Java 應用程序的調試配置。"name": 配置名稱，在 VS Code 的調試面板中顯示，用於識別不同的調試配置。"request": 請求類型，設為 "attach" 表示附加到已經運行的 Java 進程；設為 "launch" 表示啟動新的 Java 進程。"hostName": 主機名，調試目標的 IP 地址或域名，通常為 "localhost" 表示本地機器。"port": 調試端口，Java 應用程序監聽調試連接的端口號，必須與 Tomcat 的 JPDA 端口一致。"projectName": 項目名稱，對應於 VS Code 中打開的 Java 項目名稱，用於正確映射源代碼。
其他可選字段
除了基本字段外，還可以添加以下可選字段來優化調試體驗：
"timeout": 連接超時時間（毫秒），默認值為 30000（30 秒）。"sourcePaths": 源代碼路徑數組，用於指定額外的源代碼目錄。"classPaths": 類路徑數組，用於指定額外的類路徑。"console": 控制台類型，可設為 "internalConsole"、"integratedTerminal" 或 "externalTerminal"。
示例配置
{
"type": "java",
"name": "Debug Tomcat (Remote)",
"request": "attach",
"hostName": "localhost",
"port": 8000,
"projectName": "ERPOM",
"timeout": 30000
}
配置注意事項
- 端口匹配：確保
port字段的值與 Tomcat 的 JPDA_ADDRESS 設置一致。 - 項目名稱：
projectName必須與您的 VS Code 工作區中的 Java 項目名稱完全匹配。 - 防火牆：如果連接失敗，檢查防火牆是否阻止了調試端口的連接。
- 多個配置：您可以在
configurations數組中添加多個調試配置，用於不同的環境或場景。
调试使用教學
- 配置 Tomcat 調試：
-
在 Tomcat 的
catalina.sh或setenv.sh中添加 JPDA 參數：export JPDA_ADDRESS=8000 export JPDA_TRANSPORT=dt_socket -
或者在啟動命令中添加：
catalina.sh jpda start -
啟動調試模式：
-
使用 Local Tomcat 擴展啟動 Tomcat，或手動啟動：
./catalina.sh jpda start -
附加調試器：
- 在 VS Code 中，按 F5 或轉到運行和調試面板。
- 選擇 "Debug Tomcat (Remote)" 配置。
-
點擊綠色播放按鈕開始調試。
-
設置斷點：
- 在 Java 源代碼中點擊行號左側設置斷點。
-
當請求到達斷點時，執行將暫停。
-
調試操作：
- 使用調試面板中的控件：繼續、步進、步入、步出等。
-
查看變量值、調用堆棧等。
-
停止調試：
- 點擊調試面板中的停止按鈕，或關閉調試會話。
注意事項
- 確保 JDK 版本與 Tomcat 兼容（建議 JDK 11+）。
- 調試端口 8000 必須與 Tomcat 配置一致(Tomcat 的
catalina.sh或setenv.sh中添加 JPDA 參數)。 - 如果遇到連接問題，檢查防火牆設置和端口占用。
- 定期清理 Tomcat 日誌以節省磁盤空間。
修改日期
2025-12-03