在Ocelot中使用自定义的中间件（二）

2023-11-06 07:32
文章标签 使用 自定义 中间件 ocelot

本文主要是介绍在Ocelot中使用自定义的中间件（二），希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

在上文中《在Ocelot中使用自定义的中间件（一）》，我介绍了如何在Ocelot中使用自定义的中间件来修改下游服务的response body。今天，我们再扩展一下设计，让我们自己设计的中间件变得更为通用，使其能够应用在不同的Route上。比如，我们可以设计一个通用的替换response body的中间件，然后将其应用在多个Route上。

Ocelot的配置文件

我们可以将Ocelot的配置信息写在appsettings.json中，当然也可以将其放在单独的json文件里，然后通过ConfigureAppConfiguration的调用，将单独的json文件添加到配置系统中。无论如何，基于JSON文件的Ocelot配置都是可以加入我们自定义的内容的，基于数据库的或者其它存储的配置文件信息或许扩展起来并不方便，因此，使用JSON文件作为配置源还是一个不错的选择。比如，我们可以在ReRoute的某个配置中添加以下内容：


{

  "DownstreamPathTemplate": "/api/themes",

  "DownstreamScheme": "http",

  "DownstreamHostAndPorts": [

    {

      "Host": "localhost",

      "Port": 5010

    }

  ],

  "UpstreamPathTemplate": "/themes-api/themes",

  "UpstreamHttpMethod": [ "Get" ],

  "CustomMiddlewares": [

    {

      "Name": "themeCssMinUrlReplacer",

      "Enabled": true,

      "Config": {

        "replacementTemplate": "/themes-api/theme-css/{name}"

      }

    }

  ]

}

然后就需要有一个方法能够解析这部分配置内容。为了方便处理，可以增加以下配置Model，专门存放CustomMiddlewares下的配置信息：


public class CustomMiddlewareConfiguration

{

    public string DownstreamPathTemplate { get; set; }

    public string UpstreamPathTemplate { get; set; }

    public int ReRouteConfigurationIndex { get; set; }

    public string Name { get; set; }

    public bool Enabled { get; set; }

    public Dictionary<string, object> Config { get; set; }

}

然后定义下面的扩展方法，用以从IConfiguration对象中解析出所有的CustomMiddleware的配置信息：


public static IEnumerable<CustomMiddlewareConfiguration> GetCustomMiddlewareConfigurations(this IConfiguration config)

{

    var reRoutesConfigSection = config.GetSection("ReRoutes");

    if (reRoutesConfigSection.Exists())

    {

        var reRoutesConfigList = reRoutesConfigSection.GetChildren();

        for (var idx = 0; idx < reRoutesConfigList.Count(); idx++)

        {

            var reRouteConfigSection = reRoutesConfigList.ElementAt(idx);

            var upstreamPathTemplate = reRouteConfigSection.GetSection("UpstreamPathTemplate").Value;

            var downstreamPathTemplate = reRouteConfigSection.GetSection("DownstreamPathTemplate").Value;

            var customMidwareConfigSection = reRouteConfigSection.GetSection("CustomMiddlewares");

            if (customMidwareConfigSection.Exists())

            {

                var customMidwareConfigList = customMidwareConfigSection.GetChildren();

                foreach (var customMidwareConfig in customMidwareConfigList)

                {

                    var customMiddlewareConfiguration = customMidwareConfig.Get<CustomMiddlewareConfiguration>();

                    customMiddlewareConfiguration.UpstreamPathTemplate = upstreamPathTemplate;

                    customMiddlewareConfiguration.DownstreamPathTemplate = downstreamPathTemplate;

                    customMiddlewareConfiguration.ReRouteConfigurationIndex = idx;

                    yield return customMiddlewareConfiguration;

                }

            }

        }

    }

 

    yield break;

}

CustomMiddleware基类

为了提高程序员的开发体验，我们引入CustomMiddleware基类，在Invoke方法中，CustomMiddleware对象会读取所有的CustomMiddleware配置信息，并找到属于当前ReRoute的CustomMiddleware配置信息，从而决定当前的CustomMiddleware是否应该被执行。相关代码如下：


public abstract class CustomMiddleware : OcelotMiddleware

{

    #region Private Fields

 

    private readonly ICustomMiddlewareConfigurationManager customMiddlewareConfigurationManager;

    private readonly OcelotRequestDelegate next;

 

    #endregion Private Fields

 

    #region Protected Constructors

 

    protected CustomMiddleware(OcelotRequestDelegate next,

        ICustomMiddlewareConfigurationManager customMiddlewareConfigurationManager,

        IOcelotLogger logger) : base(logger)

    {

        this.next = next;

        this.customMiddlewareConfigurationManager = customMiddlewareConfigurationManager;

    }

 

    #endregion Protected Constructors

 

    #region Public Methods

 

    public async Task Invoke(DownstreamContext context)

    {

        var customMiddlewareConfigurations = from cmc in this

                                                .customMiddlewareConfigurationManager

                                                .GetCustomMiddlewareConfigurations()

                                             where cmc.DownstreamPathTemplate == context

                                                    .DownstreamReRoute

                                                    .DownstreamPathTemplate

                                                    .Value &&

                                                   cmc.UpstreamPathTemplate == context

                                                    .DownstreamReRoute

                                                    .UpstreamPathTemplate

                                                    .OriginalValue

                                             select cmc;

 

        var thisMiddlewareName = this.GetType().GetCustomAttribute<CustomMiddlewareAttribute>(false)?.Name;

        var customMiddlewareConfiguration = customMiddlewareConfigurations.FirstOrDefault(x => x.Name == thisMiddlewareName);

        if (customMiddlewareConfiguration?.Enabled ?? false)

        {

            await this.DoInvoke(context, customMiddlewareConfiguration);

        }

 

        await this.next(context);

    }

 

    #endregion Public Methods

 

    #region Protected Methods

 

    protected abstract Task DoInvoke(DownstreamContext context, CustomMiddlewareConfiguration configuration);

 

    #endregion Protected Methods

}

接下来就简单了，只需要让自定义的Ocelot中间件继承于CustomMiddleware基类就行了，当然，为了解耦类型名称与中间件名称，使用一个自定义的CustomMiddlewareAttribute：


[CustomMiddleware("themeCssMinUrlReplacer")]

public class ThemeCssMinUrlReplacer : CustomMiddleware

{

    private readonly Regex regex = new Regex(@"\w+://[a-zA-Z0-9]+(\:\d+)?/themes/(?<theme_name>[a-zA-Z0-9_]+)/bootstrap.min.css");

    public ThemeCssMinUrlReplacer(OcelotRequestDelegate next,

        ICustomMiddlewareConfigurationManager customMiddlewareConfigurationManager,

        IOcelotLoggerFactory loggerFactory)

        : base(next, customMiddlewareConfigurationManager, loggerFactory.CreateLogger<ThemeCssMinUrlReplacer>())

    {

    }

 

    protected override async Task DoInvoke(DownstreamContext context, CustomMiddlewareConfiguration configuration)

    {

        var downstreamResponseString = await context.DownstreamResponse.Content.ReadAsStringAsync();

        var downstreamResponseJson = JObject.Parse(downstreamResponseString);

        var themesArray = (JArray)downstreamResponseJson["themes"];

        foreach(var token in themesArray)

        {

            var cssMinToken = token["cssMin"];

            var cssMinValue = cssMinToken.Value<string>();

            if (regex.IsMatch(cssMinValue))

            {

                var themeName = regex.Match(cssMinValue).Groups["theme_name"].Value;

                var replacementTemplate = configuration.Config["replacementTemplate"].ToString();

                var replacement = $"{context.HttpContext.Request.Scheme}://{context.HttpContext.Request.Host}{replacementTemplate}"

                    .Replace("{name}", themeName);

                cssMinToken.Replace(replacement);

            }

        }

 

        context.DownstreamResponse = new DownstreamResponse(

            new StringContent(downstreamResponseJson.ToString(Formatting.None), Encoding.UTF8, "application/json"),

            context.DownstreamResponse.StatusCode, context.DownstreamResponse.Headers, context.DownstreamResponse.ReasonPhrase);

    }

}

自定义中间件的注册

在上文介绍的BuildCustomOcelotPipeline扩展方法中，加入以下几行，就完成所有自定义中间件的注册：


var customMiddlewareTypes = from type in typeof(Startup).Assembly.GetTypes()

                            where type.BaseType == typeof(CustomMiddleware) &&

                                  type.IsDefined(typeof(CustomMiddlewareAttribute), false)

                            select type;

foreach (var customMiddlewareType in customMiddlewareTypes)

{

    builder.UseMiddleware(customMiddlewareType);

}

当然，app.UseOcelot的调用要调整为：

1

app.UseOcelot((b, c) => b.BuildCustomOcelotPipeline(c).Build()).Wait();

运行

重新运行API网关，得到结果跟之前的一样。所不同的是，我们可以将ThemeCssMinUrlReplacer在其它的ReRoute配置上重用了。

这篇关于在Ocelot中使用自定义的中间件（二）的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/355300。

相关文章

Java中的ConcurrentBitSet使用小结

Java中的ConcurrentBitSet使用小结

《Java中的ConcurrentBitSet使用小结》本文主要介绍了Java中的ConcurrentBitSet使用小结,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,... 目录一、核心澄清：Java标准库无内置ConcurrentBitSet二、推荐方案：Eclipse
阅读更多...
Go语言结构体标签(Tag)的使用小结

Go语言结构体标签(Tag)的使用小结

《Go语言结构体标签(Tag)的使用小结》结构体标签Tag是Go语言中附加在结构体字段后的元数据字符串,用于提供额外的属性信息,这些信息可以通过反射在运行时读取和解析,下面就来详细的介绍一下Tag的使... 目录什么是结构体标签？基本语法常见的标签用途1.jsON 序列化/反序列化（最常用）2.数据库操作（
阅读更多...
Java中ScopeValue的使用小结

Java中ScopeValue的使用小结

《Java中ScopeValue的使用小结》Java21引入的ScopedValue是一种作用域内共享不可变数据的预览API,本文就来详细介绍一下Java中ScopeValue的使用小结,感兴趣的可以... 目录一、Java ScopedValue（作用域值）详解1. 定义与背景2. 核心特性3. 使用方法
阅读更多...
spring中Interceptor的使用小结

spring中Interceptor的使用小结

《spring中Interceptor的使用小结》SpringInterceptor是SpringMVC提供的一种机制,用于在请求处理的不同阶段插入自定义逻辑,通过实现HandlerIntercept... 目录一、Interceptor 的核心概念二、Interceptor 的创建与配置三、拦截器的执行顺
阅读更多...
C#中checked关键字的使用小结

C#中checked关键字的使用小结

《C#中checked关键字的使用小结》本文主要介绍了C#中checked关键字的使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学... 目录✅ 为什么需要checked？ 问题：整数溢出是“静默China编程”的（默认）checked的三种用
阅读更多...
SpringBoot全局异常拦截与自定义错误页面实现过程解读

SpringBoot全局异常拦截与自定义错误页面实现过程解读

《SpringBoot全局异常拦截与自定义错误页面实现过程解读》本文介绍了SpringBoot中全局异常拦截与自定义错误页面的实现方法,包括异常的分类、SpringBoot默认异常处理机制、全局异常拦... 目录一、引言二、Spring Boot异常处理基础2.1 异常的分类2.2 Spring Boot默
阅读更多...
C#中预处理器指令的使用小结

C#中预处理器指令的使用小结

《C#中预处理器指令的使用小结》本文主要介绍了C#中预处理器指令的使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧... 目录 第 1 名：#if/#else/#elif/#endif✅用途：条件编译（绝对最常用！） 典型场景： 示例
阅读更多...
自定义注解SpringBoot防重复提交AOP方法详解

自定义注解SpringBoot防重复提交AOP方法详解

《自定义注解SpringBoot防重复提交AOP方法详解》该文章描述了一个防止重复提交的流程,通过HttpServletRequest对象获取请求信息,生成唯一标识,使用Redis分布式锁判断请求是否... 目录防重复提交流程引入依赖properties配置自定义注解切面Redis工具类controller
阅读更多...
Mysql中RelayLog中继日志的使用

Mysql中RelayLog中继日志的使用

《Mysql中RelayLog中继日志的使用》MySQLRelayLog中继日志是主从复制架构中的核心组件,负责将从主库获取的Binlog事件暂存并应用到从库,本文就来详细的介绍一下RelayLog中... 目录一、什么是 Relay Log（中继日志）二、Relay Log 的工作流程三、Relay Lo
阅读更多...
使用Redis实现会话管理的示例代码

使用Redis实现会话管理的示例代码

《使用Redis实现会话管理的示例代码》文章介绍了如何使用Redis实现会话管理,包括会话的创建、读取、更新和删除操作,通过设置会话超时时间并重置,可以确保会话在用户持续活动期间不会过期,此外,展示了... 目录1. 会话管理的基本概念2. 使用Redis实现会话管理2.1 引入依赖2.2 会话管理基本操作
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2