vscode + wsl/ssh 搭建linux下C++的编译、调试环境

￡神魔★判官ぃ 2022-10-16 09:44 499阅读 0赞

linux下调试C++程序一般用gdb或log的方式，gdb虽然能断点单步调试，但是纯命令行调试不够方便直观，vscode推出了远程调试的一些插件，可以方便的搭建linux下的C++开发、调试环境，下面就一步步打造linux的的开发环境吧

# vscode环境配置 #

*  安装插件 `Remote - SSH`，`Remote - WSL`，`Remote Development`, `C/C++`，全部选微软官方的版本  
    ![在这里插入图片描述][20210529115842803.png]  
    ![在这里插入图片描述][20210529115903855.png]  
    ![在这里插入图片描述][20210529115914580.png]
 *  添加要连接的远程机器，wsl和ssh的操作方式是一样的，只是ssh需要配置一下ssh登录，这个随便一搜就有了
 *  ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pfZG1zZA_size_16_color_FFFFFF_t_70]  
    这里我是连的本地的wsl版本的linux
 *  配置调试  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pfZG1zZA_size_16_color_FFFFFF_t_70 1]  
    从 Remote Explorer定位到你需要调试的工程的入口  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pfZG1zZA_size_16_color_FFFFFF_t_70 2]
 *  在远程机器上安装vscode插件(此时我们的环境已经在远程机器上了)
 *  ![在这里插入图片描述][20210529120636118.png]  
    把第一步的那些插件在远程机器上再装一遍，会有如上提示，告诉你这是装在wsl上的

# 远程linux机器配置 #

*  安装g++, make等一堆编译、调试工具，以Ubuntu为例

> sudo apt install g++ make gdb

# vscode调试配置 #

*  打开需要调试的工程的任意源文件后，(这里不打开一个文件的话，会报错），按下F5，选`gdb/lldb`那一栏  
    ![在这里插入图片描述][20210529120932510.png]  
    选择你的编译器，这里就按需选择了，我这里选的是g+±9  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pfZG1zZA_size_16_color_FFFFFF_t_70 3]  
    然后再你的在你的`.vscode目录`下会出现两个文件，顾名思义，launch.json是启动调试的入口文件，task是其他子任务![在这里插入图片描述][20210529121225605.png]

## launch.json配置 ##

默认的长这样：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pfZG1zZA_size_16_color_FFFFFF_t_70 4]

*  program：调试的时候启动的程序路径，也就是你需要调试的程序路径，一般设置成你编译输出的路径即可(要定位到文件，不能只是目录)，这里按需修改即可
 *  args：程序启动时的命令行参数，没有就留空
 *  cwd：程序运行的工作目录，按需修改，默认就是你按F5时当前的目录
 *  preLaunchTask：启动调试前的任务名称，一般就是编译了(如果是调试现有程序，就不需要这一步，可以直接删掉)，这个后面将attach调试的时候再提
 *  miDebuggerPath：就是调试器的路径了，也就是刚才安装的gdb的路径，一般就是默认的路径

## tasks.json ##

这个文件定义了一些任务，可以再launch.json中调用  
默认长这样：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pfZG1zZA_size_16_color_FFFFFF_t_70 5]

*  lable就是任务名称了
 *  command：任务启动的命令，我们这里需要进行编译，所以命令就是g++的路径了，如果之前你选了其他编译器，自然就是其他编译器的路径
 *  args：命令的参数，这里就是g++的参数，`需要注意的是，不能在一个字符串中写多个命令选项，会报错，需要拆开`，比如：  
    ![在这里插入图片描述][20210529122525213.png]  
    因为这样的命令参数传递给g++后就变成了：

> `g++ "-Werror=format -std=c++17 -L. -lNanoLog -pthread -lrt"`

正常g++的参数是不需要 引号的  
正确的姿势：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pfZG1zZA_size_16_color_FFFFFF_t_70 6]

# 愉快的调试吧 #

完整launch.jons:

{
        
        // Use IntelliSense to learn about possible attributes.
        // Hover to view descriptions of existing attributes.
        // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
        "version": "0.2.0",
        "configurations": [
            {
        
                "name": "g++-9 - Build and debug active file",
                "type": "cppdbg",
                "request": "launch",
                "program": "${fileDirname}/sampleApplication",
                "args": [],
                "stopAtEntry": false,
                "cwd": "${fileDirname}",
                "environment": [],
                "externalConsole": false,
                "MIMode": "gdb",
                "setupCommands": [
                    {
        
                        "description": "Enable pretty-printing for gdb",
                        "text": "-enable-pretty-printing",
                        "ignoreFailures": true
                    }
                ],
                "preLaunchTask": "C/C++: g++-9 build active file",
                "miDebuggerPath": "/usr/bin/gdb"
            }
        ]
    }

完整task.json

{
        
        "tasks": [
            {
        
                "type": "cppbuild",
                "label": "C/C++: g++-9 build active file",
                "command": "/usr/bin/g++-9",
                "args": [
                    "-g",
                    "${file}",
                    "-o",
                    "${fileDirname}/sampleApplication",
                    "-I", "../runtime",
                    "-Werror=format", "-std=c++17",
                    "-L.", "-lNanoLog", "-pthread", "-lrt"
    
                ],
                "options": {
        
                    "cwd": "${fileDirname}"
                },
                "problemMatcher": [
                    "$gcc"
                ],
                "group": {
        
                    "kind": "build",
                    "isDefault": true
                },
                "detail": "Task generated by Debugger."
            }
        ],
        "version": "2.0.0"
    }

打好断点，按下F5，就能像visualstudo中一样方便的调试了  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pfZG1zZA_size_16_color_FFFFFF_t_70 7]

# 使用make + makefile进行编译构建 #

上面我们使用的是g++进行编译的，但是很多开源项目都是用的make进行构建的，那我们来调整一下task.json，然他支持make;

其实经过上面的配置，我们能理解到，task.json其实就是配置一下构建的命令而已，所以我们把`command修改为make`，`args修改为make对于的命令参数`即可，

> 使用make要注意makefile的位置和工作路径的位置关系，不然容易出现找不到makefile的问题

{
        "tasks": [
            {
                "type": "cppbuild",
                "label": "C/C++: g++-9 build active file",
                "command": "make",
                "args": [
                ],
                "options": {
                    "cwd": "${fileDirname}"
                },
                "problemMatcher": [
                    "$gcc"
                ],
                "group": {
                    "kind": "build",
                    "isDefault": true
                },
                "detail": "Task generated by Debugger."
            }
        ],
        "version": "2.0.0"
    }

launch.json、task.json中的一些预定义变量查询：  
[https://code.visualstudio.com/docs/editor/variables-reference][https_code.visualstudio.com_docs_editor_variables-reference]

[20210529115842803.png]: /images/20221014/77029cad7fa84533b6170bf39c0fd353.png
[20210529115903855.png]: /images/20221014/84e21183a2874a36801cecd511d95ce3.png
[20210529115914580.png]: /images/20221014/01ffb2a8c7084b7f836a3396431c73ab.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pfZG1zZA_size_16_color_FFFFFF_t_70]: /images/20221014/7cdc6e553a5d41ac835863eacbd69b91.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pfZG1zZA_size_16_color_FFFFFF_t_70 1]: /images/20221014/09281da8337847a1aed401b18ed5c53c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pfZG1zZA_size_16_color_FFFFFF_t_70 2]: /images/20221014/86fd7dbd4cc545698bd041a6f64aa03a.png
[20210529120636118.png]: /images/20221014/d1f24137aa884b219b2ad9fbb8bc7d8c.png
[20210529120932510.png]: /images/20221014/ceb92363575f47039c63addabfb2bb53.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pfZG1zZA_size_16_color_FFFFFF_t_70 3]: /images/20221014/9c622d34f14e46f98e6afd5b1238f75c.png
[20210529121225605.png]: /images/20221014/5170dabc4c5541eabaa01efe9c902943.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pfZG1zZA_size_16_color_FFFFFF_t_70 4]: /images/20221014/67f0617b49ba469a9673f9a0d92aa161.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pfZG1zZA_size_16_color_FFFFFF_t_70 5]: /images/20221014/525136df1d5d4d9dafa4606d1f98f0b6.png
[20210529122525213.png]: /images/20221014/e0cb0e2de698415fb995f5c709e5a961.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pfZG1zZA_size_16_color_FFFFFF_t_70 6]: /images/20221014/2cb64faf3271474ba73407e973c23d49.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pfZG1zZA_size_16_color_FFFFFF_t_70 7]: /images/20221014/fb6505a963e34f928b181757f095e0b8.png
[https_code.visualstudio.com_docs_editor_variables-reference]: https://code.visualstudio.com/docs/editor/variables-reference