Docker容器环境下ASP.NET Core Web API

深碍√TFBOYSˉ_ 2022-07-14 06:23 170阅读 0赞

# [Docker容器环境下ASP.NET Core Web API应用程序的调试][Docker_ASP.NET Core Web API] #

本文主要介绍通过[Visual Studio 2015 Tools for Docker – Preview][Visual Studio 2015 Tools for Docker _ Preview]插件，在Docker容器环境下，对ASP.NET Core Web API应用程序进行调试。在自己做实验的过程中也碰到了一些问题，经过一些测试和搜索资料，基本解决了这些问题，本文也会对这些问题进行介绍，以免有相同需求的朋友多走弯路。

# 插件的下载与安装 #

至撰写本文为止，Visual Studio 2015 Tools for Docker插件还是处于Preview的版本（版本号：0.31.0），可以[点击此处][Link 1]下载。要正确安装此插件并能够成功地在Visual Studio 2015中使用该插件进行调试，需要满足以下先决条件：

*  Microsoft Visual Studio 2015 Update 3
    
     *  Enterprise
     *  Professional
     *  Community
 *  [Microsoft .NET Core 1.0 SDK for Windows][]以及[VS 2015 Tooling Preview 2][]
 *  Windows系统已经安装Docker for Windows或者Docker Toolbox

本文将以VS 2015 Enterprise + Windows 10 + Docker for Windows作为开发环境进行介绍。

下载插件后，即可按照正常的软件安装过程进行安装。安装过程请退出Visual Studio 2015。安装成功后，可以在Visual Studio的“扩展与更新”中找到Visual Studio 2015 Tools for Docker – Preview：

[![image][]][image 1]

# 在ASP.NET Core Web API项目上启用Docker的支持 #

打开我们的DockerWebAPI项目，在项目上单击鼠标右键，然后选择“添加 –>  Docker Support” 菜单：

[![image][image 2]][image_image 2]

经过一段时间，VS Tools for Docker就会在项目上添加一些文件：

[![image][image 3]][image_image 3]

我们暂时先不详细介绍这些文件的具体内容和作用。基本上在Properties目录下是给Visual Studio 2015和编译环境所使用的；而docker-compose以及Dockerfile都是给Docker所使用的，需要了解详细信息的朋友，可以先上网搜索了解一下。

# 开始调试ASP.NET Core Web API应用程序 #

在开始调试以前，请首先打开Docker for Windows的设置，在Shared Drivers里，把项目所在的驱动器勾选上。如果这步没有做，那么就无法成功启动调试器。

[![image][image 4]][image_image 4]

接下来，直接按下F5快捷键，就可以开始调试了。当然，也可以按下工具栏上的“启动”按钮来启动调试，可以看到，我们的调试按钮已经默认设置为Docker了：

[![image][image 5]][image_image 5]

Visual Studio 2015启动Debugger的过程大致如下：

*  调用PowerShell脚本DockerTask.ps1，对环境进行清理，比如停止正在运行的容器，以及将已有的Docker Image删除
 *  Visual Studio对项目进行编译
 *  调用PowerShell脚本DockerTask.ps1，将项目发布到bin/Docker/Debug/app目录
 *  开始根据docker-compose.debug.yml的文件内容，生成Docker Image
 *  启动Visual Studio Debugger，通过不断地ping [http://localhost/api/values][http_localhost_api_values] 端点，确保Docker Container已经成功加载
 *  打开默认浏览器，开始调试，等待断点命中

需要注意的是，VS Tools for Docker默认使用80端口，如果系统中已经安装有使用80端口的服务，比如IIS，请要么停止占用80端口的服务，要么修改项目中的yml文件，选择使用其它的端口。否则编译过程将无法完成。另一个需要注意的地方是，由于在上一次的案例中，我们通过UseUrls API指定了我们的应用程序可以接受来自任何地址的5000端口的请求，因此，我们也需要相应地修改docker-compose.debug.yml文件，使其能够将主机的80端口映射到5000端口，如下：

[![image][image 6]][image_image 6]

成功启动调试器之后，即可设置断点，待断点命中时，可以像调试普通C\#应用程序那样，使用Visual Studio提供的各种调试体验。从下图可以看出，我们的调试上下文已经是在Docker容器中了（Environment.MachineName返回了Docker Container的ID）：

[![image][image 7]][image_image 7]

# 有关自动生成的Docker Image #

在Visual Studio Tools for Docker完成项目的编译之后，会生成一个名称为“username/xxxx: Debug”的Docker Image（xxxx为项目名称）：

[![image][image 8]][image_image 8]

既然是一个Docker Image，那么我们应该可以使用docker run命令，在容器中执行这个Docker Image。现在我们来尝试一下：

[![image][image 9]][image_image 9]

发现并没有执行成功，提示了一个bash的错误：integer expression expected。此时也无法从浏览器访问这个应用程序。经过一段时间的研究，发现在Dockerfile.debug文件的最后一条ENTRYPOINT指令处，将：

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>ENTRYPOINT [</code> 
      <code>"/bin/bash"</code> 
      <code>, </code> 
      <code>"-c"</code> 
      <code>, </code> 
      <code>"if [ \"$REMOTE_DEBUGGING\" -eq 0 ]; then dotnet DockerWebAPI.dll; else sleep infinity; fi"</code> 
      <code>]</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

改为：

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div></td> 
   <td> 
    <div> 
     <div> 
      <code>ENTRYPOINT [</code> 
      <code>"/bin/bash"</code> 
      <code>, </code> 
      <code>"-c"</code> 
      <code>, </code> 
      <code>"if [[ \"$REMOTE_DEBUGGING\" -eq 0 ]]; then dotnet DockerWebAPI.dll; else sleep infinity; fi"</code> 
      <code>]</code> 
     </div> 
    </div></td> 
  </tr> 
 </tbody> 
</table>

（if后面的子句使用两个双括号）。

此时再次编译运行，调试过程也不会有什么问题，再次通过命令行执行新生成的Docker Image，可以看到，这个错误已经修复：

[![image][image 10]][image_image 10]

其实这只是我在使用VS Tools for Docker的一个小发现，并没有太大的实际意义：

*  在Debug模式，如果不修复这个问题，Debugger照样可以启动
 *  在Release模式，Dockerfile根本就没有这条指令（因为Release模式下只需要正常启动应用程序就可以了）

反正在此也把这个心得分享出来，或许也能帮到有着同样疑惑的朋友。

# 总结 #

本文对Visual Studio Tools for Docker进行了简单的介绍。在后续的文章中，我还会继续介绍一些Docker的使用心得，并同时介绍一些ASP.NET Core Web API的开发经验。

[Docker_ASP.NET Core Web API]: http://www.cnblogs.com/daxnet/p/5793479.html
[Visual Studio 2015 Tools for Docker _ Preview]: https://visualstudiogallery.msdn.microsoft.com/0f5b2caa-ea00-41c8-b8a2-058c7da0b3e4
[Link 1]: https://visualstudiogallery.msdn.microsoft.com/0f5b2caa-ea00-41c8-b8a2-058c7da0b3e4/file/176008/21/DockerVSTools.VS140.exe
[Microsoft .NET Core 1.0 SDK for Windows]: https://go.microsoft.com/fwlink/?LinkID=809122
[VS 2015 Tooling Preview 2]: https://go.microsoft.com/fwlink/?LinkID=824849
[image]: /images/20220714/a822d3ba12d54627b5ed10a6b1a62192.png
[image 1]: http://images2015.cnblogs.com/blog/119825/201608/119825-20160821201039167-2110354793.png
[image 2]: http://images2015.cnblogs.com/blog/119825/201608/119825-20160821201041636-471342234.png
[image_image 2]: /images/20220714/314c3535c7a845e8b0581b14d1353b75.png
[image 3]: http://images2015.cnblogs.com/blog/119825/201608/119825-20160821201043667-98654226.png
[image_image 3]: /images/20220714/9e86e09d1d874c71aa36d33eeb4040d3.png
[image 4]: http://images2015.cnblogs.com/blog/119825/201608/119825-20160821201044542-648089925.png
[image_image 4]: /images/20220714/67f822a0ae1b41a0b763a92f3d9276cc.png
[image 5]: http://images2015.cnblogs.com/blog/119825/201608/119825-20160821201045183-1634839727.png
[image_image 5]: /images/20220714/b7a6722a4dac4bd583759dadea02986f.png
[http_localhost_api_values]: http://localhost/api/values
[image 6]: http://images2015.cnblogs.com/blog/119825/201608/119825-20160821201046011-70904686.png
[image_image 6]: /images/20220714/76772fe47ce34eac85b2b038be9ee679.png
[image 7]: http://images2015.cnblogs.com/blog/119825/201608/119825-20160821201046855-288249171.png
[image_image 7]: /images/20220714/706f459f40ea43b881acefd28afce35a.png
[image 8]: http://images2015.cnblogs.com/blog/119825/201608/119825-20160821201047995-2091704861.png
[image_image 8]: /images/20220714/d95185a3227f4ef8801291fc9ec3e463.png
[image 9]: http://images2015.cnblogs.com/blog/119825/201608/119825-20160821201049214-1426691024.png
[image_image 9]: /images/20220714/0ea6078e79264312b3ac09d6e50164e4.png
[image 10]: http://images2015.cnblogs.com/blog/119825/201608/119825-20160821201050198-1654337459.png
[image_image 10]: /images/20220714/93bcba500901466585472245e7e24acf.png