如何使用 vs 2022 远程调试 Linux系统中的Docker容器项目

一、前言

在项目上，总会遇到一些奇怪的问题，例如：“在本地好好的， 为什么部署到线上就不行” 等等，这样的问题时长困扰着我们。但是作为一个资深的码农，“远程调试” 是一个不可或缺的手段。下面就来看下如果使用 vs 在本地远程调试部署在Linux系统中，运行在Docker容器中的项目吧。

二、远程调试

调试的前提，我们项目的发布方式必须是 Debug,否则是无法进行调试的。具体原因请看 .net 项目发布中的 Debug和Release的区别是什么？

第一步：点击菜单栏中的调试->附加到进程

第二步：连接类型

第三步：连接目标

第四步：连接容器

第五步：附加到进程

三、异常信息

按照正常步骤操作，长时间卡在 ’正在启动调试适配器’,之后可能会出现 “未能启动调试适配器。可以在输出窗口中查看额外的信息。无法创建 shell，出现连接错误。Client not connected.” 字样的报错。

以下内容是控制台输出的信息：

未能启动调试适配器“coreclr”。
无法连接到远程系统或连接丢失。

Client not connected.


初始化日志:
Determining user folder on remote system...
Checking for existing installation of debugging tools...
Downloading debugger launcher...
Creating debugger installation folder: /root/.vs-debugger
Copying debugger launcher to /root/.vs-debugger/GetVsDbg.sh
Ensuring script exists after copying...
Downloading debugger components...
Output: Info: Previous installation at '/root/.vs-debugger/vs2022' not found
Info: Using vsdbg version '17.7.10808.2'
Info: Creating install directory
Using arguments
    Version                    : 'vs2022'
    Location                   : '/root/.vs-debugger/vs2022'
    SkipDownloads              : 'false'
    LaunchVsDbgAfter           : 'false'
    RemoveExistingOnUpgrade    : 'true'
    OfflineMode                : 'true'
Info: Using Runtime ID 'linux-x64'
ERROR: Unable to find 'wget' or 'curl'. Install 'curl' or 'wget'. It is needed to download the vsdbg package.

Downloading debugger binaries from 'https://vsdebugger.azureedge.net/vsdbg-17-7-10808-2/vsdbg-linux-x64.tar.gz'
Copying debugger binaries to '/root/.vs-debugger/vsdbg-linux-x64.tar.gz'
Failed: 无法连接到远程系统或连接丢失。
Launching remote debugger...
Failed: 无法连接到远程系统或连接丢失。
程序“[1] dotnet”已退出，返回值为 4294967295 (0xffffffff)。

从控制台输出的日志不难看出失败的原因是因为需要下载一些调试需要的文件，但是下载文件的地址很多都是外网的，我们国内根本无法访问。

四、解决方式

既然知道了失败的原因，那就好办了。

第一步：下载GetVsDbg.sh

我们先在本地的浏览器中将GetVsDbg.sh文件下载好。GetVsDbg.sh 下载地址：https://aka.ms/getvsdbgsh

第二步：修改 vsdbg-linux-x64 下载地址

将 GetVsDbg.sh 文件的 download() 方法下的 url 的下载地址改为一个可以下载vsdbg-linux-x64.tar.gz文件的地址（可以自己在本地搭建一个网站，提供文件下载）我在这里提供一个下载地址： https://converts-article-1253184962.cos.ap-chengdu.myqcloud.com/vsdbg-linux-x64.tar.gz （这个地址是本站的静态文件，方便各位方便调用），具体修改如下：

download()
{
    if [ "$__UseZip" = false ]; then
        vsdbgFileExtension=".tar.gz"
    else
        echo "Warning: Version '${__VsDbgMetaVersion}' is only avaliable in zip."
        vsdbgFileExtension=".zip"
    fi
    vsdbgCompressedFile="vsdbg-${__RuntimeID}${vsdbgFileExtension}"
    target="$(echo "${__VsDbgVersion}" | tr '.' '-')"

    # 注释原有的下载地址
    #url="https://vsdebugger.azureedge.net/vsdbg-${target}/${vsdbgCompressedFile}"

    # 替换成新的地址
    url="https://converts-article-1253184962.cos.ap-chengdu.myqcloud.com/vsdbg-linux-x64.tar.gz"

    check_internet_connection "$url"

    echo "Downloading ${url}"
    if hash wget 2>/dev/null; then
        wget -q "$url" -O "$vsdbgCompressedFile"
    elif hash curl 2>/dev/null; then
        curl -s "$url" -o "$vsdbgCompressedFile"
    fi

    if [ $? -ne  0 ]; then
        echo
        echo "ERROR: Could not download ${url}"
        exit 1;
    fi

    __VsdbgCompressedFile=$vsdbgCompressedFile
}

第三步：创建 .vs-debugger 文件夹

# 创建文件
mkdir /root/.vs-debugger

# 将 GetVsDbg.sh 文件复制进去
mv GetVsDbg.sh /root/.vs-debugger

第四步： 执行 GetVsDbg.sh

/bin/sh "/root/.vs-debugger/GetVsDbg.sh" -v vs2022 -l "/root/.vs-debugger/vs2022" -a "/remote_debugger"

如上图所示， 我们远程调试需要的依赖包就安装完成了。就是如此简单。下面我们就可以再试试是否可以调试了。