Ocelot中文文档-配置

时间：2023-03-09 15:13:34
Ocelot中文文档-配置

这里有一个配置的列子。其中有两个配置块。一个ReRoutes数组和一个GlobalConfiguration。ReRoutes配置块是一些告诉Ocelot如何处理上游请求的对象。Globalconfiguration有些奇特，可以覆盖ReRoute节点的特殊设置。如果你不想管理大量的ReRoute特定的设置的话，这将很有用。

{
    "ReRoutes": [],
    "GlobalConfiguration": {}
}

这是一个ReRoute配置的例子，你不需要全部都设置，但这是目前可用的所有设置：

{
          "DownstreamPathTemplate": "/",
          "UpstreamPathTemplate": "/",
          "UpstreamHttpMethod": [
              "Get"
          ],
          "AddHeadersToRequest": {},
          "AddClaimsToRequest": {},
          "RouteClaimsRequirement": {},
          "AddQueriesToRequest": {},
          "RequestIdKey": "",
          "FileCacheOptions": {
              "TtlSeconds": 0,
              "Region": ""
          },
          "ReRouteIsCaseSensitive": false,
          "ServiceName": "",
          "DownstreamScheme": "http",
          "DownstreamHostAndPorts": [
              {
                  "Host": "localhost",
                  "Port": 51876,
              }
          ],
          "QoSOptions": {
              "ExceptionsAllowedBeforeBreaking": 0,
              "DurationOfBreak": 0,
              "TimeoutValue": 0
          },
          "LoadBalancer": "",
          "RateLimitOptions": {
              "ClientWhitelist": [],
              "EnableRateLimiting": false,
              "Period": "",
              "PeriodTimespan": 0,
              "Limit": 0
          },
          "AuthenticationOptions": {
              "AuthenticationProviderKey": "",
              "AllowedScopes": []
          },
          "HttpHandlerOptions": {
              "AllowAutoRedirect": true,
              "UseCookieContainer": true,
              "UseTracing": true
          },
          "UseServiceDiscovery": false,
          "DangerousAcceptAnyServerCertificateValidator": false
      }

有关如何使用这些选项的更多信息如下..

多环境

和其他任何asp.net core项目一样，Ocelot支持像configuration.dev.json、configuration.test.json等的配置文件名。为了实现多环境配置，需要添加如下的代码。

.ConfigureAppConfiguration((hostingContext, config) =>
        {
            config
                .SetBasePath(hostingContext.HostingEnvironment.ContentRootPath)
                .AddJsonFile("appsettings.json", true, true)
                .AddJsonFile($"appsettings.{hostingContext.HostingEnvironment.EnvironmentName}.json", true, true)
                .AddJsonFile("ocelot.json")
                .AddJsonFile($"configuration.{hostingContext.HostingEnvironment.EnvironmentName}.json")
                .AddEnvironmentVariables();
        })

Ocelot现在将使用特定于环境的配置，如果没有，则返回到ocelot.json。

您还需要设置相应的ASPNETCORE_ENVIRONMENT环境变量。更多信息可以查看asp.net core 文档.

合并配置文件

此功能在问题Issue 296提出要求，并允许用户有多个配置文件，以便管理大型配置。

不直接使用.AddJsonFile("ocelot.json")这样添加配置，还可以使用AddOcelot()方法添加

.ConfigureAppConfiguration((hostingContext, config) =>
    {
        config
            .SetBasePath(hostingContext.HostingEnvironment.ContentRootPath)
            .AddJsonFile("appsettings.json", true, true)
            .AddJsonFile($"appsettings.{hostingContext.HostingEnvironment.EnvironmentName}.json", true, true)
            .AddOcelot()
            .AddEnvironmentVariables();
    })

在这种情况下，Ocelot将查找与模式(?i)ocelot.([a-zA-Z0-9]*).json匹配的任何文件，然后将它们合并。 如果你想设置GlobalConfiguration属性，你必须有一个名为ocelot.global.json的文件。

Ocelot合并文件的方式基本上是加载、循环它们，添加所有ReRoutes，添加所有AggregateReRoutes，如果文件名为ocelot.global.json，则添加GlobalConfiguration以及所有ReRoutes或AggregateReRoutes。 然后Ocelot将合并后的配置保存到一个名为ocelot.json的文件中，这才是ocelot运行时配置的真正来源。

目前在这个阶段没有验证，只有当Ocelot最终合并配置时才会发生验证。 当你排查问题时要注意这一点。如果您有任何问题，建议您始终检查ocelot.json中的内容。

将配置存储在consul中

如果您在注册服务时添加以下内容，Ocelot将尝试在consul的KV数据中存储和检索其配置。

services
   .AddOcelot()
   .AddStoreOcelotConfigurationInConsul();

您还需要将以下内容添加到您的ocelot.json中。 这使Ocelot知道如何找到您的Consul代理并进行交互以及从Consul加载和存储配置。

"GlobalConfiguration": {
    "ServiceDiscoveryProvider": {
        "Host": "localhost",
        "Port": 9500
    }
}

我在研究过raft算法并发现其超级之难后决定创建此功能。 为什么不利用Consul已经给你的这个便利呢！我想这意味着如果你想最大限度地使用Ocelot，你现在就需要将Consul作为依赖。

此功能在向本地consul代理发出新请求之前有3秒TTL缓存。

重定向 / 使用CookieContainer

在ReRoute配置中使用HttpHandlerOptions来设置HttpHandler行为：

  1. AllowAutoRedirect的值指示请求是否应该遵循重定向响应。 如果请求应该自动重定向来自下游资源的响应，请将其设置为true; 否则为false。 默认值是false。

  2. UseCookieContainerd的值指示处理程序是否使用CookieContainer属性存储服务器cookie，并在发送请求时使用这些cookie。默认值是false。值得注意的是，如果您使用CookieContainer，Ocelot为每个下游服务缓存HttpClient。这意味着对该下游的所有请求都将共享相同的Cookie。 问题274的提出是因为用户观察到Cookie被共享了。我试图想出一个好的解决方案，但我认为是不可能的。如果您不缓存客户端，这意味着每个请求都获得一个新客户端并因此获得一个新的cookie容器。如果您清除缓存客户端容器中的Cookie，则会因为正在进行的请求而竞争。这也意味着后续请求不能使用以前响应中的cookie！总而言之，这不是一个好的局面。我会避免将UseCookieContainer设置为true，除非有一个非常好的理由。只需查看您的响应头，并在您的下一个请求把cookie转发回来！

SSL错误

如果您想忽略SSL警告/错误，请在ReRoute配置中设置以下内容。

"DangerousAcceptAnyServerCertificateValidator": false

我不建议这么做，如果可以我建议你创建自己的证书，然后让本地/远程的机器信任它。

相关文章