asp.net core web api项目添加自定义中间件

2024-09-04 00:20

本文主要是介绍asp.net core web api项目添加自定义中间件,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

前言

在asp.net core web api项目中,默认提供了很多的中间件,比如访问静态文件中间件UseStaticFiles,跨域配置中间件UseCors,路由中间件UseRouting,身份验证中间件UseAuthentication

那么如何添加一些自定义的中间件呢。

需求

现在有一个需求,我们的所有接口中都有一个TimeSpan参数,传入的是当前时间的时间戳,正常需要对时间戳进行加密,然后在加一个统一的验证方法,只正常处理2分钟以内的请求,超时的请求不在处理,直接返回错误代码,这样可以一定程度上保护我们的业务数据。

这时我们就可以添加一个自定义的中间件,对所有过来的请求先进行时间戳校验处理,处理通过的再返回到业务逻辑正常处理,时间戳校验不通过的则直接返回错误码。

实现

接下来看实现。

为了演示,我还是新建一个空的asp.net core web api项目。然后调用WeatherForecastController下的Get方法来做测试。
然后添加一个类,为了简单点,这个类就一个TimeSpan参数。

 public class BaseRequest{public string TimeSpan { get; set; }}

为了方便的使用中间件,我们希望可以直接在Program下的Main函数里直接调用。类似这样。

public static void Main(string[] args){var builder = WebApplication.CreateBuilder(args);builder.Services.AddControllers();var app = builder.Build();//这里是自定义添加的中间件app.UseRequestCheckMiddleware();app.UseAuthorization();app.MapControllers();app.Run();}

Startup里添加原理一样。
所以首先我需要添加一个ApplicationBuilder的扩展方法。这样才能调用方法一样用.出来。
添加一个ApplicationBuilderExtension类。

public static class ApplicationBuilderExtension
{public static IApplicationBuilder UseRequestCheckMiddleware(this IApplicationBuilder builder){return builder.UseMiddleware<RequestCheckMiddleware>();}}

在这个类里通过builder.UseMiddleware传入一个实现类,就可以实现中间件添加的效果了,如果想添加多个自定义的中间件,可以继续添加新的Use方法。

接下来重点就是RequestCheckMiddleware的实现。

 public class RequestCheckMiddleware
{private readonly RequestDelegate _next;public RequestCheckMiddleware(RequestDelegate next){_next= next;}public async Task InvokeAsync(HttpContext context){HttpRequest request = context.Request;//缓存下来允许多次读取request.EnableBuffering();var reader = new StreamReader(request.Body, Encoding.UTF8);string data = await reader.ReadToEndAsync();// 重置流的位置以便后续中间件可以读取  request.Body.Position = 0;try{var inputJson = JsonSerializer.Deserialize<BaseRequest>(data);// 假设 BaseRequest.TimeSpan 是一个 long 类型的 UNIX 时间戳  if (string.IsNullOrEmpty(inputJson.TimeSpan)){await HandleError(context, 500, "时间戳为空!");return;}var requestTime = UnixTimeStampToDateTime(Convert.ToInt64(inputJson.TimeSpan));if (DateTime.Now - requestTime > TimeSpan.FromMinutes(2)){await HandleError(context, 429, "超时请求!");return;}await _next(context);}catch (Exception ex){await HandleError(context, 400, $"处理请求失败: {ex.Message}");}}private async Task HandleError(HttpContext context, int statusCode, string message){context.Response.StatusCode = statusCode;var result = new { code = statusCode, message = message, result = new object() };await context.Response.WriteAsync(JsonSerializer.Serialize(result));}private DateTime UnixTimeStampToDateTime(long unixTimeStamp){// UNIX 时间戳转换为 DateTime  DateTime dateTime = new DateTime(1970, 1, 1, 0, 0, 0, 0, DateTimeKind.Utc);dateTime = dateTime.AddSeconds(unixTimeStamp).ToLocalTime();return dateTime;}
}

这里有几点可以解释一下。
1、这里的主函数名必须是Invoke或者InvokeAsync,且入参是HttpContext。表示这是在请求管道中对请求进行处理的中间件。
2、这里需要定义RequestDelegate的委托,因为需要在当前逻辑处理完成后,还需要把请求传递到下一步。
3、request.Body默认只能被读取一次,为了传递到下一步依然有原模原样的请求参数,所以需要先对请求进行缓存处理。读取完成之后,需要把流的位置重置到开始。方便后面可以再次读取请求内容。

然后在Program里添加对应中间件就行了。

 //这里是自定义添加的中间件app.UseRequestCheckMiddleware();

验证

最后来演示一下效果。
首先传递一个2分钟内正常的时间戳。
在这里插入图片描述
请求可以正常返回。

接着等一会吧,等时间戳过期。
在这里插入图片描述

结语

Study hard and make progress every day.

欢迎关注下方微信公众号,一起学习,一起娱乐,一起进步,点击卡片可以查看公众号二维码哟。

这篇关于asp.net core web api项目添加自定义中间件的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1134460

相关文章

vite搭建vue3项目的搭建步骤

《vite搭建vue3项目的搭建步骤》本文主要介绍了vite搭建vue3项目的搭建步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学... 目录1.确保Nodejs环境2.使用vite-cli工具3.进入项目安装依赖1.确保Nodejs环境

idea+spring boot创建项目的搭建全过程

《idea+springboot创建项目的搭建全过程》SpringBoot是Spring社区发布的一个开源项目,旨在帮助开发者快速并且更简单的构建项目,:本文主要介绍idea+springb... 目录一.idea四种搭建方式1.Javaidea命名规范2JavaWebTomcat的安装一.明确tomcat

pycharm跑python项目易出错的问题总结

《pycharm跑python项目易出错的问题总结》:本文主要介绍pycharm跑python项目易出错问题的相关资料,当你在PyCharm中运行Python程序时遇到报错,可以按照以下步骤进行排... 1. 一定不要在pycharm终端里面创建环境安装别人的项目子模块等,有可能出现的问题就是你不报错都安装

uni-app小程序项目中实现前端图片压缩实现方式(附详细代码)

《uni-app小程序项目中实现前端图片压缩实现方式(附详细代码)》在uni-app开发中,文件上传和图片处理是很常见的需求,但也经常会遇到各种问题,下面:本文主要介绍uni-app小程序项目中实... 目录方式一:使用<canvas>实现图片压缩(推荐,兼容性好)示例代码(小程序平台):方式二:使用uni

C#利用Free Spire.XLS for .NET复制Excel工作表

《C#利用FreeSpire.XLSfor.NET复制Excel工作表》在日常的.NET开发中,我们经常需要操作Excel文件,本文将详细介绍C#如何使用FreeSpire.XLSfor.NET... 目录1. 环境准备2. 核心功能3. android示例代码3.1 在同一工作簿内复制工作表3.2 在不同

C#中通过Response.Headers设置自定义参数的代码示例

《C#中通过Response.Headers设置自定义参数的代码示例》:本文主要介绍C#中通过Response.Headers设置自定义响应头的方法,涵盖基础添加、安全校验、生产实践及调试技巧,强... 目录一、基础设置方法1. 直接添加自定义头2. 批量设置模式二、高级配置技巧1. 安全校验机制2. 类型

MyCat分库分表的项目实践

《MyCat分库分表的项目实践》分库分表解决大数据量和高并发性能瓶颈,MyCat作为中间件支持分片、读写分离与事务处理,本文就来介绍一下MyCat分库分表的实践,感兴趣的可以了解一下... 目录一、为什么要分库分表?二、分库分表的常见方案三、MyCat简介四、MyCat分库分表深度解析1. 架构原理2. 分

使用Go调用第三方API的方法详解

《使用Go调用第三方API的方法详解》在现代应用开发中,调用第三方API是非常常见的场景,比如获取天气预报、翻译文本、发送短信等,Go作为一门高效并发的编程语言,拥有强大的标准库和丰富的第三方库,可以... 目录引言一、准备工作二、案例1:调用天气查询 API1. 注册并获取 API Key2. 代码实现3

linux查找java项目日志查找报错信息方式

《linux查找java项目日志查找报错信息方式》日志查找定位步骤:进入项目,用tail-f实时跟踪日志,tail-n1000查看末尾1000行,grep搜索关键词或时间,vim内精准查找并高亮定位,... 目录日志查找定位在当前文件里找到报错消息总结日志查找定位1.cd 进入项目2.正常日志 和错误日

在.NET项目中嵌入Python代码的实践指南

《在.NET项目中嵌入Python代码的实践指南》在现代开发中,.NET与Python的协作需求日益增长,从机器学习模型集成到科学计算,从脚本自动化到数据分析,然而,传统的解决方案(如HTTPAPI或... 目录一、CSnakes vs python.NET:为何选择 CSnakes?二、环境准备:从 Py