网关介绍

网关其实就是将我们写好的API全部放在一个统一的地址暴露在公网，提供访问的一个入口。在 .NET Core下可以使用Ocelot来帮助我们很方便的接入API 网关。与之类似的库还有ProxyKit，微软也发布了一个反向代理的库YARP。
关于网关的介绍不多说了，网上文章也挺多的，这些都是不错的选择，听说后期Ocelot将会使用YARP来重写。本篇主要实践一下在.NET Core环境下使用YARP。

YARP介绍

YARP 在 .NET Core 基础结构之上实现，可在 Windows、Linux 或 MacOS 上使用。可以使用 SDK 和您喜欢的编辑器、微软视觉工作室或可视化工作室代码进行开发。
YARP 1.1 支持 ASP.NET 核心 3.1、 5.0 & 6.0。可以从 https://dotnet.microsoft.com/download/dotnet/ 下载 .NET 开发工具包。
对 .NET 5 的视觉工作室支持包含在 Visual Studio 2019 v16.8 或更高版本中。
对 .NET 6 的可视化工作室支持包含在 Visual Studio 2022 中。
文档:https://microsoft.github.io/reverse-proxy/articles/getting-started.html
Git: https://github.com/microsoft/reverse-proxy

入门示例

首先使用命令行创建一个“MyProxy.YarpDemo”ASP.NET Core 应用程序

添加项目引用

  1. Install-Package Yarp.ReverseProxy

添加 YARP 中间件

  1. var builder = WebApplication.CreateBuilder(args);
  2. builder.Services.AddReverseProxy()
  3.     .LoadFromConfig(builder.Configuration.GetSection("ReverseProxy"));
  4. var app = builder.Build();
  5. app.MapReverseProxy();
  6. app.Run();

配置

YARP 的配置在 appsettings.json 文件中定义。有关详细信息，请参阅配置文件。
还可以以编程方式提供配置。有关详细信息，请参阅配置提供程序。
您可以通过查看路由配置和集群配置来了解有关可用配置选项的更多信息。

  1. {
  2.   "Logging": {
  3.     "LogLevel": {
  4.       "Default": "Information",
  5.       "Microsoft": "Warning",
  6.       "Microsoft.Hosting.Lifetime": "Information"
  7.     }
  8.   },
  9.   "AllowedHosts": "*",
  10.   //YARP配置源
  11.   "ReverseProxy": {
  12.     "Routes": {
  13.       "route1": {
  14.         "ClusterId": "cluster1",
  15.         "Match": {
  16.           "Path": "{**catch-all}"
  17.         }
  18.       }
  19.     },
  20.     "Clusters": {
  21.       "cluster1": {
  22.         //PowerOfTwoChoices - 选择两个随机的目标，然后从中选择一个更少请求的目标
  23.         //FirstAlphabetical - 字母序, Random - 随机, RoundRobin - 轮询
  24.         //LeastRequests - 所有目标中选择分配请求最少的目标
  25.         "LoadBalancingPolicy": "PowerOfTwoChoices",
  26.         "Destinations": {
  27.           "destination1": {
  28.             "Address": "http://localhost:5202"
  29.           }
  30.         }
  31.       }
  32.     }
  33.   }
  35. }

:::warning LoadBalancingPolicy配置项说明

  • PowerOfTwoChoices - 选择两个随机的目标，然后从中选择一个更少请求的目标
  • FirstAlphabetical - 字母序
  • Random - 随机
  • RoundRobin - 轮询

  • LeastRequests - 所有目标中选择分配请求最少的目标 :::

    配置项说明

    1. {
    2. "ReverseProxy": {
    3.   // 在 Routes 节点配置需要反向代理的路由表
    4.   "Routes": { 
    5.     // 第一个路由配置（最简配置）
    6.     "minimumroute" : { // 路由名称，可自定义
    8.       // 该路由所关联的集群配置，也就是目标服务器配置
    9.       "ClusterId": "minimumcluster",
    11.       "Match": { // 匹配规则
    12.         "Path": "{**catch-all}"
    13.       }
    14.     },
    15.     // 第二个路由配置（全量）
    16.     "allrouteprops" : {
    17.       "ClusterId": "allclusterprops"
    18.       "Order" : 100, // 路由顺序，数字越小优先级越高
    20.       // 认证策略，可选 "Default", "Anonymous"
    21.       "Authorization Policy" : "Anonymous", 
    23.       // Cors 策略，可选 "Default", "Disable"
    24.       "CorsPolicy" : "Default", 
    26.       "Match": { //匹配 /something/* 
    27.         "Path": "/something/{**remainder}", // The path to match using ASP.NET syntax. 
    29.          // 限定 Host，不设置就是不限制
    30.         "Hosts" : [ "www.aaaaa.com", "www.bbbbb.com"],
    32.          // Heep Methods 限定，不指定就是不限制
    33.         "Methods" : [ "GET", "PUT" ],
    34.         "Headers": [ // 请求头限定，不指定就是不限制
    35.           {
    36.             "Name": "MyCustomHeader", // 请求头名称
    37.             "Values": [ "value1", "value2", "another value" ], // 规则值
    39.              // 匹配模式，可选："ExactHeader", "HeaderPrefix", "Exists" , "Contains", "NotContains"
    40.             "Mode": "ExactHeader",
    41.             "IsCaseSensitive": true // 是否区分大小写
    42.           }
    43.         ],
    44.         "QueryParameters": [ // 查询字符串限定，不设置就是不限制
    45.           {
    46.             "Name": "MyQueryParameter", // 参数名
    47.             "Values": [ "value1", "value2", "another value" ], // 规则值
    48.             "Mode": "Exact", // 匹配模式，可选 "Exact", "Prefix", "Exists" , "Contains", "NotContains"
    49.             "IsCaseSensitive": true
    50.           }
    51.         ]
    52.       },
    53.       "MetaData" : { // 元数据（KV对象），可以在自定义扩展中使用
    54.         "MyName" : "MyValue"
    55.       },
    56.       "Transforms" : [ // List of transforms. See ./Transforms.html for more details
    57.         {
    58.           "RequestHeader": "MyHeader",
    59.           "Set": "MyValue",
    60.         } 
    61.       ]
    62.     }
    63.   },
    64.   // 转发服务器配置
    65.   "Clusters": {
    66.     "minimumcluster": {
    67.       "Destinations": {
    68.         "example.com": { // 目的地 1，名字自定义
    69.           "Address": "http://www.example.com/" // 要转发的目标地址
    70.         }
    71.       }
    72.     },
    73.     "allclusterprops": { // 一个比较全面的目的地配置
    74.       "Destinations": {
    75.         "first_destination": {
    76.           "Address": "https://contoso.com" // 目标地址
    77.         },
    78.         "another_destination": {
    79.           "Address": "https://10.20.30.40",
    80.           "Health" : "https://10.20.30.40:12345/test" // Health Check 地址，会覆盖 HealthCheck.Active 下的 Path
    81.         }
    82.       },
    83.       "LoadBalancingPolicy" : "PowerOfTwoChoices", // 负载均衡策略： PowerOfTwoChoices - 选择两个随机的目标，然后从中选择一个更少请求的目标， "FirstAlphabetical" - 字母序, "Random" - 随机, "RoundRobin" - 轮询, "LeastRequests" - 所有目标中选择分配请求最少的目标
    84.       "SessionAffinity": {
    85.         "Enabled": true, // Defaults to 'false'
    86.         "Policy": "Cookie", // Default, alternatively "CustomHeader"
    87.         "FailurePolicy": "Redistribute", // default, Alternatively "Return503"
    88.         "Settings" : {
    89.             "CustomHeaderName": "MySessionHeaderName" // Defaults to 'X-Yarp-Proxy-Affinity`
    90.         }
    91.       },
    92.       "HealthCheck": { // 健康检查配置
    93.         "Active": { // Makes API calls to validate the health. 
    94.           "Enabled": "true",
    95.           "Interval": "00:00:10", // 检查间隔
    96.           "Timeout": "00:00:10", // 超时时间
    97.           "Policy": "ConsecutiveFailures",
    98.           "Path": "/api/health" // 健康检查地址
    99.         },
    100.         "Passive": { // Disables destinations based on HTTP response codes
    101.           "Enabled": true, // Defaults to false
    102.           "Policy" : "TransportFailureRateHealthPolicy", // Required
    103.           "ReactivationPeriod" : "00:00:10" // 10s
    104.         }
    105.       },
    106.       "HttpClient" : { // Configuration of HttpClient instance used to contact destinations
    107.         "SSLProtocols" : "Tls13",
    108.         "DangerousAcceptAnyServerCertificate" : false,
    109.         "MaxConnectionsPerServer" : 1024,
    110.         "EnableMultipleHttp2Connections" : true,
    111.         "RequestHeaderEncoding" : "Latin1" // How to interpret non ASCII characters in header values
    112.       },
    113.       "HttpRequest" : { // Options for sending request to destination
    114.         "ActivityTimeout" : "00:02:00",
    115.         "Version" : "2",
    116.         "VersionPolicy" : "RequestVersionOrLower",
    117.         "AllowResponseBuffering" : "false"
    118.       },
    119.       "MetaData" : { // Custom Key value pairs
    120.         "TransportFailureRateHealthPolicy.RateLimit": "0.5", // Used by Passive health policy
    121.         "MyKey" : "MyValue"
    122.       }
    123.     }
    124.   }
    125. }
    126. }

    运行项目