Konfigurationsfilter

Wozu Filter dienen

Aus Dateien oder einem benutzerdefinierten Provider geladene Konfiguration ist Rohdaten – ein Filter erhält die Gelegenheit, sie zu ändern, bevor sie validiert und angewendet wird. Typische Anwendungsfälle:

• Felder aus der Bereitstellungsumgebung befüllen (etwa eine Zieladresse, die erst zur Laufzeit bekannt ist).
• Unternehmensweite Standardwerte anwenden oder Richtlinien über alle Routen oder Cluster hinweg erzwingen.
• Platzhalterwerte ersetzen.
• Kleinere Konfigurationsfehler normalisieren oder korrigieren, bevor sie zu harten Fehlern werden.

Einen Filter registrieren

Filter werden mit AddConfigFilter in der Dependency Injection registriert. Es können beliebig viele hinzugefügt werden; sie laufen in der Reihenfolge, in der sie registriert wurden.

C#services.AddReverseProxy()
    .LoadFromConfig(_configuration.GetSection("ReverseProxy"))
    .AddConfigFilter<CustomConfigFilter>();

Einen Filter schreiben

Ein Filter implementiert IProxyConfigFilter mit je einer Methode pro Konfigurationstyp – ConfigureRouteAsync und ConfigureClusterAsync. Da Filter aus der DI aufgelöst werden, können sie wie jeder andere registrierte Dienst Konstruktorabhängigkeiten entgegennehmen. Jede Methode läuft einmal pro Route oder Cluster, jedes Mal, wenn die Konfiguration geladen oder neu geladen wird, und gibt entweder die unveränderte Originalinstanz oder eine geänderte Kopie zurück – der with-Ausdruck von C# 9-Records ist eine bequeme Möglichkeit, diese Kopie zu erzeugen, ohne den Rest des Objekts anzufassen.

C#using System.Text.RegularExpressions;
using Yarp.ReverseProxy.Configuration;

public class CustomConfigFilter : IProxyConfigFilter
{
    private readonly Regex _exp = new("\\{\\{(\\w+)\\}\\}");

    public ValueTask<ClusterConfig> ConfigureClusterAsync(ClusterConfig cluster, CancellationToken cancel)
    {
        var newDestinations = new Dictionary<string, DestinationConfig>(StringComparer.OrdinalIgnoreCase);
        foreach (var d in cluster.Destinations)
        {
            var match = _exp.Match(d.Value.Address);
            if (!match.Success)
            {
                newDestinations.Add(d.Key, d.Value);
                continue;
            }
            var name = match.Groups[1].Value;
            var value = Environment.GetEnvironmentVariable(name)
                ?? throw new ArgumentException($"Substitution for '{name}' in cluster '{d.Key}' was not found.");
            newDestinations.Add(d.Key, d.Value with { Address = value });
        }
        return new ValueTask<ClusterConfig>(cluster with { Destinations = newDestinations });
    }

    public ValueTask<RouteConfig> ConfigureRouteAsync(RouteConfig route, ClusterConfig cluster, CancellationToken cancel)
    {
        if (route.Order is < 1)
        {
            return new ValueTask<RouteConfig>(route with { Order = 1 });
        }
        return new ValueTask<RouteConfig>(route);
    }
}