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

相关文章

聊聊springboot中如何自定义消息转换器

《聊聊springboot中如何自定义消息转换器》SpringBoot通过HttpMessageConverter处理HTTP数据转换,支持多种媒体类型,接下来通过本文给大家介绍springboot中... 目录核心接口springboot默认提供的转换器如何自定义消息转换器Spring Boot 中的消息

Springboot项目构建时各种依赖详细介绍与依赖关系说明详解

《Springboot项目构建时各种依赖详细介绍与依赖关系说明详解》SpringBoot通过spring-boot-dependencies统一依赖版本管理,spring-boot-starter-w... 目录一、spring-boot-dependencies1.简介2. 内容概览3.核心内容结构4.

Go语言使用net/http构建一个RESTful API的示例代码

《Go语言使用net/http构建一个RESTfulAPI的示例代码》Go的标准库net/http提供了构建Web服务所需的强大功能,虽然众多第三方框架(如Gin、Echo)已经封装了很多功能,但... 目录引言一、什么是 RESTful API?二、实战目标:用户信息管理 API三、代码实现1. 用户数据

在ASP.NET项目中如何使用C#生成二维码

《在ASP.NET项目中如何使用C#生成二维码》二维码(QRCode)已广泛应用于网址分享,支付链接等场景,本文将以ASP.NET为示例,演示如何实现输入文本/URL,生成二维码,在线显示与下载的完整... 目录创建前端页面(Index.cshtml)后端二维码生成逻辑(Index.cshtml.cs)总结

Python用Flask封装API及调用详解

《Python用Flask封装API及调用详解》本文介绍Flask的优势(轻量、灵活、易扩展),对比GET/POST表单/JSON请求方式,涵盖错误处理、开发建议及生产环境部署注意事项... 目录一、Flask的优势一、基础设置二、GET请求方式服务端代码客户端调用三、POST表单方式服务端代码客户端调用四

Spring Boot项目如何使用外部application.yml配置文件启动JAR包

《SpringBoot项目如何使用外部application.yml配置文件启动JAR包》文章介绍了SpringBoot项目通过指定外部application.yml配置文件启动JAR包的方法,包括... 目录Spring Boot项目中使用外部application.yml配置文件启动JAR包一、基本原理

Springboot项目登录校验功能实现

《Springboot项目登录校验功能实现》本文介绍了Web登录校验的重要性,对比了Cookie、Session和JWT三种会话技术,分析其优缺点,并讲解了过滤器与拦截器的统一拦截方案,推荐使用JWT... 目录引言一、登录校验的基本概念二、HTTP协议的无状态性三、会话跟android踪技术1. Cook

Python自定义异常的全面指南(入门到实践)

《Python自定义异常的全面指南(入门到实践)》想象你正在开发一个银行系统,用户转账时余额不足,如果直接抛出ValueError,调用方很难区分是金额格式错误还是余额不足,这正是Python自定义异... 目录引言:为什么需要自定义异常一、异常基础:先搞懂python的异常体系1.1 异常是什么?1.2

springboot项目中集成shiro+jwt完整实例代码

《springboot项目中集成shiro+jwt完整实例代码》本文详细介绍如何在项目中集成Shiro和JWT,实现用户登录校验、token携带及接口权限管理,涉及自定义Realm、ModularRe... 目录简介目的需要的jar集成过程1.配置shiro2.创建自定义Realm2.1 LoginReal

Linux中的自定义协议+序列反序列化用法

《Linux中的自定义协议+序列反序列化用法》文章探讨网络程序在应用层的实现,涉及TCP协议的数据传输机制、结构化数据的序列化与反序列化方法,以及通过JSON和自定义协议构建网络计算器的思路,强调分层... 目录一,再次理解协议二,序列化和反序列化三,实现网络计算器3.1 日志文件3.2Socket.hpp