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

时间:2016-12-31 09:50:29

标签: c# console-application .net-core

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

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

是否可以为控制台应用程序执行此类操作?

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,但是在控制台上。

怎么做?

8 个答案:

答案 0 :(得分:48)

所以我遇到了这个解决方案,受到了公认答案的启发:

Program.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();
    }
}

Startup.cs

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"
    }
}

MyService.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();
}

答案 1 :(得分:21)

此答案基于以下条件:

我想在一个简单的控制台应用程序中使用不带任何ASP.NET Web内容的新通用主机CreateDefaultBuilder,但还可以消除startup.cs中的启动逻辑为了配置AppConfiguration和服务

所以我花了整个上午弄清楚你怎么能做这样的事情。这就是我想出的...

此方法唯一需要的nuget包是Microsoft.Extensions.Hosting(在撰写本文时,它的版本是3.1.7)。这是nuget package的链接。还必须使用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控制台demo project doing all kinds of things组合在一起,例如IHostedService实现,BackgroundService实现,瞬态/单例服务。我也注入了IHttpClientFactoryIMemoryCache,以取得良好的效果。

克隆该仓库并试一试。

工作原理

我从IHostBuilder创建了一个扩展方法,该方法简单地实现了我们都习惯的IHostBuilder UseStartup<TStartup>(this IHostBuilder hostBuilder)模式。

CreateDefaultBuilder() adds in all the basics以来,没有太多可添加的内容了。我们唯一关心的是获取IConfiguration并通过ConfigureServices(IServiceCollection)创建我们的服务管道。

扩展方法源代码

/// <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;
    }
}

答案 2 :(得分:18)

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

但如果你的控制台应用需要依赖注入,只需引用相应的库即可。以下是指南:http://andrewlock.net/using-dependency-injection-in-a-net-core-console-application/

答案 3 :(得分:7)

我知道这个线程有点旧,但是我还是决定共享我的代码,因为它也完成了Daniel想要的最终结果(控制台应用程序中的DI),但是没有Startup类。附注:请注意,此解决方案对.NET Core或.NET Framework有效。

Program.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
        }
    }

答案 4 :(得分:1)

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

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();
}

答案 5 :(得分:1)

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

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))
}

答案 6 :(得分:0)

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

Startup.cs

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(字符串[]参数)

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

            host.Run();

然后打开http://localhost:5000/Myeasynetwork/Run,您应该看到http status 200响应,其中包含纯文本 Im Working

答案 7 :(得分:-3)

是的,确实如此。 ASP.NET核心应用程序既可以自我托管 - 如在您的示例中 - 也可以托管在Web服务器(如IIS)中。在.NET Core中,所有应用程序都是控制台应用程序。