ASP.NET Core中的自定义中间件是什么?如何创建?

自定义中间件是在ASP.NET Core请求管道中处理请求和响应的组件,通过创建实现InvokeAsync方法并接收HttpContext的类,结合RequestDelegate调用下一个中间件,可实现日志、认证等跨切面逻辑;需在Program.cs中使用app.UseMiddleware()注册,且顺序至关重要;推荐使用构造函数注入配置或单例服务,通过InvokeAsync参数注入作用域服务以避免生命周期错误,调试时应关注_next调用、异步await及中间件执行顺序。

asp.net core中的自定义中间件是什么?如何创建?

在ASP.NET Core中,自定义中间件就是你在HTTP请求处理管道中插入的一段逻辑,它能拦截、检查、修改甚至终止请求,或者在请求处理完毕后对响应做些操作。这就像一个交通检查站,每个请求在到达最终目的地(你的控制器或最小API)之前,都必须经过它,你可以在这里做身份验证、日志记录、错误处理、请求限流等任何你想在请求流中统一处理的事情。

解决方案

创建自定义中间件主要有两种方式,一种是直接在

Startup.cs

(或

Program.cs

)中使用

app.Use()

方法内联定义,另一种是创建独立的类。考虑到复用性和代码组织,通常我们会选择后者。

1. 创建自定义中间件类

一个典型的自定义中间件类需要满足以下条件:

包含一个

RequestDelegate

类型的字段或属性,用于调用管道中的下一个中间件。包含一个名为

InvokeAsync

(或

Invoke

)的方法,该方法接收

HttpContext

作为参数,并返回

Task

。这是中间件的核心逻辑所在。

让我们创建一个简单的日志记录中间件,它会在请求开始和结束时记录一些信息:

using Microsoft.AspNetCore.Http;using Microsoft.Extensions.Logging;using System.Diagnostics;using System.Threading.Tasks;public class RequestLoggingMiddleware{    private readonly RequestDelegate _next;    private readonly ILogger _logger;    public RequestLoggingMiddleware(RequestDelegate next, ILogger logger)    {        _next = next;        _logger = logger;    }    public async Task InvokeAsync(HttpContext context)    {        var stopwatch = Stopwatch.StartNew();        _logger.LogInformation($"Request started: {context.Request.Method} {context.Request.Path}");        // 调用管道中的下一个中间件        await _next(context);        stopwatch.Stop();        _logger.LogInformation($"Request finished: {context.Request.Method} {context.Request.Path} in {stopwatch.ElapsedMilliseconds}ms. Status: {context.Response.StatusCode}");    }}

2. 注册和使用自定义中间件

Program.cs

(或

Startup.cs

Configure

方法)中,你需要使用

app.UseMiddleware()

app.Use()

扩展方法来将你的中间件添加到HTTP请求管道中。

// Program.csusing Microsoft.AspNetCore.Builder;using Microsoft.Extensions.DependencyInjection;using Microsoft.Extensions.Hosting;var builder = WebApplication.CreateBuilder(args);// Add services to the container.builder.Services.AddControllers();builder.Services.AddEndpointsApiExplorer();builder.Services.AddSwaggerGen();var app = builder.Build();// Configure the HTTP request pipeline.if (app.Environment.IsDevelopment()){    app.UseSwagger();    app.UseSwaggerUI();}app.UseHttpsRedirection();// 在这里注册你的自定义中间件// 注意:中间件的注册顺序至关重要!app.UseMiddleware();app.UseAuthorization();app.MapControllers();app.Run();

通过

app.UseMiddleware()

,我们就把

RequestLoggingMiddleware

插入到了请求管道中。每次请求到来,都会先经过它,然后才到达后续的中间件,最终抵达你的API控制器。

何时应该选择自定义中间件,而不是过滤器或服务?

这确实是个让人头疼的问题,因为ASP.NET Core提供了多种方式来处理请求。我的经验是,选择哪种方案,很大程度上取决于你的逻辑在“请求生命周期”中的位置和作用域。

中间件位于HTTP请求管道的最前端,或者说,它直接操作的是原始的

HttpContext

对象。这意味着它能对请求进行最早期、最全局的拦截和处理。比如,如果你需要处理所有请求的身份验证、日志记录、错误捕获(全局异常处理中间件就是典型)、请求限流、URL重写,甚至是一些CDN相关的缓存逻辑,那么中间件是你的首选。它的执行发生在MVC/API控制器选择和执行之前,所以它对整个应用程序的请求流有最高级别的控制力。你可以想象它是一个“门卫”,在任何人进入大楼之前就进行检查。

而过滤器(如Action Filter, Authorization Filter等)则更专注于MVC/API的特定阶段。它们是在某个控制器、某个Action方法,或者某个Razor Page执行前后插入逻辑。比如,你只想对某个特定的API方法进行参数验证、权限检查(基于角色或策略)、结果缓存,或者在Action执行前后修改Model或ViewData,那么过滤器更合适。它就像大楼里的“部门主管”,只负责自己部门的业务。它能访问到

ActionContext

ResultContext

等更具体、更高级别的上下文信息,但无法像中间件那样直接操作原始的HTTP请求/响应流。

至于服务,那更是应用程序的核心业务逻辑了。服务通常不直接参与请求管道的拦截和处理,而是被控制器、过滤器或中间件所调用,来完成具体的业务计算、数据存储等任务。它们是“大楼里的员工”,负责具体的工作。

简而言之:

中间件: 全局性、管道级、早期执行、操作

HttpContext

,适用于通用且不依赖特定MVC/API上下文的横切关注点。过滤器: 特定MVC/API上下文、Action级、依赖

ActionContext

等,适用于与MVC/API行为紧密相关的逻辑。服务: 业务逻辑、被调用、不直接参与请求管道。

当你发现你的逻辑需要作用于所有或大部分请求,并且不关心具体的控制器或Action时,中间件通常是更自然、更高效的选择。

开发自定义中间件时常见的陷阱与调试策略

在实际开发中,自定义中间件虽然强大,但也容易踩坑。我见过最常见的几个问题和相应的调试策略如下:

1. 中间件顺序问题

这是最容易让人迷惑的地方。ASP.NET Core的请求管道是线性的,中间件的注册顺序决定了它们的执行顺序。如果你的认证中间件放在授权中间件之后,那授权可能就无法正常工作了,因为它拿不到认证信息。同样,如果一个错误处理中间件放在了其他可能抛出异常的中间件之前,那它就无法捕获到后续中间件的异常。

调试策略:

可视化管道: 在脑海中或者画出你的中间件管道图。想象请求从左到右流过,响应从右到左流回。日志输出: 在每个中间件的

InvokeAsync

方法入口和出口处添加详细的日志(如前面示例),明确请求经过了哪些中间件,顺序是否正确。断点调试: 这是最直接有效的方法。在每个中间件的

InvokeAsync

方法中设置断点,逐步执行,观察

HttpContext

的状态变化,以及

_next(context)

的调用时机。

2.

_next(context)

调用遗漏或位置不当

忘记调用

await _next(context);

会导致请求无法继续向下传递,管道会在这里“断裂”,后续的中间件和控制器将永远不会被执行。如果把它放在了不正确的位置(比如在一个

return

语句之后),也可能导致类似问题。

调试策略:

断点检查: 确保

_next(context)

被正确调用,并且是在你希望逻辑继续执行的地方。观察响应: 如果你的请求总是返回空响应或不完整的响应,或者请求超时,很可能就是

_next(context)

出了问题。

3. 异步操作处理不当

InvokeAsync

方法中,如果涉及到异步操作(如数据库查询、外部API调用),务必使用

await

关键字。如果忘记

await

,可能会导致请求过早返回,或者出现意想不到的并发问题。

调试策略:

编译器警告: 留意IDE的警告,通常会提示你“因为此调用未被等待,所以执行将继续进行,而不会等待调用完成”。异步流追踪: 使用Visual Studio的并行堆栈窗口,可以帮助你追踪异步方法的执行流程。

4. 依赖注入问题

中间件本身可能需要依赖其他服务。如果在构造函数中注入了生命周期不匹配的服务(比如在单例中间件中注入了作用域服务),或者在

InvokeAsync

方法中需要注入作用域服务却直接从构造函数获取,都可能导致问题。

调试策略:

理解DI生命周期: 牢记

Singleton

(单例)、

Scoped

(作用域)、

Transient

(瞬态)的区别日志DI解析: 在启动时,可以短暂地将日志级别调高,观察DI容器解析服务时的日志,看是否有异常或警告。

InvokeAsync

参数注入: 对于需要作用域服务的中间件,优先考虑在

InvokeAsync

方法中通过参数注入,因为

InvokeAsync

是在每次请求作用域内被调用的,可以正确解析作用域服务。

如何在自定义中间件中安全地注入服务或配置?

在自定义中间件中集成依赖服务或配置,是实现其功能和灵活性的关键。这通常通过依赖注入(DI)机制来完成,但具体操作方式会因服务生命周期和中间件的实现方式而异。

1. 构造函数注入(Constructor Injection)

这是最常见和推荐的方式,适用于那些生命周期与中间件实例本身一致的服务。通常,中间件实例在应用程序启动时只创建一次(如果是单例),或者每次请求时创建一次(如果是通过

IMiddleware

接口实现)。

// 注入日志服务和配置public class MyCustomMiddleware{    private readonly RequestDelegate _next;    private readonly ILogger _logger;    private readonly MyCustomOptions _options; // 假设有一个配置类    public MyCustomMiddleware(RequestDelegate next, ILogger logger, IOptions options)    {        _next = next;        _logger = logger;        _options = options.Value; // 获取配置值    }    public async Task InvokeAsync(HttpContext context)    {        _logger.LogInformation($"Middleware option value: {_options.SomeSetting}");        await _next(context);    }}// 对应的配置类public class MyCustomOptions{    public string SomeSetting { get; set; } = "Default Value";}

注册配置:

Program.cs

中,你需要先将配置绑定到DI容器:

builder.Services.Configure(builder.Configuration.GetSection("MyCustomSection"));// 假设appsettings.json中有这样的配置:// "MyCustomSection": {//   "SomeSetting": "Hello from config!"// }

注意: 如果你在构造函数中注入了

Scoped

(作用域)或

Transient

(瞬态)服务,而你的中间件实例是单例的(通常通过

app.UseMiddleware()

注册的类式中间件默认是单例),这可能会导致“Captive Dependency”问题,即一个生命周期较长的服务持有了生命周期较短的服务实例,可能导致状态污染或资源泄露。

2.

InvokeAsync

方法参数注入(Method Injection)

对于那些需要作用域(Scoped)生命周期的服务,或者你希望每次请求都获取到最新的服务实例时,最佳实践是在

InvokeAsync

方法中通过参数注入。

InvokeAsync

方法会在每个请求的作用域内被调用,因此DI容器能够正确地解析作用域服务。

// 假设有一个作用域服务public interface IScopedService{    string GetOperationId();}public class ScopedService : IScopedService{    private readonly Guid _operationId = Guid.NewGuid();    public string GetOperationId() => _operationId.ToString();}// 在中间件中使用 InvokeAsync 参数注入public class AnotherCustomMiddleware{    private readonly RequestDelegate _next;    public AnotherCustomMiddleware(RequestDelegate next)    {        _next = next;    }    public async Task InvokeAsync(HttpContext context, IScopedService scopedService) // 在这里注入 IScopedService    {        context.Items["OperationId"] = scopedService.GetOperationId(); // 将服务数据存入HttpContext        _logger.LogInformation($"Operation ID for this request: {scopedService.GetOperationId()}");        await _next(context);    }}

注册作用域服务:

builder.Services.AddScoped();

总结:

构造函数注入: 适用于单例服务、配置(

IOptions

)或生命周期与中间件实例一致的服务。

InvokeAsync

参数注入: 专门用于注入作用域(Scoped)服务,确保每次请求都能获取到独立、正确的实例,避免Captive Dependency问题。

理解这两种注入方式的区别和适用场景,能让你更安全、高效地构建自定义中间件,并避免潜在的运行时问题。

以上就是ASP.NET Core中的自定义中间件是什么?如何创建?的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1439225.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2025年12月17日 15:59:22
下一篇 2025年12月17日 15:59:38

相关推荐

  • Uniapp 中如何不拉伸不裁剪地展示图片?

    灵活展示图片:如何不拉伸不裁剪 在界面设计中,常常需要以原尺寸展示用户上传的图片。本文将介绍一种在 uniapp 框架中实现该功能的简单方法。 对于不同尺寸的图片,可以采用以下处理方式: 极端宽高比:撑满屏幕宽度或高度,再等比缩放居中。非极端宽高比:居中显示,若能撑满则撑满。 然而,如果需要不拉伸不…

    2025年12月24日
    400
  • 如何让小说网站控制台显示乱码,同时网页内容正常显示?

    如何在不影响用户界面的情况下实现控制台乱码? 当在小说网站上下载小说时,大家可能会遇到一个问题:网站上的文本在网页内正常显示,但是在控制台中却是乱码。如何实现此类操作,从而在不影响用户界面(UI)的情况下保持控制台乱码呢? 答案在于使用自定义字体。网站可以通过在服务器端配置自定义字体,并通过在客户端…

    2025年12月24日
    800
  • 如何在地图上轻松创建气泡信息框?

    地图上气泡信息框的巧妙生成 地图上气泡信息框是一种常用的交互功能,它简便易用,能够为用户提供额外信息。本文将探讨如何借助地图库的功能轻松创建这一功能。 利用地图库的原生功能 大多数地图库,如高德地图,都提供了现成的信息窗体和右键菜单功能。这些功能可以通过以下途径实现: 高德地图 JS API 参考文…

    2025年12月24日
    400
  • 如何使用 scroll-behavior 属性实现元素scrollLeft变化时的平滑动画?

    如何实现元素scrollleft变化时的平滑动画效果? 在许多网页应用中,滚动容器的水平滚动条(scrollleft)需要频繁使用。为了让滚动动作更加自然,你希望给scrollleft的变化添加动画效果。 解决方案:scroll-behavior 属性 要实现scrollleft变化时的平滑动画效果…

    2025年12月24日
    000
  • 如何为滚动元素添加平滑过渡,使滚动条滑动时更自然流畅?

    给滚动元素平滑过渡 如何在滚动条属性(scrollleft)发生改变时为元素添加平滑的过渡效果? 解决方案:scroll-behavior 属性 为滚动容器设置 scroll-behavior 属性可以实现平滑滚动。 html 代码: click the button to slide right!…

    2025年12月24日
    500
  • 如何选择元素个数不固定的指定类名子元素?

    灵活选择元素个数不固定的指定类名子元素 在网页布局中,有时需要选择特定类名的子元素,但这些元素的数量并不固定。例如,下面这段 html 代码中,activebar 和 item 元素的数量均不固定: *n *n 如果需要选择第一个 item元素,可以使用 css 选择器 :nth-child()。该…

    2025年12月24日
    200
  • 使用 SVG 如何实现自定义宽度、间距和半径的虚线边框?

    使用 svg 实现自定义虚线边框 如何实现一个具有自定义宽度、间距和半径的虚线边框是一个常见的前端开发问题。传统的解决方案通常涉及使用 border-image 引入切片图片,但是这种方法存在引入外部资源、性能低下的缺点。 为了避免上述问题,可以使用 svg(可缩放矢量图形)来创建纯代码实现。一种方…

    2025年12月24日
    100
  • 如何让“元素跟随文本高度,而不是撑高父容器?

    如何让 元素跟随文本高度,而不是撑高父容器 在页面布局中,经常遇到父容器高度被子元素撑开的问题。在图例所示的案例中,父容器被较高的图片撑开,而文本的高度没有被考虑。本问答将提供纯css解决方案,让图片跟随文本高度,确保父容器的高度不会被图片影响。 解决方法 为了解决这个问题,需要将图片从文档流中脱离…

    2025年12月24日
    000
  • 为什么 CSS mask 属性未请求指定图片?

    解决 css mask 属性未请求图片的问题 在使用 css mask 属性时,指定了图片地址,但网络面板显示未请求获取该图片,这可能是由于浏览器兼容性问题造成的。 问题 如下代码所示: 立即学习“前端免费学习笔记(深入)”; icon [data-icon=”cloud”] { –icon-cl…

    2025年12月24日
    200
  • 如何利用 CSS 选中激活标签并影响相邻元素的样式?

    如何利用 css 选中激活标签并影响相邻元素? 为了实现激活标签影响相邻元素的样式需求,可以通过 :has 选择器来实现。以下是如何具体操作: 对于激活标签相邻后的元素,可以在 css 中使用以下代码进行设置: li:has(+li.active) { border-radius: 0 0 10px…

    2025年12月24日
    100
  • 如何模拟Windows 10 设置界面中的鼠标悬浮放大效果?

    win10设置界面的鼠标移动显示周边的样式(探照灯效果)的实现方式 在windows设置界面的鼠标悬浮效果中,光标周围会显示一个放大区域。在前端开发中,可以通过多种方式实现类似的效果。 使用css 使用css的transform和box-shadow属性。通过将transform: scale(1.…

    2025年12月24日
    200
  • 为什么我的 Safari 自定义样式表在百度页面上失效了?

    为什么在 Safari 中自定义样式表未能正常工作? 在 Safari 的偏好设置中设置自定义样式表后,您对其进行测试却发现效果不同。在您自己的网页中,样式有效,而在百度页面中却失效。 造成这种情况的原因是,第一个访问的项目使用了文件协议,可以访问本地目录中的图片文件。而第二个访问的百度使用了 ht…

    2025年12月24日
    000
  • 如何用前端实现 Windows 10 设置界面的鼠标移动探照灯效果?

    如何在前端实现 Windows 10 设置界面中的鼠标移动探照灯效果 想要在前端开发中实现 Windows 10 设置界面中类似的鼠标移动探照灯效果,可以通过以下途径: CSS 解决方案 DEMO 1: Windows 10 网格悬停效果:https://codepen.io/tr4553r7/pe…

    2025年12月24日
    000
  • 使用CSS mask属性指定图片URL时,为什么浏览器无法加载图片?

    css mask属性未能加载图片的解决方法 使用css mask属性指定图片url时,如示例中所示: mask: url(“https://api.iconify.design/mdi:apple-icloud.svg”) center / contain no-repeat; 但是,在网络面板中却…

    2025年12月24日
    000
  • 如何用CSS Paint API为网页元素添加时尚的斑马线边框?

    为元素添加时尚的斑马线边框 在网页设计中,有时我们需要添加时尚的边框来提升元素的视觉效果。其中,斑马线边框是一种既醒目又别致的设计元素。 实现斜向斑马线边框 要实现斜向斑马线间隔圆环,我们可以使用css paint api。该api提供了强大的功能,可以让我们在元素上绘制复杂的图形。 立即学习“前端…

    2025年12月24日
    000
  • 图片如何不撑高父容器?

    如何让图片不撑高父容器? 当父容器包含不同高度的子元素时,父容器的高度通常会被最高元素撑开。如果你希望父容器的高度由文本内容撑开,避免图片对其产生影响,可以通过以下 css 解决方法: 绝对定位元素: .child-image { position: absolute; top: 0; left: …

    2025年12月24日
    000
  • 为什么自定义样式表在 Safari 中访问百度页面时无法生效?

    自定义样式表在 safari 中失效的原因 用户尝试在 safari 偏好设置中添加自定义样式表,代码如下: body { background-image: url(“/users/luxury/desktop/wallhaven-o5762l.png”) !important;} 测试后发现,在…

    2025年12月24日
    000
  • CSS 帮助

    我正在尝试将文本附加到棕色框的左侧。我不能。我不知道代码有什么问题。请帮助我。 css .hero { position: relative; bottom: 80px; display: flex; justify-content: left; align-items: start; color:…

    2025年12月24日 好文分享
    200
  • 前端代码辅助工具:如何选择最可靠的AI工具?

    前端代码辅助工具:可靠性探讨 对于前端工程师来说,在HTML、CSS和JavaScript开发中借助AI工具是司空见惯的事情。然而,并非所有工具都能提供同等的可靠性。 个性化需求 关于哪个AI工具最可靠,这个问题没有一刀切的答案。每个人的使用习惯和项目需求各不相同。以下是一些影响选择的重要因素: 立…

    2025年12月24日
    000
  • 如何用 CSS Paint API 实现倾斜的斑马线间隔圆环?

    实现斑马线边框样式:探究 css paint api 本文将探究如何使用 css paint api 实现倾斜的斑马线间隔圆环。 问题: 给定一个有多个圆圈组成的斑马线图案,如何使用 css 实现倾斜的斑马线间隔圆环? 答案: 立即学习“前端免费学习笔记(深入)”; 使用 css paint api…

    2025年12月24日
    000

发表回复

登录后才能评论
关注微信