c# - 将 ASP.NET Core 托管为 Windows 服务

Question

正如我在 RC2 中看到的那样，它支持在 Windows 服务中托管应用程序。我尝试在一个简单的 Web API 项目(使用 .NET Framework 4.6.1)上对其进行测试。

这是我的 Program.cs 代码:

using System;
using System.IO;
using System.Linq;
using System.ServiceProcess;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Hosting.WindowsServices;

namespace WebApplication4
{
  public class Program : ServiceBase
  {
    public static void Main(string[] args)
    {
      if (args.Contains("--windows-service"))
      {
        Run(new Program());
        return;
      }

      var program = new Program();
      program.OnStart(null);
      Console.ReadLine();
      program.OnStop();
    }

    protected override void OnStart(string[] args)
    {
      var host = new WebHostBuilder()
      .UseKestrel()
      .UseContentRoot(Directory.GetCurrentDirectory())      
      .UseStartup<Startup>()
      .Build();

      host.RunAsService();
    }

    protected override void OnStop() {}
  }
}

所有其他内容基本上来自 .NET Core 模板(尽管我将框架更改为 net461 并在 project.json 中添加了一些依赖项)。

使用 dotnet publish 发布它并使用 sc create 创建 Windows 服务后，我可以成功启动我的服务，但我无法访问我的任何 Controller (端口是不上市)。我想我做错了什么。

所以我想主要的问题是如何制作自托管的 web api 并将其作为 Windows 服务运行。 RC2 更新后，所有找到的解决方案均无效。

Answer 1

您在这里有几个选择 - 使用 Microsoft 的 WebHostService 类、继承 WebHostService 或编写您自己的类。后者的原因是使用微软的实现，我们不能编写一个带有类型参数继承WebHostService的通用扩展方法，因为这个类不包含无参数构造函数，也不能访问服务定位器。

使用 WebHostService

在此示例中，我将创建一个控制台应用程序，它使用 Microsoft.DotNet.Web.targets，输出一个 .exe 并作为 MVC 应用程序( View 、 Controller 等)运行。我假设创建控制台应用程序、更改 .xproj 中的目标并修改 project.json 以具有适当的发布选项并从标准 .NET Core Web 应用程序模板复制 View 、 Controller 和 webroot - 是微不足道的。

现在是重要的部分:

1. 获取this打包并确保您在 project.json 文件中的框架是 net451(或更新版本)

2. 确保入口点中的内容根目录已正确设置为应用程序 .exe 文件的发布目录，并且已调用 RunAsService() 扩展方法。例如:

   public static void Main(string[] args)
   {
       var exePath= System.Diagnostics.Process.GetCurrentProcess().MainModule.FileName;
       var directoryPath = Path.GetDirectoryName(exePath);
   
       var host = new WebHostBuilder()
           .UseKestrel()
           .UseContentRoot(directoryPath)
           .UseStartup<Startup>()
           .Build();
   
       if (Debugger.IsAttached || args.Contains("--debug"))
       {
           host.Run();
       }
       else
       {
           host.RunAsService();
       }
   }
   

现在可以使用以下命令轻松安装 .exe

    sc create MyService binPath = "Full\Path\To\The\Console\file.exe"

服务启动后，Web 应用程序就会托管并成功找到并呈现其 View 。

继承WebHostService

这种方法的一个主要好处是我们可以重写 OnStopping、OnStarting 和 OnStarted 方法。

假设下面是我们自定义的继承WebHostService的类

internal class CustomWebHostService : WebHostService
{
    public CustomWebHostService(IWebHost host) : base(host)
    {
    }

    protected override void OnStarting(string[] args)
    {
        // Log
        base.OnStarting(args);
    }

    protected override void OnStarted()
    {
        // More log
        base.OnStarted();
    }

    protected override void OnStopping()
    {
        // Even more log
        base.OnStopping();
    }
}

按照上面的步骤，我们必须写下我们自己的扩展方法，该方法使用我们的自定义类运行主机:

public static class CustomWebHostWindowsServiceExtensions
{
    public static void RunAsCustomService(this IWebHost host)
    {
        var webHostService = new CustomWebHostService(host);
        ServiceBase.Run(webHostService);
    }
}

与前面的入口点示例相比，唯一需要更改的是最后的 else 语句，它必须调用正确的扩展方法

host.RunAsCustomService();

最后，使用与上述相同的步骤安装服务。

sc create MyService binPath = "Full\Path\To\The\Console\file.exe"