ASP.NET Core使用HostingStartup增强启动操作方法详解

在ASP.NET Core的世界里，启动操作的增强是一个重要的概念，通过HostingStartup机制，我们可以实现这一目的。对于那些熟悉面向切面编程（AOP）概念的朋友们来说，"增强"一词可能早已耳熟能详。在软件开发中，关注点分离和增强现有逻辑的操作是一种常见的设计原则。今天，我们要深入的便是HostingStartup如何帮助我们“增强”启动操作。

概念简述：在ASP.NET Core中，HostingStartup是一个特殊的机制，它允许我们在应用程序启动时执行额外的操作。通过HostingStartup，外部程序集可以为应用提供配置服务、注册服务或者修改中间件管道等。这种机制对于在不改动现有代码的基础上，为应用程序增加新功能或优化启动流程非常有用。

如何使用呢？我们可以从两个方面来HostingStartup的使用方式：

一、自动扫描方式：这种方式相对简单，但会对Web程序本身产生一定的入侵。ASP.NET Core在启动时会自动扫描当前Web程序集中通过HostingStartup特性指定的类。这些类中包含的方法会在应用程序启动时执行，从而允许我们执行一些额外的操作，比如配置服务、注册中间件等。

二、手动添加配置方式：这种方式稍微复杂一些，但是可以做到对现有代码的无入侵操作。我们可以通过配置hostingstartupassembles来指定外部的程序集中通过HostingStartup特性指定的类。这意味着我们可以将额外的启动操作封装在一个独立的程序集中，然后通过配置的方式来引入，从而避免对主应用程序的改动。

无论是哪种方式，HostingStartup都为我们提供了一种强大的机制来增强ASP.NET Core应用程序的启动操作。通过这种方式，我们可以实现关注点分离，将启动时的操作封装在独立的组件中，使得代码更加清晰、易于维护。这种机制也为我们提供了在不改动现有代码的基础上，为应用程序增加新功能或优化启动流程的可能性。对于那些希望提高ASP.NET Core应用程序性能和功能性的开发者来说，HostingStartup是一个不可或缺的工具。在ASP.NET Core的世界里，有一种强大的机制让我们能够自定义并扩展应用程序的启动过程，那就是通过HostingStartup。这是一种无需修改主应用程序代码，即可对应用程序的配置和服务进行扩展的方式。让我们深入如何在ASP.NET Core中直接定义和使用HostingStartup。

想象一下，你有一个Web项目，而在另一个程序集中，你定义了一些启动时的配置和服务的注册逻辑。为了将这些逻辑集成到Web项目中，你需要使用HostingStartup。你需要创建一个类并实现IHostingStartup接口。这个类将包含你的启动逻辑。然后，你需要使用HostingStartupAttribute来指定这个类的类型。这样，当Web项目启动时，你的HostingStartup类就会自动执行。

以下是具体的实现方式：

下面是如何在Web项目中引入这个外部程序集的步骤：

确保你的Web项目引用了包含HostingStartup的外部程序集。然后，在Web项目的启动类中（通常是Startup类），使用HostingStartupAttribute来指定你的HostingStartup类的类型。这样，当Web项目启动时，就会自动调用你的HostingStartup类的Configure方法。

这种方式的好处是，你可以将启动逻辑放在外部程序集中，保持Web项目的清洁和简洁。你还可以在不同的项目之间共享和重用这些启动逻辑。这对于大型项目和跨多个项目的开发来说，是非常有用的。

HostingStartup是ASP.NET Core中一个强大的特性，它允许我们在不修改主应用程序代码的情况下，自定义和扩展应用程序的启动过程。无论是直接在Web项目中定义，还是从外部程序集引入，都能轻松地实现这个功能。使用HostingStartup，我们可以更灵活地配置和服务注册，从而使我们的ASP.NET Core应用程序更加强大和可定制。要在我们的项目中引入并使用 `Microsoft.AspNetCore.Hosting` 包，首先需要在项目文件中通过 `` 标签指定相应的版本。这确保了我们的应用程序能够利用该包提供的强大功能。这个包是 ASP.NET Core 应用中非常重要的一个组件，因为它允许我们实现应用的启动和托管逻辑。特别是当我们需要定制启动时，引入 `Microsoft.AspNetCore.Hosting` 包变得尤为重要。但如果你不需要注册中间件的逻辑，可以选择引入 `Microsoft.AspNetCore.Hosting.Abstractions` 包，它提供了抽象化的托管服务接口。

为了更深入地使用托管启动功能，我们创建了一个名为 `HostStartupLib` 的标准类库。在这个类库中，我们定义了一个名为 `HostingStartupInLib` 的类，该类实现了 `IHostingStartup` 接口。这意味着我们可以自定义启动时的配置。这个类允许我们配置应用的各个方面，如应用程序的配置、依赖注入和服务配置等。但在实际使用中，如果我们仅仅引入这个类库到 Web 项目中，并不会自动触发 `HostingStartupInLib` 的 `Configure` 方法。这是因为我们需要手动指定启动程序集的名称，以确保 `HostingStartup` 类被正确识别和使用。这可以通过程序集的元数据来实现，例如使用 `[assembly: HostingStartup(typeof(HostStartupLib.HostingStartupInLib))]` 属性标记我们的程序集。这样，当 Web 项目启动时，它会加载并执行我们的自定义启动逻辑。我们可以在 `Configure` 方法中添加各种配置和初始化代码，如配置服务、中间件注册等。这些配置将在应用启动时执行，确保应用程序按照我们的需求进行初始化。通过引入 `Microsoft.AspNetCore.Hosting` 包并正确配置我们的自定义启动类库，我们可以实现更加灵活和强大的 ASP.NET Core 应用托管和启动逻辑。启动程序集的方式在ASP.NET Core应用中扮演着重要的角色，它允许开发者灵活地在应用程序启动时加载特定的程序集。关于此功能的实现，存在两种常见的指定方式。

第一种方式是通过`IWebHostBuilder`的扩展方法`UseSetting`来指定。在创建主机构建器时，我们可以使用`Host.CreateDefaultBuilder(args)`来初始化一个默认的主机构建器，并通过`ConfigureWebHostDefaults`方法配置Web主机的默认设置。在这个配置过程中，我们可以使用`UseSetting`方法并传入`WebHostDefaults.HostingStartupAssembliesKey`作为键，来指定我们想要加载的程序集名称。例如：

```csharp

public static IHostBuilder CreateHostBuilder(string[] args) =>

Host.CreateDefaultBuilder(args)

.ConfigureWebHostDefaults(webBuilder =>

{

// 通过UseSetting指定程序集

webBuilder.UseSetting(WebHostDefaults.HostingStartupAssembliesKey, "HostStartupLib");

// 若存在多个程序集，可使用英文分号(;)分隔，如："HostStartupLib;AnotherStartupLib"

//...

webBuilder.UseStartup();

});

```

第二种方式是通过设置环境变量`ASPNETCORE_HOSTINGSTARTUPASSEMBLIES`来指定。这种方式通常在开发环境中使用，特别是在使用`launchSettings.json`文件配置IIS Express或类似工具时。在`launchSettings.json`中设置环境变量就像在系统设置中设置环境变量一样，可以设置特定的键和值，如：

```json

"environmentVariables": {

"ASPNETCORE_HOSTINGSTARTUPASSEMBLIES": "HostStartupLib"

// 若存在多个程序集，同样使用英文分号(;)分隔

}

```

尽管这两种方式看似不同，但它们本质上是相同的——都是通过设置特定的配置键来指定需要加载的程序集。通过程序设置环境变量的方式与在操作系统中直接设置环境变量的效果是一致的。一旦指定了启动程序集，当应用启动时，相应的`HostingStartup`配置方法就会被调用。这种方式对现有代码的入侵最小，几乎不需要改动现有代码就可以引入新的启动逻辑。

为了进一步理解`HostingStartup`的工作原理以及为什么在某些场景下需要手动指定程序集，我们需要深入相关的源码。源码中会详细解释`HostingStartup`的基本工作方式、为什么它在Web程序中可以不需要配置程序集信息就能被调用，以及为什么通过外部程序集引入`HostingStartup`时只能通过`UseSetting`和环境变量的方式指定。这些源码中的细节可以帮助我们更好地理解这个功能的实现原理，从而更好地运用它。后续我们可以进一步剖析相关的源码实现细节，以解开`HostingStartup`的神秘面纱。源码：GenericWebHostBuilder中的ExecuteHostingStartups方法

让我们深入GenericWebHostBuilder类中的ExecuteHostingStartups方法。这个方法在构建WebHost的过程中扮演着重要角色，特别是对于那些熟悉.NET Core托管启动机制的开发人员来说。以下是对该方法详细功能的阐述和代码。

这个方法首先创建一个WebHostOptions对象，该对象通过配置和当前程序集名称进行初始化。其中，如果PreventHostingStartup属性设置为true，则方法会立即返回，阻止执行后续的启动逻辑。这是一种灵活的配置选项，允许开发者根据需要定制启动流程。

接下来，方法创建一个HostingStartupWebHostBuilder实例，这是承载IWebHostBuilder接口实现的关键对象。这个构建器是托管启动的核心部分，负责加载并配置宿主程序集的启动程序。

在循环中，方法通过调用webHostOptions的GetFinalHostingStartupAssemblies方法获取最终要执行的程序集名称列表。对于每一个程序集名称，它尝试加载相应的程序集信息。对于包含HostingStartupAttribute的程序集，会实例化HostingStartupAttribute的HostingStartupType属性的对象实例。这里的对象实例就是我们自定义的宿主启动类，比如HostStartupWeb.HostingStartupInWeb。

然后，它会调用宿主启动类的Configure方法，将HostingStartupWebHostBuilder实例作为参数传递进去。这一步是托管启动的关键环节，宿主启动类可以在这里执行自定义的启动逻辑，比如配置路由、中间件等。

如果在执行过程中遇到任何异常，它们会被捕获并添加到exceptions列表中。如果列表中有异常存在，那么会抛出一个AggregateException异常，其中包含所有捕获到的异常信息。这对于调试和错误处理是非常有用的。

ExecuteHostingStartups方法通过加载宿主启动程序集并调用它们的配置方法，为WebHost提供了自定义的启动逻辑支持。这使得开发者可以根据项目需求灵活地扩展和定制WebHost的启动过程。深入HostStartup工作机制之时，我们注意到为何在Web程序中，HostingStartup不需要手动配置程序集信息也能被成功调用。其背后的机制，实际上与我们如何构建和使用WebHostOptions的特定设置密切相关。当我们深入研究其源代码实现时，我们可以清晰地看到，其工作原理主要依赖于几个关键属性：HostingStartupAssemblies、HostingStartupExcludeAssemblies、PreventHostingStartup以及ApplicationName。

让我们看看HostingStartupAssemblies这个属性。这是承载启动时需要的HostingStartup程序集列表。在WebHostOptions的构造函数中，这个列表的初始化依赖于应用程序名称（ApplicationName）和配置中的HostingStartupAssembliesKey。这意味着，如果没有在配置中明确指定HostingStartupAssembliesKey，那么它会默认使用当前的应用程序名称作为程序集的来源之一。在Web程序中，我们无需额外配置程序集信息，因为默认会使用当前应用程序的名称。

另一方面，当我们通过外部程序集引入HostingStartup时，情况有所不同。我们需要手动指定程序集信息。这是因为外部程序集并不属于默认的应用程序上下文，因此系统无法自动识别其作为启动程序集的一部分。这就是为什么在这种情况下需要手动指定程序集的原因。

还有两个其他属性也非常重要：HostingStartupExcludeAssemblies和PreventHostingStartup。前者用于排除不需要执行的程序集，后者用于控制是否阻止HostingStartup启动执行功能。这两个属性在决定哪些程序集将被加载和执行时起着关键作用。

关于程序集的初始化逻辑，值得注意的是Split方法。这个方法用于分隔配置中的程序集信息，以";"分号作为分隔符。这也是我们在配置多个程序集时使用分号的原因。通过这种分隔方式，我们能够轻松地指定哪些程序集应该被包含在HostingStartupAssemblies列表中。

HostingStartup在Web程序中无需配置程序集信息即可被调用的原因，在于其依赖于默认的ApplicationName和配置中的HostingStartupAssembliesKey。通过这两个属性，系统能够自动识别并加载必要的程序集。而对于外部程序集，由于其不属于默认上下文，因此需要手动指定程序集信息以确保正确加载和执行。在ASP.NET Core应用中，HostingStartup的配置是一个强大的功能，它允许开发者在托管启动阶段进行特定的设置和调整。让我们深入一下如何使用特定的配置来控制HostingStartup程序集的行为。

我们可以了解到通过配置HostingStartup相关的属性，我们可以排除不想启动的HostingStartup程序集，或者甚至完全禁止某些功能。这些配置信息主要来源于WebHostDefaults常量类所定义的三个属性。它们分别是：HostingStartupAssembliesKey（托管启动程序集）、HostingStartupExcludeAssembliesKey（排除托管启动程序集）和PreventHostingStartupKey（阻止托管启动）。这些属性的配置可以决定哪些程序集参与启动过程，哪些被排除在外，以及是否完全禁用HostingStartup功能。

在创建宿主构建器时，我们可以通过使用`.ConfigureWebHostDefaults()`方法来指定这些配置。例如，我们可以使用`UseSetting`方法来指定程序集的名称，通过指定不同的程序集名称来执行或排除特定的HostingStartup逻辑。我们还可以直接通过环境变量的方式来操作这些配置。在环境变量配置中，"ASPNETCORE_"前缀将被忽略，这是因为在使用`ConfigureWebHostDefaults`配置WebHost相关信息时会自动添加`prefix: "ASPNETCORE_"`逻辑。通过环境变量设置的配置信息可以与环境变量前缀保持一致。这两种配置方式是等价的，只是取决于我们更倾向于使用代码配置还是环境变量配置。

通过这种方式，我们可以灵活地控制HostingStartup的行为，以适应不同的开发环境和需求。无论是通过代码配置还是环境变量配置，都可以轻松地管理托管启动过程中的不同设置和逻辑。这对于开发和部署ASP.NET Core应用来说是非常有用的功能，它允许我们更精细地控制应用的启动过程和行为。这些配置选项提供了很大的灵活性，让我们可以根据具体情况来调整和优化应用的性能和行为。关于HostingStartup配置的介绍

目前仍存在一个悬而未决的问题：为何HostingStartup的配置只能以UseSetting和环境变量的方式进行设定？现在，让我们揭开这一神秘面纱。

在ExecuteHostingStartups方法中，我们看到了相关的逻辑。此方法中，有一个关键的步骤是创建WebHostOptions实例，这个实例接受两个参数：配置_config和程序集的名称。这里的_config，是我们自定义的配置实例。

关于_config的初始化，我们先通过ConfigurationBuilder创建一个配置构建器，然后添加内存集合。如果未抑制环境配置，还会添加环境变量，前缀为"ASPNETCORE_"。这样构建的_config实例，就是我们操作的核心配置对象。

那么，为何我们可以通过环境变量去配置HostingStartup呢？答案就在于我们对_config的操作。其中，UseSetting方法就是将给定的键值对添加到_config中。不论是通过UseSetting还是环境变量的方式去配置，本质都是在操作这个_config配置实例。

说到SkyAPM的应用，HostingStartup可以增强启动时的操作，以无入侵的方式增强程序功能。在SkyAPM-dot的使用中，正是利用了该功能，实现了无入侵的APM监控。具体的使用方式是通过Nuget添加SkyAPM.Agent.AspNetCore程序集引用。这样，我们就能轻松地使用HostingStartup进行配置，并通过环境变量或UseSetting方法进行具体的设定。这种灵活性使得我们可以根据实际需求进行定制化的配置，提升了应用的启动效率和性能。在后续的开发中，我们还可以期待更多的功能和优化，使得HostingStartup成为我们构建ASP.NET Core应用的重要工具之一。在`launchSettings.json`文件中，我们添加了一项重要的环境变量配置`ASPNETCORE_HOSTINGSTARTUPASSEMBLIES`，并为其指定了值“SkyAPM.Agent.AspNetCore”。这就像是在设置ASP.NET Core的环境参数，告诉它启动时应该加载哪些程序集。这种配置方式等同于在代码中通过`set`或`export`命令设置环境变量。其核心目的是优化程序的启动过程。其中，我们设置程序名称为通过环境变量`SKYWALKING__SERVICENAME`来定义。

当我们看到需要配置`ASPNETCORE_HOSTINGSTARTUPASSEMBLIES`时，意味着我们正在使用HostingStartup功能。该功能允许我们在ASP.NET Core应用程序启动时加载额外的程序集并执行特定的操作。SkyAPM.Agent.AspNetCore程序集就是这样一个例子，它为我们提供了监控和追踪的功能。在这个程序集的源码中，我们可以看到一个名为SkyApmHostingStartup的类，它实现了IHostingStartup接口，并定义了如何配置我们的应用程序。在源码中，我们看到了通过调用ConfigureServices方法添加了SkyAPM的监控服务。SkyAPM是一款用于微服务监控的工具，它能增强我们对应用程序的性能监控和追踪能力。通过这种方式，我们可以更好地了解应用程序的性能瓶颈和优化点。

驾驭Zipkin：以全新的方式集成与改造

在我们之前的文章中，已经展示了如何通过诊断日志DiagnosticSource来改进Zipkin的集成方式。今天，我们将通过HostingStartup这一强大的工具，进一步改进Zipkin的使用体验，使其与SkyAPM-dot的使用方式类似。我们将通过添加一个ZipkinHostingStartup类到ZipkinExtensions程序集中，来承载集成Zipkin的操作。让我们深入了解这一过程。

我们需要理解HostingStartup的概念及其使用方式。在ASP.NET Core中，HostingStartup是一个用于扩展Web主机配置的工具。通过实现IHostingStartup接口，我们可以向应用程序添加自定义的服务和中间件。这使得我们可以在不修改现有业务代码的情况下，集成第三方组件或基础组件。

在我们的案例中，我们将使用HostingStartup来集成Zipkin。我们需要在ZipkinExtensions类中创建一个名为ZipkinHostingStartup的类，并实现IHostingStartup接口。在Configure方法中，我们将配置Zipkin的服务和中间件。具体步骤如下：

在ConfigureServices方法中，我们通过调用services.AddZipkin()来添加Zipkin服务，并通过services.AddSingleton()添加诊断监听器。

在Configure方法中，我们通过从应用程序服务中获取IHostApplicationLifetime、ILoggerFactory和IConfiguration实例来配置Zipkin。然后，我们调用app.UseZipkin()来使用Zipkin中间件。通过这种方式，我们可以在不修改现有代码的情况下集成Zipkin。

接下来，为了在项目中启用这种新的集成方式，我们需要在每个项目的launchSettings.json文件中添加相应的配置。具体来说，我们需要设置ASPNETCORE_HOSTINGSTARTUPASSEMBLIES和ASPNETCORE_ZIPKINADDRESS两个环境变量。这将使我们能够无缝集成Zipkin，而无需对现有业务代码进行任何入侵。

本文介绍了HostingStartup的基本概念、使用方式以及源码分析，并展示了如何通过HostingStartup来改造Zipkin的集成方式。HostingStartup在一些集成APM或链路跟踪等场景中非常实用。如果我们需要集成一些基础组件或第三方组件，而不希望直接在代码中使用这些组件的类或建立直接的代码关系，那么HostingStartup就是一种很好的选择。通过HostingStartup，我们可以实现对现有代码的无入侵增强。我在研究源码时偶然发现了HostingStartup，后来在阅读微软ASP.NET Core官方文档时找到了相关的解释。结合我曾经使用过的SkyAPM-dot，我意识到这是一个强大的工具，能够帮助我们实现代码的监控和链路跟踪，而无需对现有代码进行任何修改。我决定深入研究并分享这篇文章，希望更多的人能够了解并使用这个功能。深入ASP.NET Core：使用HostingStartup强化启动操作

在ASP.NET Core的世界里，我们一直在寻求更高效、更灵活的方式来启动和配置我们的应用程序。今天，我们将如何使用HostingStartup类来增强ASP.NET Core的启动操作。这不仅能帮助我们更好地管理启动流程，还能为我们的应用程序带来诸多优势。

HostingStartup是ASP.NET Core中一个非常强大的特性，允许我们在应用程序的启动时执行自定义配置和逻辑。借助HostingStartup，我们可以实现诸多功能，包括但不限于：初始化依赖注入、配置中间件、注册服务等等。这使得我们在构建复杂的应用程序时，能够更加灵活地管理和组织代码。

想象一下，当我们的应用程序启动时，我们可以通过HostingStartup自动执行一系列操作，如数据库连接、缓存配置等。这不仅简化了我们的工作流程，还提高了应用程序的性能和稳定性。

狼蚁SEO团队深知ASP.NET Core开发者的需求，一直致力于和研究新的技术趋势和最佳实践。我们鼓励大家多多关注狼蚁SEO的博客和教程，这里汇聚了众多关于ASP.NET Core的实用知识和经验分享。我们相信，通过不断学习和实践，大家能够不断提升自己的技能，为构建更优秀的应用程序做出贡献。

在狼蚁SEO的网站上，你可以找到更多关于ASP.NET Core使用HostingStartup增强启动操作的详细指南和教程。无论你是初学者还是资深开发者，都能在这里找到有价值的信息。我们期待你的参与和支持，共同推动ASP.NET Core社区的发展。

HostingStartup是ASP.NET Core中一个不可忽视的特性。通过使用HostingStartup，我们能够更好地管理和优化应用程序的启动流程，为构建高性能、高可靠性的应用程序打下坚实的基础。让我们充分利用这一强大工具，为我们的应用程序注入更多活力和能量吧！