自托管 .NET 核心控制台应用程序中的 Startup.cs

Question

我有一个自托管的.NET 核心控制台应用程序。

web 显示了ASP.NET Core的示例，但我没有 web 服务器。 只是一个简单的命令行应用程序。

是否可以为控制台应用程序做这样的事情？

public static void Main(string[] args)
{
    // I don't want a WebHostBuilder. Just a command line

    var host = new WebHostBuilder()
        .UseKestrel()
        .UseContentRoot(Directory.GetCurrentDirectory())
        .UseIISIntegration()
        .UseStartup<Startup>()
        .Build();

    host.Run();
}

我想在 ASP.NET Core 中使用 Startup.cs，但在控制台上。

我该怎么办？

Answer 1

所以我遇到了这个解决方案，灵感来自公认的答案：

程序.cs

public class Program
{
    public static void Main(string[] args)
    {
        IServiceCollection services = new ServiceCollection();
        // Startup.cs finally :)
        Startup startup = new Startup();
        startup.ConfigureServices(services);
        IServiceProvider serviceProvider = services.BuildServiceProvider();

        //configure console logging
        serviceProvider
            .GetService<ILoggerFactory>()
            .AddConsole(LogLevel.Debug);

        var logger = serviceProvider.GetService<ILoggerFactory>()
            .CreateLogger<Program>();

        logger.LogDebug("Logger is working!");

        // Get Service and call method
        var service = serviceProvider.GetService<IMyService>();
        service.MyServiceMethod();
    }
}

启动文件

public class Startup
{
    IConfigurationRoot Configuration { get; }

    public Startup()
    {
        var builder = new ConfigurationBuilder()
            .AddJsonFile("appsettings.json");

        Configuration = builder.Build();
    }

    public void ConfigureServices(IServiceCollection services)
    {
        services.AddLogging();
        services.AddSingleton<IConfigurationRoot>(Configuration);
        services.AddSingleton<IMyService, MyService>();
    }
}

appsettings.json

{
    "SomeConfigItem": {
        "Token": "8201342s223u2uj328",
        "BaseUrl": "http://localhost:5000"
    }
}

我的服务.cs

public class MyService : IMyService
{
    private readonly string _baseUrl;
    private readonly string _token;
    private readonly ILogger<MyService> _logger;

    public MyService(ILoggerFactory loggerFactory, IConfigurationRoot config)
    {
        var baseUrl = config["SomeConfigItem:BaseUrl"];
        var token = config["SomeConfigItem:Token"];

        _baseUrl = baseUrl;
        _token = token;
        _logger = loggerFactory.CreateLogger<MyService>();
    }

    public async Task MyServiceMethod()
    {
        _logger.LogDebug(_baseUrl);
        _logger.LogDebug(_token);
    }
}

IMyService.cs

public interface IMyService
{
    Task MyServiceMethod();
}

Answer 2

此答案基于以下标准：

我想在一个简单的控制台应用程序中使用没有任何 ASP.NET web 内容的新通用主机CreateDefaultBuilder ，但也能够在startup.cs中AppConfiguration启动逻辑以配置AppConfiguration和服务

所以我花了一个上午的时间来研究如何做这样的事情。 这是我想出来的……

此方法需要的唯一 nuget 包是Microsoft.Extensions.Hosting （在撰写本文时，它的版本为3.1.7 ）。 这是nuget 包的链接。 这个包也需要使用CreateDefaultBuilder() ，所以你很可能已经添加了它。

将扩展（答案底部的扩展代码）添加到项目后，将程序条目设置为类似于以下内容：

using Microsoft.Extensions.Hosting;

class Program
{
    static async Task Main(string[] args)
    {
        var host = CreateHostBuilder(args).Build();
        await host.RunAsync();
    }

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .UseStartup<Startup>(); // our new method!
}

您添加一个Startup.cs ，它应该如下所示：

public class Startup
{
    public IConfiguration Configuration { get; }

    public Startup(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public void ConfigureServices(IServiceCollection services)
    {
        // Configure your services here
    }
}

然后，您可以像在典型的 ASP.NET Core 应用程序中一样配置您的服务（无需安装 ASP.NET Core Web Hosting）。

演示项目

我整理了一个 .NET Core 3.1 控制台演示项目，用于执行各种操作，例如IHostedService实现、 BackgroundService实现、瞬态/单例服务。 我还注入了IHttpClientFactory和IMemoryCache以进行很好的衡量。

克隆该 repo 并试一试。

这个怎么运作

我创建了一个IHostBuilder扩展方法，它只是实现了我们都习惯的IHostBuilder UseStartup<TStartup>(this IHostBuilder hostBuilder)模式。

由于CreateDefaultBuilder() 添加了所有基础知识，因此没有太多可添加的内容。 我们唯一关心的是通过ConfigureServices(IServiceCollection)获取IConfiguration并创建我们的服务管道。

扩展方法源代码

/// <summary>
/// Extensions to emulate a typical "Startup.cs" pattern for <see cref="IHostBuilder"/>
/// </summary>
public static class HostBuilderExtensions
{
    private const string ConfigureServicesMethodName = "ConfigureServices";

    /// <summary>
    /// Specify the startup type to be used by the host.
    /// </summary>
    /// <typeparam name="TStartup">The type containing an optional constructor with
    /// an <see cref="IConfiguration"/> parameter. The implementation should contain a public
    /// method named ConfigureServices with <see cref="IServiceCollection"/> parameter.</typeparam>
    /// <param name="hostBuilder">The <see cref="IHostBuilder"/> to initialize with TStartup.</param>
    /// <returns>The same instance of the <see cref="IHostBuilder"/> for chaining.</returns>
    public static IHostBuilder UseStartup<TStartup>(
        this IHostBuilder hostBuilder) where TStartup : class
    {
        // Invoke the ConfigureServices method on IHostBuilder...
        hostBuilder.ConfigureServices((ctx, serviceCollection) =>
        {
            // Find a method that has this signature: ConfigureServices(IServiceCollection)
            var cfgServicesMethod = typeof(TStartup).GetMethod(
                ConfigureServicesMethodName, new Type[] { typeof(IServiceCollection) });

            // Check if TStartup has a ctor that takes a IConfiguration parameter
            var hasConfigCtor = typeof(TStartup).GetConstructor(
                new Type[] { typeof(IConfiguration) }) != null;

            // create a TStartup instance based on ctor
            var startUpObj = hasConfigCtor ?
                (TStartup)Activator.CreateInstance(typeof(TStartup), ctx.Configuration) :
                (TStartup)Activator.CreateInstance(typeof(TStartup), null);

            // finally, call the ConfigureServices implemented by the TStartup object
            cfgServicesMethod?.Invoke(startUpObj, new object[] { serviceCollection });
        });

        // chain the response
        return hostBuilder;
    }
}

Answer 3

所有.NET Core应用程序都由精心设计的独立库和包组成，您可以在任何类型的应用程序中自由引用和使用它们。 碰巧的是， Asp.net core应用程序预先配置为引用许多这些库并公开一个 http 端点。

但是，如果您的控制台应用程序需要依赖注入，只需引用相应的库即可。 这是一个指南： https : //andrewlock.net/using-dependency-injection-in-a-net-core-console-application/

Answer 4

另一种方法是使用Microsoft.Extensions.Hosting包中的HostBuilder 。

public static async Task Main(string[] args)
{
    var builder = new HostBuilder()
        .ConfigureAppConfiguration((hostingContext, config) =>
        {
            config.SetBasePath(Directory.GetCurrentDirectory());
            config.AddJsonFile("appsettings.json", true);
            if (args != null) config.AddCommandLine(args);
        })
        .ConfigureServices((hostingContext, services) =>
        {
            services.AddHostedService<MyHostedService>();
        })
        .ConfigureLogging((hostingContext, logging) =>
        {
            logging.AddConfiguration(hostingContext.Configuration);
            logging.AddConsole();
        });

    await builder.RunConsoleAsync();
}

Answer 5

我知道这个线程有点旧，但我还是决定分享我的代码，因为它也实现了 Daniel 想要的（控制台应用程序中的 DI），但没有 Startup 类。 Ps.：请注意，此解决方案适用于 .NET Core 或 .NET Framework。

程序.cs：

public class Program
    {

        public static void Main(string[] args)
        {
            var services = new ServiceCollection();

            DependencyInjectionConfiguration.ConfigureDI(services);

            var serviceProvider = services.BuildServiceProvider();

            var receiver = serviceProvider.GetService<MyServiceInterface>();

            receiver.YourServiceMethod();
        }
    }

public static class DependencyInjectionConfiguration
    {
        public static void ConfigureDI(IServiceCollection services)
        {
            services.AddScoped<MyServiceInterface, MyService>();
            services.AddHttpClient<MyClient>(); // for example
        }
    }

Answer 6

我遇到了同样的问题，我认为这是一个很好的解决方案：

class Program
{
    static async Task Main(string[] args)
    {
        var host = CreateHostBuilder(args).Build();
        await host.RunAsync();
    }

     public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureServices((hostBuilderContext, serviceCollection) => new Startup(hostBuilderContext.Configuration).ConfigureServices(serviceCollection))
}

Answer 7

是的。 ASP.NET Core 应用程序可以是自托管的（如您的示例中所示），也可以托管在 Web 服务器（如 IIS）中。 在 .NET Core 中，所有应用程序都是控制台应用程序。

Answer 8

您可以更轻松地解决它。 只需制作 2 个文件，然后编辑 Main 方法：

启动文件

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
(...)
 public class Startup
    {
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc();
        }

        public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
        {
            loggerFactory.AddConsole();
            loggerFactory.AddDebug();


            app.UseMvc(routes =>
            {
                routes.MapRoute(
                    name: "default",
                    template: "{controller}/{action}");
            });
        }
    }

YourService.cs

using Microsoft.AspNetCore.Mvc;
(...)
public class MyeasynetworkController : Controller
    {
        [HttpGet]
        public IActionResult Run()
        {

            return Ok("Im Working");
        }
    }

并编辑您的静态 void Main(string[] args)

            var host = new WebHostBuilder()
                .UseKestrel()
                .UseUrls("http://+:5000")
                .UseStartup<Startup>()
                .Build();

            host.Run();

然后打开http://localhost:5000/Myeasynetwork/Run ，你应该看到 http status 200 响应，纯文本我正在工作