.NET 反向代理 YARP 自定义配置提供程序(Configuration Providers)

介绍

  基本 Yarp 示例显示从 appsettings.json 加载的代理配置。相反,代理配置可以从您选择的源以编程方式加载。您可以通过提供几个实现 IProxyConfigProvider 和 IProxyConfig 的类来做到这一点。

  可以使用配置过滤器在加载序列期间修改配置。

结构

  IProxyConfigProvider 有一个方法应该返回一个 IProxyConfig 实例。 IProxyConfig 具有当前路由和集群的列表,以及在此信息过期并应重新加载时通知代理,这将导致再次调用(GetConfig()IChangeTokenGetConfig())

路线

  路由部分是命名路由的无序集合。路由包含匹配项及其相关配置。一条路线至少需要以下字段:

  RouteId - 一个唯一的名称

  ClusterId - 指集群部分中的条目名称。

  Match - 包含 Hosts 数组或 Path 模式字符串。 Path 是一个 ASP.NET Core 路由模板,可以按照此处的说明进行定义。

  可以在每个路由条目上配置标头、授权、CORS 和其他基于路由的策略。

  代理将应用给定的匹配条件和策略,然后将请求传递给指定的集群。

集群

  集群部分是命名集群的无序集合。集群主要包含命名目的地及其地址的集合,其中任何一个都被认为能够处理给定路由的请求。代理将根据路由和集群配置处理请求以选择目的地。

生命周期

启动

  应该在 DI 容器中注册为单例。启动时,代理将解析此实例并调用 .在第一次调用时,提供者可以选择:IProxyConfigProviderGetConfig()

  如果提供者出于任何原因无法生成有效的代理配置,则抛出异常。这将阻止应用程序启动。

  在加载配置时同步阻塞。这将阻止应用程序启动,直到有效的路线数据可用。

  或者,它可以选择在后台加载配置时返回一个空实例。提供者将需要在配置可用时触发(IProxyConfigIChangeToken)

  代理将验证给定的配置,如果它无效,将引发异常,阻止应用程序启动。提供者可以通过使用 IConfigValidator 来预先验证路由和集群并采取它认为适当的任何操作(例如排除无效条目)来避免这种情况。

原子性

  提供给代理的配置对象和集合应该是只读的,一旦通过 .GetConfig() 传递给代理就不能修改

重新加载

  如果支持,一旦代理处理了初始配置集,它将使用此令牌注册回调。如果提供者不支持回调,则每 5 分钟轮询一次(IChangeTokenActiveChangeCallbacksHasChanged)

  1、当提供者想要为代理提供新配置时,它应该:

  (1)在后台加载该配置。

    a. 路由和集群对象是不可变的,因此必须为任何新数据创建新实例。

    b. 可以重新使用未更改的路由和集群的对象,或者可以创建新的实例 - 将通过区分它们来检测更改。

  (2)可选地使用 IConfigValidator 验证配置,然后才从先前的实例发出新数据可用的信号。代理将再次调用以检索新数据(IChangeTokenIProxyConfigGetConfig())

  2、重新加载配置与第一次配置加载时存在重要差异。

  (1)新配置将与当前配置不同,并且只会更新修改后的路由或集群。更新将自动应用,并且只会影响新请求,而不影响当前正在进行的请求。

  (2)重新加载过程中的任何错误都将被记录并抑制。应用程序将继续使用上次已知的正确配置。

  (3)如果抛出代理将无法监听未来的变化,因为 s 是一次性的(GetConfig()IChangeToken)

  验证并应用新配置后,代理将使用新的 .请注意,如果连续发出多次重新加载信号,代理可能会跳过一些并在准备好后立即加载下一个可用配置。每个都包含完整的配置状态,因此不会丢失任何内容(IChangeTokenIProxyConfig)

多个配置源

  从 1.1 开始,YARP 支持从多个来源加载代理配置。 多个可以注册为单例服务,所有将被解析和组合。 源可以是相同或不同的类型,例如 IConfiguration 或 InMemory。 路由可以引用其他来源的集群。 请注意,不支持为给定路由或集群合并来自不同来源的部分配置(IProxyConfigProvider)

services.AddReverseProxy()
        .LoadFromConfig(Configuration.GetSection("ReverseProxy1"))
        .LoadFromConfig(Configuration.GetSection("ReverseProxy2"));

或者

services.AddReverseProxy()
        .LoadFromMemory(routes, clusters)
        .LoadFromConfig(Configuration.GetSection("ReverseProxy"));

Example

  以下是手动加载路由和集群的示例(IProxyConfigProvider)

using System.Collections.Generic;
using System.Threading;
using Microsoft.Extensions.Primitives;
using Yarp.ReverseProxy.Configuration;

namespace Microsoft.Extensions.DependencyInjection
{
    public static class InMemoryConfigProviderExtensions
    {
        public static IReverseProxyBuilder LoadFromMemory(this IReverseProxyBuilder builder, IReadOnlyList routes, IReadOnlyList clusters)
        {
            builder.Services.AddSingleton(new InMemoryConfigProvider(routes, clusters));
            return builder;
        }
    }
}

namespace Yarp.ReverseProxy.Configuration
{
    public class InMemoryConfigProvider : IProxyConfigProvider
    {
        private volatile InMemoryConfig _config;

        public InMemoryConfigProvider(IReadOnlyList routes, IReadOnlyList clusters)
        {
            _config = new InMemoryConfig(routes, clusters);
        }

        public IProxyConfig GetConfig() => _config;

        public void Update(IReadOnlyList routes, IReadOnlyList clusters)
        {
            var oldConfig = _config;
            _config = new InMemoryConfig(routes, clusters);
            oldConfig.SignalChange();
        }

        private class InMemoryConfig : IProxyConfig
        {
            private readonly CancellationTokenSource _cts = new CancellationTokenSource();

            public InMemoryConfig(IReadOnlyList routes, IReadOnlyList clusters)
            {
                Routes = routes;
                Clusters = clusters;
                ChangeToken = new CancellationChangeToken(_cts.Token);
            }

            public IReadOnlyList Routes { get; }

            public IReadOnlyList Clusters { get; }

            public IChangeToken ChangeToken { get; }

            internal void SignalChange()
            {
                _cts.Cancel();
            }
        }
    }
}

  下面是它在 Startup.cs 中的调用方式:

public void ConfigureServices(IServiceCollection services)
{
    var routes = new[]
    {
        new RouteConfig()
        {
            RouteId = "route1",
            ClusterId = "cluster1",
            Match = new RouteMatch
            {
                Path = "{**catch-all}"
            }
        }
    };
    var clusters = new[]
    {
        new ClusterConfig()
        {
            ClusterId = "cluster1",
            Destinations = new Dictionarystring, DestinationConfig>(StringComparer.OrdinalIgnoreCase)
            {
                { "destination1", new DestinationConfig() { Address = "https://example.com" } }
            }
        }
    };

    services.AddReverseProxy()
        .LoadFromMemory(routes, clusters);
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.UseRouting();
    app.UseEndpoints(endpoints =>
    {
        endpoints.MapReverseProxy();
    });
}

 

原文链接:https://www.cnblogs.com/ysmc/p/16727084.html

文章来源于互联网:.NET 反向代理 YARP 自定义配置提供程序(Configuration Providers)

THE END
分享
二维码