在 asp.net core 的中间件中返回具体的页面的实现方法
前言
在asp.netcore中，存在着中间件这一概念，在中间件中，我们可以比过滤器更早的介入到http请求管道，从而实现对每一次的http请求、响应做切面处理，从而实现一些特殊的功能
在使用中间件时，我们经常实现的是鉴权、请求日志记录、全局异常处理等等这种非业务性的需求，而如果你有在asp.netcore中使用过swashbuckle(swagger)、healthcheck、miniprofiler等等这样的组件的话，你会发现，这些第三方的组件往往都提供了页面，允许我们通过可视化的方式完成某些操作或浏览某些数据
因为自己也需要实现类似的功能，虽然使用到的知识点很少、也很简单，但是在网上搜了搜也没有专门介绍这块的文档或文章，所以本篇文章就来说明如何在中间件中返回页面，如果你有类似的需求，希望可以对你有所帮助
StepbyStep
最终实现的功能其实很简单，当用户跳转到某个指定的地址后，自定义的中间件通过匹配到该路径，从而返回指定的页面，所以这里主要会涉及到中间件是如何创建，以及如何处理页面中的静态文件引用
因为这块并不会包含很多的代码，所以这里主要是通过分析Swashbuckle.AspNetCore的代码，了解它是如何实现的这一功能，从而给我们的功能实现提供一个思路
在asp.netcore中使用Swashbuckle.AspNetCore时，我们通常需要在Startup类中针对组件做如下的配置，根据当前程序的信息生成json文件=》公开生成的json文件地址=》根据json文件生成可视化的交互页面
publicclassStartup
{
//Thismethodgetscalledbytheruntime.Usethismethodtoaddservicestothecontainer.
publicvoidConfigureServices(IServiceCollectionservices)
{
//生成swagger配置的json文件
services.AddSwaggerGen(s=>
{
s.SwaggerDoc("v1",newOpenApiInfo
{
Contact=newOpenApiContact
{
Name="DanvicWang",
Url=newUri("https://yuiter.com"),
},
Description="Template.API-ASP.NETCore后端接口模板",
Title="Template.API",
Version="v1"
});
//参数使用驼峰的命名方式
s.DescribeAllParametersInCamelCase();
});
}
//Thismethodgetscalledbytheruntime.UsethismethodtoconfiguretheHTTPrequestpipeline.
publicvoidConfigure(IApplicationBuilderapp,IWebHostEnvironmentenv)
{
//公开swagger生成的json文件节点
app.UseSwagger();
//启用swagger可视化交互页面
app.UseSwaggerUI(s=>
{
s.SwaggerEndpoint($"/swagger/v1/swagger.json",
$"Swaggerdocv1");
});
}
}
可以看到最终呈现给用户的页面，其实是在Configure方法中通过调用UseSwaggerUI方法来完成的，这个方法是在Swashbuckle.AspNetCore.SwaggerUI这个程序集中，所以这里直接从github上找到对应的文件夹，clone下源代码，来看下是如何实现在中间件中返回特定的页面
在clone下的代码中，排除掉一些c#、node.js使用到的项目性文件，可以看到整个项目中的文件按照功能可以分为三大块，其中最核心的则是在SwaggerUIMiddleware类中，因此，这里主要聚焦在这个中间件类的实现
在一个asp.netcore中间件中，核心的处理逻辑是在Invoke/InvokeAsync方法中，结合我们使用swagger时的场景，可以看到，在将组件中所包含的页面呈现给用户时，主要存在如下两个处理逻辑
1、当匹配到用户访问的是/swagger时，返回301的http状态码，浏览器重定向到/swagger/index.html，从而再次触发该中间件的执行
2、当匹配到请求的地址为/swagger/index.html时，将嵌入到程序集中的文件通过stream流的形式获取到，转换成字符串，再指定请求的响应的类型为text/html,从而实现将页面返回给用户
publicasyncTaskInvoke(HttpContexthttpContext)
{
varhttpMethod=httpContext.Request.Method;
varpath=httpContext.Request.Path.Value;
//IftheRoutePrefixisrequested(withorwithouttrailingslash),redirecttoindexURL
if(httpMethod=="GET"&&Regex.IsMatch(path,$"^/?{Regex.Escape(_options.RoutePrefix)}/?$"))
{
//Userelativeredirecttosupportproxyenvironments
varrelativeRedirectPath=path.EndsWith("/")
?"index.html"
:$"{path.Split('/').Last()}/index.html";
RespondWithRedirect(httpContext.Response,relativeRedirectPath);
return;
}
if(httpMethod=="GET"&&Regex.IsMatch(path,$"^/{Regex.Escape(_options.RoutePrefix)}/?index.html$"))
{
awaitRespondWithIndexHtml(httpContext.Response);
return;
}
await_staticFileMiddleware.Invoke(httpContext);
}
这里需要注意，因为类似于这种功能，我们可能会打包成独立的nuget包，然后通过nuget进行引用，所以为了能够正确获取到页面及其使用到的静态资源文件，我们需要将这些静态文件的属性修改成嵌入的资源，从而在打包时可以包含在程序集中
对于网页来说，在引用这些静态资源文件时存在一种相对的路径关系，因此，这里在中间件的构造函数中，我们需要将页面需要使用到的静态文件，通过构建StaticFileMiddleware中间件，将文件映射与网页相同的/swagger路径下面，从而确保页面所需的资源可以正确加载
publicclassSwaggerUIMiddleware
{
privateconststringEmbeddedFileNamespace="Swashbuckle.AspNetCore.SwaggerUI.node_modules.swagger_ui_dist";
privatereadonlySwaggerUIOptions_options;
privatereadonlyStaticFileMiddleware_staticFileMiddleware;
publicSwaggerUIMiddleware(
RequestDelegatenext,
IHostingEnvironmenthostingEnv,
ILoggerFactoryloggerFactory,
SwaggerUIOptionsoptions)
{
_options=options??newSwaggerUIOptions();
_staticFileMiddleware=CreateStaticFileMiddleware(next,hostingEnv,loggerFactory,options);
}
privateStaticFileMiddlewareCreateStaticFileMiddleware(
RequestDelegatenext,
IHostingEnvironmenthostingEnv,
ILoggerFactoryloggerFactory,
SwaggerUIOptionsoptions)
{
varstaticFileOptions=newStaticFileOptions
{
RequestPath=string.IsNullOrEmpty(options.RoutePrefix)?string.Empty:$"/{options.RoutePrefix}",
FileProvider=newEmbeddedFileProvider(typeof(SwaggerUIMiddleware).GetTypeInfo().Assembly,EmbeddedFileNamespace),
};
returnnewStaticFileMiddleware(next,hostingEnv,Options.Create(staticFileOptions),loggerFactory);
}
}
当完成了页面的呈现后，因为一般我们会创建一个单独的类库来实现这些功能，在页面中，可能会包含前后端的数据交互，由于我们在宿主的API项目中已经完成了对于路由规则的设定，所以这里只需要在类库中通过nuget引用Microsoft.AspNetCore.Mvc.Core，然后与WebAPI一样的定义controller，确保这个中间件在宿主程序的调用位于路由匹配规则之后即可
publicvoidConfigure(IApplicationBuilderapp,IWebHostEnvironmentenv)
{
if(env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
app.UseHttpsRedirection();
app.UseRouting();
app.UseAuthorization();
//Endpoint路由规则设定
app.UseEndpoints(endpoints=>
{
endpoints.MapControllers();
});
//自定义中间件
app.UseMiddleware();
}
参考：https://www.nhooo.com/article/116369.htm
总结
到此这篇关于在asp.netcore的中间件中返回具体的页面的实现方法的文章就介绍到这了,更多相关asp.netcore中间件返回具体的页面内容请搜索毛票票以前的文章或继续浏览下面的相关文章希望大家以后多多支持毛票票！
声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。