如何让你的.NET WebAPI程序支持HTTP3?

2024-01-24 18:52
文章标签 程序 支持 net webapi http3

本文主要是介绍如何让你的.NET WebAPI程序支持HTTP3?,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

下面我将总结构建Http3的经验,以Token Gateway的项目为例,请注意使用Http3之前你需要知道它的限制,

Windows

  • Windows 11 版本 22000 或更高版本/Windows Server 2022。
  • TLS 1.3 或更高版本的连接。

Linux

  • 已安装 libmsquic 包。

实现讲解

首先我们需要拉取我们的代码

git clone https://gitee.com/hejiale010426/Gateway.git
cd Gateway

然后我们打开Program.cs

#region FreeSql类型转换Utils.TypeHandlers.TryAdd(typeof(Dictionary<string, string>), new StringJsonHandler<Dictionary<string, string>>());
Utils.TypeHandlers.TryAdd(typeof(RouteMatchEntity), new StringJsonHandler<RouteMatchEntity>());
Utils.TypeHandlers.TryAdd(typeof(List<DestinationsEntity>), new StringJsonHandler<List<DestinationsEntity>>());
Utils.TypeHandlers.TryAdd(typeof(string[]), new StringJsonHandler<string[]>());#endregionvar builder = WebApplication.CreateBuilder(args);builder.Configuration.GetSection(nameof(JwtOptions)).Get<JwtOptions>();builder.WebHost.UseKestrel(options =>
{// 配置多个域名证书options.ConfigureHttpsDefaults(adapterOptions =>{adapterOptions.ServerCertificateSelector = (_, name) =>{// 从Certificate服务中获取if (string.IsNullOrEmpty(name) ||!CertificateService.CertificateEntityDict.TryGetValue(name, out var certificate)) return new X509Certificate2();var path = Path.Combine("/data/", certificate.Path);if (File.Exists(path)) return new X509Certificate2(path, certificate.Password);Console.ForegroundColor = ConsoleColor.Red;Console.WriteLine($"证书文件不存在:{path}");Console.ResetColor();throw new Exception($"证书文件不存在:{path}");};});
});builder.WebHost.ConfigureKestrel(kestrel =>
{kestrel.Limits.MaxRequestBodySize = null;kestrel.ListenAnyIP(8081, portOptions =>{portOptions.Protocols = HttpProtocols.Http1AndHttp2AndHttp3;portOptions.UseHttps();});kestrel.ListenAnyIP(8080, portOptions =>{portOptions.Protocols = HttpProtocols.Http1AndHttp2;});
});#region Jwtbuilder.Services.AddAuthorization().AddJwtBearerAuthentication();#endregionbuilder.Services.Configure<KestrelServerOptions>(options =>
{options.Limits.MaxRequestBodySize = int.MaxValue; 
});builder.Services.Configure<FormOptions>(x =>
{x.ValueLengthLimit = int.MaxValue;x.MultipartBodyLengthLimit = int.MaxValue; // if don't set default value is: 128 MBx.MultipartHeadersLengthLimit = int.MaxValue;
});builder.Services.ConfigureHttpJsonOptions(options =>
{options.SerializerOptions.Converters.Add(new JsonStringEnumConverter());options.SerializerOptions.Converters.Add(new JsonDateTimeConverter());
});builder.Services.AddHostedService<GatewayBackgroundService>();builder.Services.AddCors(options =>
{options.AddPolicy("AllowAll",builder => builder.SetIsOriginAllowed(_ => true).AllowAnyMethod().AllowAnyHeader().AllowCredentials());
});builder.Configuration.GetSection(nameof(RequestOptions)).Get<RequestOptions>();
builder.Services.AddMemoryCache();builder.Services.AddSingleton<RequestLogMiddleware>();
builder.Services.AddSingleton<StaticFileProxyMiddleware>();builder.Services.AddSingleton<RequestLogService>();
builder.Services.AddSingleton<GatewayService>();
builder.Services.AddSingleton<CertificateService>();
builder.Services.AddSingleton<FileStorageService>();
builder.Services.AddSingleton<StaticFileProxyService>();
builder.Services.AddSingleton<TestService>();
builder.Services.AddSingleton<SettingService>();
builder.Services.AddSingleton<AuthorityService>();builder.Services.AddSingleton<IContentTypeProvider, FileExtensionContentTypeProvider>();builder.Services.AddSingleton<IFreeSql>(_ =>
{var directory = new DirectoryInfo("/data");if (!directory.Exists){directory.Create();}return new FreeSqlBuilder().UseConnectionString(DataType.Sqlite, builder.Configuration.GetConnectionString("DefaultConnection")).UseMonitorCommand(cmd => Console.WriteLine($"Sql:{cmd.CommandText}")) //监听SQL语句.UseAutoSyncStructure(true) //自动同步实体结构到数据库,FreeSql不会扫描程序集,只有CRUD时才会生成表。.Build();
});// 使用内存加载配置 
builder.Services.AddReverseProxy().LoadFromMemory(GatewayService.Routes, GatewayService.Clusters);var app = builder.Build();app.UseCors("AllowAll");app.UseMiddleware<RequestLogMiddleware>();
app.UseMiddleware<StaticFileProxyMiddleware>();// 配置MiniApis服务
app.MapRequestLog();
app.MapStaticFileProxy();
app.MapFileStorage();
app.MapGateway();
app.MapAuthority();
app.MapCertificate();
app.MapSetting();app.UseAuthentication();
app.UseAuthorization();app.MapReverseProxy();await app.RunAsync();

上面是完整的代码,我们不过多讲解,只讲解HTTP3需要哪些配置

首先,我们的Gateway支持动态加载证书,而HTTP3是强制使用证书的,我们在这里提供了动态配置HTTP3的实现。

builder.WebHost.UseKestrel(options =>
{// 配置多个域名证书options.ConfigureHttpsDefaults(adapterOptions =>{adapterOptions.ServerCertificateSelector = (_, name) =>{// 从Certificate服务中获取if (string.IsNullOrEmpty(name) ||!CertificateService.CertificateEntityDict.TryGetValue(name, out var certificate)) return new X509Certificate2();var path = Path.Combine("/data/", certificate.Path);if (File.Exists(path)) return new X509Certificate2(path, certificate.Password);Console.ForegroundColor = ConsoleColor.Red;Console.WriteLine($"证书文件不存在:{path}");Console.ResetColor();throw new Exception($"证书文件不存在:{path}");};});
});

上面配置好了证书,下面我们配置启用HTTP3,下面我们对于容器会监听俩个端口8080,8081,8080是Http端口,所以不需要开启HTTP3,我们在监听8081的时候修改了协议为HttpProtocols.Http1AndHttp2AndHttp3,然后portOptions.UseHttps()强制使用HTTPS,Http1AndHttp2AndHttp3是自动支持多个协议,如果HTTP3不支持则会降级支持HTTP2如果HTTP2不支持则降级支持HTTP1,由于浏览器不确定你是否支持HTTP3所以会先请求一个HTTP2或HTTP1协议的请求,如果支持的话框架会自动给响应头返回一个Alt-Svc的值。

builder.WebHost.ConfigureKestrel(kestrel =>
{kestrel.Limits.MaxRequestBodySize = null;kestrel.ListenAnyIP(8081, portOptions =>{portOptions.Protocols = HttpProtocols.Http1AndHttp2AndHttp3;portOptions.UseHttps();});kestrel.ListenAnyIP(8080, portOptions =>{portOptions.Protocols = HttpProtocols.Http1AndHttp2;});
});

上面俩个配置完成以后我们修改我们的Dockerfile,由于微软提供的默认的镜像是不提供libmsquic,所以我们需要自己写一个Dockerfile,打开我们Gateway项目中的Dockerfile,并且添加libmsquic的构建流程

FROM mcr.microsoft.com/dotnet/aspnet:8.0.1-bookworm-slim-amd64 AS base
USER root
RUN  apt update \&& apt-get install -y --no-install-recommends curl \&& curl -sSL -O https://packages.microsoft.com/config/debian/12/packages-microsoft-prod.deb \&& dpkg -i packages-microsoft-prod.deb \&& rm packages-microsoft-prod.deb \&& apt-get update \&& apt-get install -y libmsquic \&& apt-get purge -y --auto-remove wget && apt-get clean && rm -rf /var/lib/apt/lists/*
WORKDIR /app
EXPOSE 8080
EXPOSE 8081FROM mcr.microsoft.com/dotnet/sdk:8.0 AS build
ARG BUILD_CONFIGURATION=Release
WORKDIR /src
COPY ["src/Gateway/Gateway.csproj", "src/Gateway/"]
RUN dotnet restore "./src/Gateway/Gateway.csproj"
COPY . .
WORKDIR "/src/src/Gateway"
RUN dotnet build "./Gateway.csproj" -c $BUILD_CONFIGURATION -o /app/buildFROM build AS publish
ARG BUILD_CONFIGURATION=Release
RUN dotnet publish "./Gateway.csproj" -c $BUILD_CONFIGURATION -o /app/publish /p:UseAppHost=falseFROM base AS final
WORKDIR /app
COPY --from=publish /app/publish .
ENTRYPOINT ["dotnet", "Gateway.dll"]

在构建镜像的时候需要使用root权限,否则可能导致权限不足构建失败,上面完成了我们本地的镜像构建和.NET Core的HTTP3的启用,然后需要我们构建好了镜像就可以在服务器中跑一个容器了,在运行容器的时候还会有一个坑,下面我们来慢慢讲解,

部署服务

打开我们的服务器使用Linux服务器打开,下面是我们的Gateway的一个Compose版本,由于Docker端口监听默认使用的是tcp,所以我们需要监听俩个协议,因为HTTP3是基于UDP实现的,这也是坑之一,还有如果登录失败可能是映射目录权限不够创建Sqlite文件失败导致。

services:gateway-api:image: registry.token-ai.cn:8300/gatewayrestart: alwaysenvironment:USER: rootPASS: Aa010426.ports:- 8080:8080- 8081:8081/udp- 8081:8081/tcpvolumes:- ./data:/data/gateway-web:image: registry.cn-shenzhen.aliyuncs.com/tokengo/gateway-webrestart: alwaysprivileged: trueenvironment:api_url: http://这里是你上面的Gateway-api能在浏览器本地请求的地址:8200/ports:- 1000:80

然后指向我们的sudo docker-compose up -d

指向完成以后我们打开我们的gateway-web的界面,并且登录进去,如果你没有设置环境变量的话默认密码是rootAa010426.

打开我们的代理设置,添加一个集群:

打开路由,点击添加路由,

打开证书管理,点击添加证书:

将我们的证书上传以后点击右上角的刷新缓存,则会生效,还需要注意将我们的域名解析到服务器当中。上面我们用的是gitea.token-ai.cn,注意的是自签证书似乎不能使用。上面操作完成以后点击我们右上角的刷新缓存,然后访问我们的https://gitea.token-ai.cn:8081,然后打开浏览器的F12,我们可以看到我们的,我们的协议除了第一个都是h3协议,这是因为第一个请求是不确定你是否支持h3所以发起一个h1或h2的协议然后,如果你的响应头响应了Alt-Svc则会下次请求使用h3,

还需要注意的是,Alt-Svc:h3=":8081"; ma=86400的8081是前端访问的端口,这个是需要和访问端口一致,如果不一致也不会使用h3。

注意事项

某些浏览器不一定支持所以需要先确认浏览器是否开启QUIC

还需要确认服务器防火墙是否开启UDP

然后根据上面的文档一步一步来即可,或者可以加群询问群主。

结尾

来着token的分享

开源地址:https://gitee.com/hejiale010426/Gateway
github: https://github.com/239573049/Gateway
技术交流群:737776595

这篇关于如何让你的.NET WebAPI程序支持HTTP3?的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



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

相关文章

python获取指定名字的程序的文件路径的两种方法

《python获取指定名字的程序的文件路径的两种方法》本文主要介绍了python获取指定名字的程序的文件路径的两种方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要... 最近在做项目,需要用到给定一个程序名字就可以自动获取到这个程序在Windows系统下的绝对路径,以下

C#使用Spire.Doc for .NET实现HTML转Word的高效方案

《C#使用Spire.Docfor.NET实现HTML转Word的高效方案》在Web开发中,HTML内容的生成与处理是高频需求,然而,当用户需要将HTML页面或动态生成的HTML字符串转换为Wor... 目录引言一、html转Word的典型场景与挑战二、用 Spire.Doc 实现 HTML 转 Word1

基于Python编写自动化邮件发送程序(进阶版)

《基于Python编写自动化邮件发送程序(进阶版)》在数字化时代,自动化邮件发送功能已成为企业和个人提升工作效率的重要工具,本文将使用Python编写一个简单的自动化邮件发送程序,希望对大家有所帮助... 目录理解SMTP协议基础配置开发环境构建邮件发送函数核心逻辑实现完整发送流程添加附件支持功能实现htm

C#控制台程序同步调用WebApi实现方式

《C#控制台程序同步调用WebApi实现方式》控制台程序作为Job时,需同步调用WebApi以确保获取返回结果后执行后续操作,否则会引发TaskCanceledException异常,同步处理可避免异... 目录同步调用WebApi方法Cls001类里面的写法总结控制台程序一般当作Job使用,有时候需要控制

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)总结

解决hive启动时java.net.ConnectException:拒绝连接的问题

《解决hive启动时java.net.ConnectException:拒绝连接的问题》Hadoop集群连接被拒,需检查集群是否启动、关闭防火墙/SELinux、确认安全模式退出,若问题仍存,查看日志... 目录错误发生原因解决方式1.关闭防火墙2.关闭selinux3.启动集群4.检查集群是否正常启动5.

golang程序打包成脚本部署到Linux系统方式

《golang程序打包成脚本部署到Linux系统方式》Golang程序通过本地编译(设置GOOS为linux生成无后缀二进制文件),上传至Linux服务器后赋权执行,使用nohup命令实现后台运行,完... 目录本地编译golang程序上传Golang二进制文件到linux服务器总结本地编译Golang程序

使用Docker构建Python Flask程序的详细教程

《使用Docker构建PythonFlask程序的详细教程》在当今的软件开发领域,容器化技术正变得越来越流行,而Docker无疑是其中的佼佼者,本文我们就来聊聊如何使用Docker构建一个简单的Py... 目录引言一、准备工作二、创建 Flask 应用程序三、创建 dockerfile四、构建 Docker

解决未解析的依赖项:‘net.sf.json-lib:json-lib:jar:2.4‘问题

《解决未解析的依赖项:‘net.sf.json-lib:json-lib:jar:2.4‘问题》:本文主要介绍解决未解析的依赖项:‘net.sf.json-lib:json-lib:jar:2.4... 目录未解析的依赖项:‘net.sf.json-lib:json-lib:jar:2.4‘打开pom.XM