Jenkins 流水线远程部署 .NET Core/Framework 到 IIS

Windows
.NET Core
- 处理 IIS
- 处理项目 Jenkinsfile
.NET Framework
- 安装环境
- 配置项目
前后端分类方案

在本章中，将会介绍在 Windows Jenkins 上，编译 .NET Core、.NET Framework 项目，以及远程部署到 IIS 中。

Windows

我们先在 Windows 上安装好相应的环境。

Jenkins 依赖于 JDK 11，请自行查找方法安装。

在 https://www.jenkins.io/download/ 中可以下载到 Windows Jenkins 版本的安装包，下载完毕后，直接安装即可，安装完成后会自动启动。

Jenkins 的安装目录默认为：C:\Windows\System32\config\systemprofile\AppData\Local\Jenkins.jenkins，密码/密钥一般在其目录下的 secret-file 文件。

安装 Jenkins 后，打开 8080 端口访问 Jenkins，然后根据 https://www.cnblogs.com/whuanle/p/14928651.html#安装插件一节，把插件安装好，再额外安装一个 powershell 插件。

安装 Git

接着，在 Windows 服务器中，将 Git 安装好，一般 Git 的安装目录为 C:\Program Files\Git。

然后添加下面两个 Git 相关的目录到系统环境变量中。

C:\Program Files\Git\cmd

C:\Program Files\Git\usr\bin

如不配置 C:\Program Files\Git\usr\bin 到环境变量，会出现 nohup 错误，Jenkins 依赖 nohup 命令。

WebDeploy

WebDeploy 是一个 IIS 远程部署工具，通过 WebDeploy 我们可以很方便地打包应用远程部署到 IIS 中，而不需要手动重启、更替网站文件、重启程序池等。WebDeploy 下载地址：https://www.microsoft.com/zh-cn/download/details.aspx?id=43717

安装完成后，其程序默认安装目录为：

C:\Program Files\IIS\Microsoft Web Deploy V3

请添加此目录到系统环境变量中。

同时，在要被远程部署的服务器中，也安装 WebDeploy。

Windows 从节点

如果你有一台 Jenkins Master 服务器，然后再添加 Windows Jenkins Node，做主从 Jenkins，那么可以按照下面的方法将 Windows 加入到 Linux 节点中。

如果你只部署 Windows ，那么 Windows 上的的 Jenkins 就是 Master，可以跳过此步。

打开 Master Jenkins 的 Web 界面，在左侧菜单导航中打开 Manage Jenkins，然后在 System Configuration 中，选择 Manage Nodes and Clouds。

然后添加新的节点 “New Node”。

节点名称可随意，在接下来要求填写的 Label 中，需要填写 “windows” ，当然填写其它标识也行，但是一般 Label 用来标识系统特性的，另外也会要求填写构建目录，这是用于存放 Jenkins 工作时的文件，例如拉取代码、执行命令等，都会在这个目录下操作。

点击蓝色字体的 agent.jar，可以下载 java 包。

将 agent.jar 包放到 Jenkins 所在的 Windows 中，然后按照提示的命令，启动 agent.jar。

就是把 agent.jar 放到目录中，然后打开 powershell 或者 cmd，复制上面的 Java -jar agent.jar -jnlpUrl ..... 命令，直接执行就行。

接着，在 Jenkins 界面，可以看到另一台 Windows 从节点已经加了上去。

.NET Core

这一小节，介绍如何构建、远程部署 .NET Core 应用到 IIS 中。

对于 .NET Core 应用，其过程比较简单，只需要安装 .NET Core SDK 即可，无需再额外操作。

.NET Core 各类版本下载地址：

https://dotnet.microsoft.com/download/dotnet

.NET Core 3.1 版本下载地址：

https://download.visualstudio.microsoft.com/download/pr/56131147-65ea-47d6-a945-b0296c86e510/44b43b7cb27d55081e650b9a4188a419/dotnet-sdk-3.1.201-win-x64.exe

处理 IIS

在你要部署应用的那台 Windows 服务器上，打开 IIS ，点击 ”应用程序池“，然后添加一个新的。

接着，添加一个网站。

然后开始添加一个新用户，点击主机名称，然后点击 “IIS 管理器用户”，然后添加一个用户。

然后为网站启用 WebDeploy 部署。

处理项目 Jenkinsfile

笔者已经上传了 Demo 项目已经 Jenkinsfile 文件，读者直接 fork 项目即可，示例项目在 coreiis 分支中。

https://github.com/whuanle/DotNetCoreJenkinsDemo/tree/coreiis

然后，下载源码，修改一下 Jenkinsfile 文件。

        // IIS 配置，远程发布的变量

        IISTMP     =   'C:/webdemo_tmp'                            // 用于打包发布的临时目录

        IISAPP     =   'jenkinsdemo.com'                           // 网站名称

        IISADDR    =   'https://192.168.0.66:8172/msdeploy.axd'    // WebDeploy 的地址

        IISUSER    =   'jenkinesdemo'                         // 用于登录到 IIS 的账号密码

        IISADMIN   =   'jenkinesdemo'

按照笔者的 demo，读者只需要修改一下 IISADDR 中的 IP 和用户名或密码即可。

接着，使用 Jenkins ，添加流水线部署即可。这里不再赘述 Jenkins 上的新建流程，读者可以参考笔者的另一篇文章：

https://www.cnblogs.com/whuanle/p/14928651.html#构建流水线

.NET Framework

为了能够编译 .NET Framework 应用，我们需要搭建起 .NET Framework 应用的编译环境，由于 .NET Framework 严重依赖 Vistual Studio，如果脱离 VS 环境，则需要安装很多环境工具，才能使用命令编译程序，比较麻烦，读者需要耐心处理。

示例项目笔者已经上传到 https://github.com/whuanle/DotNetCoreJenkinsDemo/tree/fxiis 中。

安装环境

.NET Framework SDK

.NET Framework 包提供编译、运行 .NET 程序的环境。

安装 .NET Framework 框架，其版本不定，按照要编译的项目其需要的版本为准，可安装多个版本。

例如 .NET Framework 4.6.1 和 .NET Framework 4.6.1 Developer Pack 。

下载地址：https://dotnet.microsoft.com/download/dotnet-framework

MSBuild

MSBuild 是一个 .NET 程序的编译工具，可以在脱离 VS 环境时使用。

如果要编译 .NET Framewrok 项目，例如 4.6，请使用 MSBuild 14(对应 VS 2015)，一般文件名称为 BuildTools_Full_14.exe。

下载地址：

https://www.microsoft.com/en-US/download/details.aspx?id=48159

https://github.com/EWSoftware/SHFB/releases

安装 MSBuild 后其目录位置为：

C:\Program Files (x86)\MSBuild\14.0\Bin

请将其目录路径添加系统环境变量中。

Nuget

nuget 用于还原项目的依赖，对于 .NET Framework 项目，nuget 的版本不能为 5.0 以上，建议使用 4.5 版本左右，否则会有兼容问题！

安装完毕后，nuget 程序目录为：

C:\Program Files\nuget

请添加目录到系统环境变量中。

安装各种需要的工具后，环境变量一共需要添加以下项：

C:\Program Files (x86)\MSBuild\14.0\Bin

C:\Program Files\Git\cmd

C:\Program Files\nuget

C:\Program Files\Git\usr\bin

C:\Program Files\IIS\Microsoft Web Deploy V3

请仔细检查是否有遗留项。

配置项目

要脱离 VS 环境，自动化构建 .NET Framework 应用，需要处理的配置文件和环境很多，我们需要修改一下项目。在本节中，将介绍如何配置 .NET Framework 自动化流水线的构建，使用 Jenkins 配置流水线，编写 Jenkins 脚本等。

一般一个解决方案中，有一个是需要发布的主程序(主要为 Web 应用)，请为需要发布的 Web 项目，添加 Nuget 引用，搜索 MSBuild.Microsoft.VisualStudio.Web.targets 包，添加引用到项目中。

因为 .NET Framework 项目需要依赖 Vistual Studio 发布，如果不使用 VS 发布，会出现很多问题，为了脱离 VS 环境，有人封装了一个完整的 targets 文件，指示 MSBuild 如何编译此此程序。

对于需要发布的 Web 项目需要定义 Web 发布属性，自动化构建中，依赖这些提前配置的属性，这些属性会生成一个 .pubxml 文件，随源代码一起上传到仓库。

然后点击发布，手动发布一次到一个目录。

保存设置后，在项目的 Properties\PublishProfiles 目录，可以找到 FolderProfile.pubxml 文件，其中有一行 PublishUrl 属性，为网站发布时的输出目录。

<PublishUrl>C:\test</PublishUrl>

此目录配置会影响到自动化构建时的输出，编译时，生成的文件会输出到这个目录中，请确保在 Windows Jenkins 中，存储此盘符！

然后直接在 Jenkins Web 上，操作即可。

前后端分类方案

当我们为 .NET Core / .NET Framework 项目创建网站完毕，此时程序跟前端是一起的，打包发布不方便。

我们可以为前端项目新建一个无用的网站。

我可以编写流水线脚本，将前端文件通过 WebDeploy 自动打包发布到此网站中。

接着，在后端网站中，添加一个虚拟目录，目录跟前端网站的目录一致。

这样，前后端都可以分开部署，而在后端网站后，可以直接读取前端文件。