.Net Core的API网关Ocelot的使用(二)[负载,限流,熔断,Header转换]

网关的负载均衡

当下游拥有多个节点的时候，我们可以用DownstreamHostAndPorts来配置

{
    "UpstreamPathTemplate": "/Api_A/{controller}/{action}",
    "DownstreamPathTemplate": "/api/{controller}/{action}",
    "DownstreamScheme": "https",
    "LoadBalancer": "LeastConnection",
    "UpstreamHttpMethod": [ "GET", "POST", "DELETE", "PUT" ],
    "DownstreamHostAndPorts": [
            {
                "Host": "127.0.0.1",
                "Port": 5001,
            },
            {
                "Host": "127.00.1",
                "Port": 5002,
            }
        ],
}

LoadBalancer是来决定负载的算法

• LeastConnection:将请求发往最空闲的那个服务器
• RoundRobin:轮流转发
• NoLoadBalance:总是发往第一个请求或者是服务发现

限流

限流可以防止上下游服务器因为过载而崩溃，可以使用RateLimitOptions来配置限流

{
    "RateLimitOptions": {
        "ClientWhitelist": [“127.0.0.1”],
        "EnableRateLimiting": true,
        "Period": "5s",
        "PeriodTimespan": 1,
        "Limit": 10
    }
}

• ClientWihteList:白名单，不受限流控制。
• EnableRateLimiting:使用启用限流。
• Period:限流控制的时间段 1s, 5m, 1h, 1d。
• PeroidTimeSpan:超过限流限制的次数后,需要等待重置的时间（单位是秒）。
• Limit:在限流控制时间段内最大访问数。
  对于除了请求头中ClientId=127.0.0.1的意外所有求情启用限流，5秒该api最多10次,如果达到10次需要从第10次请求闭合后等待一秒进行下一次访问。

超过限流后会返回429状态码，并在在返回头（Response Header）的Retry-After属性中返回等待重置时间。


限流的默认提示,code码,和限制标志都是可以自己配置的

 {
  "GlobalConfiguration": {
    "BaseUrl":"www.baidu.com",
    "RateLimitOptions": {
      "DisableRateLimitHeaders": false,
      "QuotaExceededMessage": "接口限流!",
      "HttpStatusCode": 200,
      "ClientIdHeader": "ClientId"
    }
  }

• DisableRateLimitHeaders:是否显示X-Rate-Limit和Retry-After头
• QuotaExceededMessage:提示信息
• HttpStatusCode:状态码
• ClientIdHeader:用来设别客户请求头,默认为ClientId。
• BaseUrl 网关暴露的的地址。

熔断

熔断是在下游服务故障或者请求无响应的时候停止将请求转发到下游服务。

 {
    "QoSOptions": {
    "ExceptionsAllowedBeforeBreaking": 3,
    "DurationOfBreak": 20,
    "TimeoutValue": 5000
    }
}

• ExceptionsAllowedBeforeBreaking:允许多少个异常请求。
• DurationOfBreak:熔断的时间(秒)。
• TimeoutValue:下游请求的处理时间超过多少则将请求设置为超时。

缓存

Ocelot可以对下游请求结果进行缓存,主要是依赖于CacheManager来实现的。

{
    "FileCacheOptions": {
        "TtlSeconds": 60,
        "Region": "key"
    }
}

• TtlSeconds:缓存时间(秒)。
• Region:缓存分区名
  我们可以调用Ocelot的API来移除某个区下面的缓存 。

请求头的转化

Ocelot允许在请求下游服务之前和之后转换Header.目前Ocelot只支持查找和替换.

如果们需要转发给下游的Header重添加一个key/value

{
    "UpstreamHeaderTransform": {
        "demo": "xxxxxxx"
    }
}

如果们需要在返回给客户端的的Header中添加一个key/value

{
    "DownstreamHeaderTransform": {
        "demo": "xxxxxxx"
    }
}

如果我们需要替换Heaher中某些值

{
    //请求
    "UpstreamHeaderTransform": {
        "demo": "a,b"
    },
    //响应
    "DownstreamHeaderTransform":
    {
        "demo": "a,b"
    }
}

语法是{find},{replace}, 利用b取代a

在Header转换中可以使用占位符

• {BaseUrl} - 这个是Ocelot暴露在外的url. 例如http://localhost:5000/.
• {DownstreamBaseUrl} - 这个是下游服务的基本url 例如http://localhost:5001/. 目前这个只在DownstreamHeaderTransform中起作用.
• {TraceId} - 这个是Butterfly的跟踪id.目前这个也只在DownstreamHeaderTransform中起作用

如果您想将location头返回给客户端，可能需要将location更改为Ocelot的地址而不是下游服务地址。 Ocelot可以使用以下配置实现。

{
    "DownstreamHeaderTransform": {
    "Location": "{DownstreamBaseUrl},{BaseUrl}"
    },
}

给Header中添加下游地址

响应的Header中已经替换成BaseUrl了

总结

简单的配置了Ocelot的负载，限流，熔断，Header转换。具体配置还需要结合业务去搭配。下一次会给Ocelot集成Identity认证，鉴权。

原文地址：https://www.cnblogs.com/stutlh/p/12011866.html