×

ASP.NET Core 知多少(2):启动类

96
圣杰
2017.09.14 21:22* 字数 944

ASP.NET Core知多少系列:总体介绍及目录

1.引言

启动类默认命名为Startup,它是在程序入口函数中为了构造IWebHost时通过UseStartup<Startup>()指定的。主要是定义了两个方法ConfigureServiceConfigure方法。应用程序启动时根据UseStartup方法指定的Startup类或程序集,借助StartupLoader进行反射调用,以完成依赖服务注册和中间件注册,以构造完整的HTTP请求管道。

下面我们就结合MVC模板项目中的Startup类来探讨下其简单用法。

2. 约定方法

我们知道启动类中主要包含了ConfigureServiceConfigure两个方法。

2.1. ConfigureService

该方法一般用于配置服务将服务注册到依赖注入容器中,在Configure方法之前被调用。通过调用IServiceCollection的扩展方法进行服务注册。扩展方法的命名建议按照Add[MethodName]进行约定,比如Mvc相关服务的注册services.AddMvc()

除此之外,我们还可以在此方法中替换ASP.NET Core默认内置的依赖注入框架。比如我们使用Castle Windsor替换:

  1. 安装Castle.Windsor.MsDependencyInjection NuGet包;
  2. 修改方法返回值类型为IServiceProvider
  3. 替换依赖容器:
public IServiceProvider ConfigureServices(IServiceCollection services)
{
    services.AddMvc();

    //Add Castle Windsor DI
    var ioContainer = new WindsorContainer();

    return WindsorRegistrationHelper.CreateServiceProvider(ioContainer, services);
}

2.2. Configure

该方法用于定义应用程序如何响应每个HTTP请求,以及配置HTTP流水线中的中间件。

public void  Configure(IApplicationBuilder app)   
{  
    app.UseMvc();  //使用MVC框架去处理用户请求
    //添加一个终端中间件委托到应用程序请求管道
    app.Run( context => {  
        return  context.Response.WriteAsync("Hello ASP.NET Core!");  
    });  
} 

该方法接受IApplicationBuilder作为参数,同时可以接受一些可选参数,如IHostingEnvironmentILoggerFactory。而且,在ConfigureServices方法中注册的其他服务,也可以直接在该方法中通过参数直接注入使用,比如:

public void ConfigureServices(IServiceCollection services)
{
    services.AddScoped<ITestService, TestService>();
}

public void Configure(IApplicationBuilder app,ITestService testService)
{
    testService.Test();
}

因为该方法用于配置整个http请求管道,所以中间件的注册要注意顺序。同样,在配置中间件时,我们同样建议遵循Use[Middleware]的命名约定,比如启用Mvc中间件app.UseMvc

3. 可用服务

从上节我们就已经知道,ASP.NET Core在调用之前已经默认注入了以下几个可用服务:

  • IConfiguration:用于读取应用程序配置。
  • IServiceCollection:可以理解为ASP.NET Core内置的依赖注入容器。
  • IApplicationBuilder:用于构建应用程序的请求管道。
  • IHostingEnvironment :提供了当前应用程序的运行的宿主环境配置信息。

除此之外,我们还可以使用已经注入的IServiceProviderILoggerFactoryILoggerIApplicationLifetime等可用服务。这些预置服务可以注入到Startup类的构造函数或Configure方中。就像这样:

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

ConfigureServices只支持一个参数IServiceCollection,因为所有的依赖都可以通过IServiceCollection获取,所以没有必要通过方法再注入其他服务,可以直接通过以下方式解析依赖的服务:

public void ConfigureServices(IServiceCollection services)
{
    var serveiceProvider = services.BuildServiceProvider();
    var logger =serveiceProvider.GetService<ILogger>();
    //....
}

4. 定义多个启动类

我们看下Configure方法我们发现,通过IHostingEnvironment服务,我们可以获取当前应用程序的运行环境。代码中为开发环境启用了异常详情页面、数据库错误页面和Brower Link(支持启动多个web浏览器,并可同步刷新,一般用于跨浏览器测试),以方便我们开发调试。

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
        app.UseBrowserLink();
        app.UseDatabaseErrorPage();
    }
    else
    {
        app.UseExceptionHandler("/Home/Error");
    }
    //...
}

ASP.NET Core默认内置了三种环境变量:Development、 Staging、Production。我们可以为每一种环境定义一个启动类,命名为Startup[Environment]即可。在启动时通过指定启动类所在的程序集名称即可根据launchSettings中的配置的ASPNETCORE_ENVIRONMENT自动加载对应的启动类。

public static IWebHost BuildWebHost(string[] args) =>
    WebHost.CreateDefaultBuilder(args)
        .UseStartup(Assembly.GetExecutingAssembly().FullName)
        .Build();
示例
示例
ASP.NET
Web note ad 1