src/ReverseProxy/Transforms/PathTransformExtensions.cs - main - aprogrammer/reverse-proxy-ms-yarp

src/ReverseProxy/Transforms/PathTransformExtensions.cs
124 строки4 KB
James Newton-King
Improve route string syntax usage (#2253)
14 сен 2023, 20:08
14 сен 2023, 20:0844629d6
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

using System;
using System.Diagnostics.CodeAnalysis;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Routing.Template;
using Microsoft.Extensions.DependencyInjection;
using Yarp.ReverseProxy.Configuration;
using Yarp.ReverseProxy.Transforms.Builder;

namespace Yarp.ReverseProxy.Transforms;

/// <summary>
/// Extensions for adding path transforms.
/// </summary>
public static class PathTransformExtensions
{
    /// <summary>
    /// Clones the route and adds the transform which sets the request path with the given value.
    /// </summary>
    public static RouteConfig WithTransformPathSet(this RouteConfig route, PathString path)
    {
        if (path.Value is null)
        {
            throw new ArgumentNullException(nameof(path));
        }

        return route.WithTransform(transform =>
        {
            transform[PathTransformFactory.PathSetKey] = path.Value;
        });
    }

    /// <summary>
    /// Adds the transform which sets the request path with the given value.
    /// </summary>
    public static TransformBuilderContext AddPathSet(this TransformBuilderContext context, PathString path)
    {
        context.RequestTransforms.Add(new PathStringTransform(PathStringTransform.PathTransformMode.Set, path));
        return context;
    }

    /// <summary>
    /// Clones the route and adds the transform which will prefix the request path with the given value.
    /// </summary>
    public static RouteConfig WithTransformPathPrefix(this RouteConfig route, PathString prefix)
    {
        if (prefix.Value is null)
        {
            throw new ArgumentNullException(nameof(prefix));
        }

        return route.WithTransform(transform =>
        {
            transform[PathTransformFactory.PathPrefixKey] = prefix.Value;
        });
    }

    /// <summary>
    /// Adds the transform which will prefix the request path with the given value.
    /// </summary>
    public static TransformBuilderContext AddPathPrefix(this TransformBuilderContext context, PathString prefix)
    {
        context.RequestTransforms.Add(new PathStringTransform(PathStringTransform.PathTransformMode.Prefix, prefix));
        return context;
    }

    /// <summary>
    /// Clones the route and adds the transform which will remove the matching prefix from the request path.
    /// </summary>
    public static RouteConfig WithTransformPathRemovePrefix(this RouteConfig route, PathString prefix)
    {
        if (prefix.Value is null)
        {
            throw new ArgumentNullException(nameof(prefix));
        }

        return route.WithTransform(transform =>
        {
            transform[PathTransformFactory.PathRemovePrefixKey] = prefix.Value;
        });
    }

    /// <summary>
    /// Adds the transform which will remove the matching prefix from the request path.
    /// </summary>
    public static TransformBuilderContext AddPathRemovePrefix(this TransformBuilderContext context, PathString prefix)
    {
        context.RequestTransforms.Add(new PathStringTransform(PathStringTransform.PathTransformMode.RemovePrefix, prefix));
        return context;
    }

    /// <summary>
    /// Clones the route and adds the transform which will set the request path with the given value.
    /// </summary>
    public static RouteConfig WithTransformPathRouteValues(this RouteConfig route, [StringSyntax("Route")] PathString pattern)
    {
        if (pattern.Value is null)
        {
            throw new ArgumentNullException(nameof(pattern));
        }

        return route.WithTransform(transform =>
        {
            transform[PathTransformFactory.PathPatternKey] = pattern.Value;
        });
    }

    /// <summary>
    /// Clones the route and adds the transform which will set the request path with the given value.
    /// </summary>
    public static TransformBuilderContext AddPathRouteValues(this TransformBuilderContext context, [StringSyntax("Route")] PathString pattern)
    {
        if (pattern.Value is null)
        {
            throw new ArgumentNullException(nameof(pattern));
        }

        var binder = context.Services.GetRequiredService<TemplateBinderFactory>();
        context.RequestTransforms.Add(new PathRouteValuesTransform(pattern.Value, binder));
        return context;
    }
}