使用 VSCode 調試 Koa 或者 Express 項目

前言

平常調試 node 打 log 打習慣了,突然發現一個問題就是打印對象的時候,尤其這個對象里面有很多屬性的時候,在終端上得一直往上拉才能看到,因此打算使用 vscode 來打斷點調試程序。

安裝

這里的例子是使用 koa ,express 類似。我是使用阿里巴巴的飛冰快速搭建一個后臺和前臺的項目。

  1. 下載飛冰
  2. 打開飛冰,使用ICE Design Pro模板并點擊 添加koa2,如下


    image
  3. 自動安裝完成后,使用 vscode 打開項目:


    image
  4. 打開終端,運行npm run client 這個時候前端項目就運行起來了。
  5. 稍微修改一下前端的代碼,因為這個模板默認是使用前端直接返回數據,而不去請求接口,打開client/pages/UserLogin/actions.js,將 import {login} from '../../api/user';改為 import {login} from '../../api/index';就可以了。最后打開頁面,地址終端里面有說明。

編寫launch.json

VsCode左側第四個按鈕是調試按鈕,默認是『沒有配置』。點擊右側的齒輪狀圖標,選擇Node.js 會在項目根目錄下創建 .vscode 的文件夾及 launch.json 文件。launch.json 內容如下:

{
    // 使用 IntelliSense 了解相關屬性。 
    // 懸停以查看現有屬性的描述。
    // 欲了解更多信息,請訪問: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "type": "node",
            "request": "launch",
            "name": "啟動程序",
            "program": "${workspaceFolder}/server/index.js"
        }
    ]
}

默認會訪問server下的 index.js 文件,但是這個項目的入口文件是 app.js,因此需要將index.js改為app.js

在launch.json中會使用到一些預定變量,這里說明一下:

  • ${workspaceRoot}:VSCode中打開文件夾的路徑
  • ${workspaceRootFolderName}:VSCode中打開文件夾的路徑, 但不包含"/"
  • ${file}:當前打開的文件
  • ${fileBasename}: 當前打開文件的文件名, 不含擴展名
  • ${fileDirname}: 當前打開文件的目錄名
  • ${fileExtname} 當前打開文件的擴展名
  • ${cwd}:當前執行目錄

當我們在單步調試程序的時候,會進入node_modules里面,通常情況下我們并不需要去關心里面的邏輯實現,只關心項目本身的代碼。在這個時候,我們就需要使用skipFiles:

{
  // 使用 IntelliSense 了解相關屬性。
  // 懸停以查看現有屬性的描述。
  // 欲了解更多信息,請訪問: https://go.microsoft.com/fwlink/?linkid=830387
  "version": "0.2.0",
  "configurations": [{
    "type": "node",
    "request": "launch",
    "name": "啟動程序",
    "program": "${workspaceFolder}/server/app.js",
    "skipFiles": [
      "${workspaceRoot}/node_modules/**/*.js",
      "<node_internals>/**/*.js"
    ]
  }]
}

我們還想要自動重啟的功能,安裝 nodemon 或者 node-dev

// 任選其一
npm i nodemon -g
npm i node-dev -g

修改lanuch.json:

{
  // 使用 IntelliSense 了解相關屬性。
  // 懸停以查看現有屬性的描述。
  // 欲了解更多信息,請訪問: https://go.microsoft.com/fwlink/?linkid=830387
  "version": "0.2.0",
  "configurations": [{
    "type": "node",
    "request": "launch",
    "name": "啟動程序",
    "program": "${workspaceFolder}/server/app.js",
    "runtimeExecutable": "nodemon", // 或者 node-dev
    "restart": true,
    "console": "integratedTerminal",
    "skipFiles": [
      "${workspaceRoot}/node_modules/**/*.js",
      "<node_internals>/**/*.js"
    ]
  }]
}

這里新增了三個字段,分別是:

  • runtimeExecutable:用什么命令執行 app.js,這里設置為 nodemon,默認是 node
  • restart:在終止 Node.js 后重啟會話
  • console:啟動調試目標的位置,這里選擇在 vscode 的集成終端輸出信息

調試

這里在 server/controller/user.js 的 login 打了個斷點:

image
啟動調試,如下:
image

vscode 集成終端打印如下:
image

在前端頁面點擊登錄,會跳到這里:
image

我們就能看到變量的信息啦??(注意:如果此時終止了調試,nodemon 還是會運行,得在集成終端終止)

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,461評論 6 532
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,538評論 3 417
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,423評論 0 375
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,991評論 1 312
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,761評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,207評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,268評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,419評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,959評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,782評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,983評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,528評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,222評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,653評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,901評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,678評論 3 392
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,978評論 2 374

推薦閱讀更多精彩內容