欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

ASP.NET Core3.X 终端中间件转换为端点路由运行

程序员文章站 2022-07-02 12:28:44
引言 前几天 ".NET Core3.1发布" ,于是我把公司一个基础通用系统升级了,同时删除了几个基础模块当然这几个基础模块与.NET Core3.1无关,其中包括了支付模块,升级完后静文(同事)问我你把支付删除了啊?我说是啊,没考虑好怎么加上(感觉目前不太好,我需要重新设计一下)。 故事从这开始 ......

引言

前几天.net core3.1发布,于是我把公司一个基础通用系统升级了,同时删除了几个基础模块当然这几个基础模块与.net core3.1无关,其中包括了支付模块,升级完后静文(同事)问我你把支付删除了啊?我说是啊,没考虑好怎么加上(感觉目前不太好,我需要重新设计一下)。

故事从这开始

考虑支付的时候我考虑的是将支付sdk如何直接引入到系统,以及可以有一系列支付的路由,我需要考虑的是如果创建响应给指定的地址,so我开始想如何达到我的目的自定义个中间件,use、run、map???

路由的进阶

路由负责将请求 uri 映射到终结点并向这些终结点调度传入的请求。 路由在应用中定义,并在应用启动时进行配置。 路由可以选择从请求包含的 url 中提取值,然后这些值便可用于处理请求。 通过使用应用中的路由信息,路由还能生成映射到终结点的 url。

在asp.net core 2.1和更低版本中,路由是通过实现将irouter传入的url映射到处理程序的接口来处理的。通常,将直接依赖mvcmiddleware添加到中间件管道末端的实现,而不是直接实现该接口。一旦请求到达mvcmiddleware,便会应用路由来确定传入请求url路径所对应的控制器和操作。

然后,该请求在执行处理程序之前经过了各种mvc筛选器。这些过滤器形成了另一条“管道”,让人联想到中间件管道,并且在某些情况下必须复制某些中间件的行为。一个典型的例子就是cors政策。为了对每个mvc操作以及中间件管道的其他“分支”实施不同的cors策略,内部需要进行一定程度的重复。

“分支”中间件管道通常用于“伪路由”。如map()在中间件管道中的扩展方法,将允许您在传入路径具有给定前缀时有条件地执行某些中间件。

如下所示:

       app.map("/order", app => app.run(async context =>
              {
                  await context.response.writeasync("order");
              })
            );

在这种情况下,该run()方法是“终端”中间件,因为它返回响应。但是从某种意义上说,整个map分支对应于应用程序的“端点”.

在asp.net core 2.2中,引入了终结点路由作为mvc控制器的新路由机制。此实现本质上是的内部实现mvcmiddleware .

在asp.net core 2.x中使用map()

下面我们自定义一个中间件,该中间件返回直接返回一个相应而不是继续往下执行调用_next委托,一个很基本的中间件。

    public class apiendpointmiddleware
    {
        private readonly requestdelegate _next;

        public apiendpointmiddleware(requestdelegate next)
        {
            _next = next;
        }

        public async task invokeasync(httpcontext context)
        {
         
            context.response.statuscode = 200;

            await context.response.writeasync("order");
        }

    }

在asp.net core 2.x中,可以通过使用扩展方法指定路由访问该中间件,从而将其包含在startup.cs的中间件管道中

public void configure(iapplicationbuilder app)
{
    app.usestaticfiles();

    app.map("/order", app => app.usemiddleware<apiendpointmiddleware>()); versionapp.usemiddleware<versionmiddleware>()); 

    app.usemvcwithdefaultroute();
}

当我们访问 /order 或者 /order/1 路由都会得到自定义中间件返回的相应。

将中间件转换为端点路由

在asp.net core 3.0中,我们使用端点路由,因此路由步骤与端点的调用是分开的。实际上,这意味着我们有两个中间件:

  • endpointroutingmiddleware 实际的路由,即计算将为指定的请求url路径调用哪个端点。
  • endpointmiddleware 所有调用的端点。

它们在中间件管道中的两个不同点处添加,因为它们起着两个不同的作用。一般而言,我们想的是路由中间件提前在管道中,以便后续的中间件可以访问有关将执行的端点的信息。端点的调用应在管道的末端进行。

如下所示:

 public void configure(iapplicationbuilder app, iwebhostenvironment env)
        {
            if (env.isdevelopment())
            {
                app.usedeveloperexceptionpage();
            }

            app.usehttpsredirection();

            app.userouting();

            app.useauthorization();

            app.useendpoints(endpoints =>
            {
                endpoints.mapcontrollers();
            });

        }
        

该userouting()扩展方法添加endpointroutingmiddleware到管道,同时将useendpoints()扩展方法添加endpointmiddleware到管道。useendpoints()实际上为应用程序注册所有端点的位置。

那么如何将我们自定义中间件使用端点路由来映射呢?

从概念上讲,我们useendpoints()使用/orderurl作为匹配的路径,将“order”端点的注册移动到调用中:

         endpoints.mapcontrollers();
                endpoints.map("/order",endpoints.createapplicationbuilder()
                .usemiddleware<apiendpointmiddleware>().build()).withdisplayname("order-api");

在我们上面针对asp.net core 2.x的实现中,我们将匹配/order,/order/123等端点路由

例如:

endpoints.map("/order/{action}",null);

这将同时匹配 /order /order/1,但不匹配/order/status/1。它比以前的版本功能强大得多.

在上一个示例中,我们提供了一个显示名称(主要用于调试目的),但是我们可以附加其他的信息,例如授权策略或cors策略,其他中间件可以查询这些信息。例如:

     app.useendpoints(endpoints =>
            {
                endpoints.mapcontrollers();
                endpoints.map("/order/{action}",endpoints.createapplicationbuilder()
                .usemiddleware<apiendpointmiddleware>().build()).withdisplayname("order-api").requirecors("allowallhosts")
            .requireauthorization("adminonly"); 
            });

我们向端点添加了cors策略(allowallhosts)和授权策略(adminonly)。当到达端点的请求到达时,并在执行端点之前采取相应的措施。

参考