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

相关文章

Spring常见错误之Web嵌套对象校验失效解决办法

《Spring常见错误之Web嵌套对象校验失效解决办法》:本文主要介绍Spring常见错误之Web嵌套对象校验失效解决的相关资料,通过在Phone对象上添加@Valid注解,问题得以解决,需要的朋... 目录问题复现案例解析问题修正总结  问题复现当开发一个学籍管理系统时,我们会提供了一个 API 接口去

Python 中 requests 与 aiohttp 在实际项目中的选择策略详解

《Python中requests与aiohttp在实际项目中的选择策略详解》本文主要介绍了Python爬虫开发中常用的两个库requests和aiohttp的使用方法及其区别,通过实际项目案... 目录一、requests 库二、aiohttp 库三、requests 和 aiohttp 的比较四、requ

SpringBoot项目启动后自动加载系统配置的多种实现方式

《SpringBoot项目启动后自动加载系统配置的多种实现方式》:本文主要介绍SpringBoot项目启动后自动加载系统配置的多种实现方式,并通过代码示例讲解的非常详细,对大家的学习或工作有一定的... 目录1. 使用 CommandLineRunner实现方式:2. 使用 ApplicationRunne

使用IntelliJ IDEA创建简单的Java Web项目完整步骤

《使用IntelliJIDEA创建简单的JavaWeb项目完整步骤》:本文主要介绍如何使用IntelliJIDEA创建一个简单的JavaWeb项目,实现登录、注册和查看用户列表功能,使用Se... 目录前置准备项目功能实现步骤1. 创建项目2. 配置 Tomcat3. 项目文件结构4. 创建数据库和表5.

Python项目打包部署到服务器的实现

《Python项目打包部署到服务器的实现》本文主要介绍了PyCharm和Ubuntu服务器部署Python项目,包括打包、上传、安装和设置自启动服务的步骤,具有一定的参考价值,感兴趣的可以了解一下... 目录一、准备工作二、项目打包三、部署到服务器四、设置服务自启动一、准备工作开发环境:本文以PyChar

使用SpringBoot创建一个RESTful API的详细步骤

《使用SpringBoot创建一个RESTfulAPI的详细步骤》使用Java的SpringBoot创建RESTfulAPI可以满足多种开发场景,它提供了快速开发、易于配置、可扩展、可维护的优点,尤... 目录一、创建 Spring Boot 项目二、创建控制器类(Controller Class)三、运行

多模块的springboot项目发布指定模块的脚本方式

《多模块的springboot项目发布指定模块的脚本方式》该文章主要介绍了如何在多模块的SpringBoot项目中发布指定模块的脚本,作者原先的脚本会清理并编译所有模块,导致发布时间过长,通过简化脚本... 目录多模块的springboot项目发布指定模块的脚本1、不计成本地全部发布2、指定模块发布总结多模

SpringBoot项目删除Bean或者不加载Bean的问题解决

《SpringBoot项目删除Bean或者不加载Bean的问题解决》文章介绍了在SpringBoot项目中如何使用@ComponentScan注解和自定义过滤器实现不加载某些Bean的方法,本文通过实... 使用@ComponentScan注解中的@ComponentScan.Filter标记不加载。@C

javafx 如何将项目打包为 Windows 的可执行文件exe

《javafx如何将项目打包为Windows的可执行文件exe》文章介绍了三种将JavaFX项目打包为.exe文件的方法:方法1使用jpackage(适用于JDK14及以上版本),方法2使用La... 目录方法 1:使用 jpackage(适用于 JDK 14 及更高版本)方法 2:使用 Launch4j(

Python3中Sanic中间件的使用

《Python3中Sanic中间件的使用》Sanic框架中的中间件是一种强大的工具,本文就来介绍Python3中Sanic中间件的使用,具有一定的参考价值,感兴趣的可以了解一下... 目录Sanic 中间件的工作流程中间件的使用1. 全局中间件2. 路由中间件3. 异常处理中间件4. 异步中间件5. 优先级