8.10. Load Balancer

通过 负载均衡器 模式，您可以使用各种不同的负载平衡策略将消息处理委派给多个端点之一。

以下路由使用 round robin 负载均衡策略在目标端点 mock:x、Mock:y,mock:z 间分发传入的消息：

from("direct:start").loadBalance().roundRobin().to("mock:x", "mock:y", "mock:z");

以下示例演示了如何在 XML 中配置相同的路由：

<camelContext xmlns="http://camel.apache.org/schema/spring">
  <route>
    <from uri="direct:start"/>
    <loadBalance>
        <roundRobin/>
        <to uri="mock:x"/>
        <to uri="mock:y"/>
        <to uri="mock:z"/>
    </loadBalance>
  </route>
</camelContext>

Apache Camel 负载均衡器支持以下负载平衡策略：

轮循负载平衡策略周期通过所有目标端点进行循环，将每个传入的消息发送到周期中的下一个端点。例如，如果目标端点列表是 mock:x,mock:y,mock:z,mock:z，则传入的消息会发送到以下端点序列： mock:x, mock:z ,mock:x,mock:y ,mock:z, 等。

您可以在 Java DSL 中指定循环负载平衡策略，如下所示：

from("direct:start").loadBalance().roundRobin().to("mock:x", "mock:y", "mock:z");

另外，您可以在 XML 中配置相同的路由，如下所示：

<camelContext xmlns="http://camel.apache.org/schema/spring">
  <route>
    <from uri="direct:start"/>
    <loadBalance>
        <roundRobin/>
        <to uri="mock:x"/>
        <to uri="mock:y"/>
        <to uri="mock:z"/>
    </loadBalance>
  </route>
</camelContext>

随机负载平衡策略从指定的列表中选择目标端点。

您可以在 Java DSL 中指定随机负载平衡策略，如下所示：

from("direct:start").loadBalance().random().to("mock:x", "mock:y", "mock:z");

另外，您可以在 XML 中配置相同的路由，如下所示：

<camelContext xmlns="http://camel.apache.org/schema/spring">
  <route>
    <from uri="direct:start"/>
    <loadBalance>
        <random/>
        <to uri="mock:x"/>
        <to uri="mock:y"/>
        <to uri="mock:z"/>
    </loadBalance>
  </route>
</camelContext>

粘性负载平衡策略将 In 消息定向到通过计算指定表达式的哈希值来选择的端点。此负载平衡策略的优点在于，相同值的表达式始终发送到同一服务器。例如，通过从包含用户名的标头计算哈希值，您可以确保来自特定用户的消息始终发送到同一目标端点。另一种有用的方法是指定一个表达式，从传入消息中提取会话 ID。这样可确保属于同一会话的所有消息都发送到同一目标端点。

您可以在 Java DSL 中指定粘性负载平衡策略，如下所示：

from("direct:start").loadBalance().sticky(header("username")).to("mock:x", "mock:y", "mock:z");

另外，您可以在 XML 中配置相同的路由，如下所示：

<camelContext xmlns="http://camel.apache.org/schema/spring">
  <route>
    <from uri="direct:start"/>
    <loadBalance>
      <sticky>
        <correlationExpression>
          <simple>header.username</simple>
        </correlationExpression>
      </sticky>
      <to uri="mock:x"/>
      <to uri="mock:y"/>
      <to uri="mock:z"/>
    </loadBalance>
  </route>
</camelContext>

主题负载平衡策略将每个消息的副本发送到所有列出的目标端点（有效将消息广播到所有目的地，如 JMS 主题）。

您可以使用 Java DSL 指定主题负载平衡策略，如下所示：

from("direct:start").loadBalance().topic().to("mock:x", "mock:y", "mock:z");

另外，您可以在 XML 中配置相同的路由，如下所示：

<camelContext xmlns="http://camel.apache.org/schema/spring">
  <route>
    <from uri="direct:start"/>
    <loadBalance>
        <topic/>
        <to uri="mock:x"/>
        <to uri="mock:y"/>
        <to uri="mock:z"/>
    </loadBalance>
  </route>
</camelContext>

从 Apache Camel 2.0 开始，当 Exchange 在处理过程中 异常 时，故障转移 负载均衡器能够尝试下一个处理器。您可以使用触发 故障转移 的特定异常列表配置故障切换。如果没有指定任何例外，则由任何例外触发故障转移。故障转移负载均衡器使用与 onException 例外匹配相同的策略。

故障转移 负载均衡器支持以下选项：

以下示例配置为故障转移，只有在抛出 IOException 异常时：

from("direct:start")
    // here we will load balance if IOException was thrown
    // any other kind of exception will result in the Exchange as failed
    // to failover over any kind of exception we can just omit the exception
    // in the failOver DSL
    .loadBalance().failover(IOException.class)
        .to("direct:x", "direct:y", "direct:z");

您可以选择指定多个例外来故障切换，如下所示：

// enable redelivery so failover can react
errorHandler(defaultErrorHandler().maximumRedeliveries(5));

from("direct:foo")
    .loadBalance()
    .failover(IOException.class, MyOtherException.class)
    .to("direct:a", "direct:b");

您可以在 XML 中配置相同的路由，如下所示：

<route errorHandlerRef="myErrorHandler">
    <from uri="direct:foo"/>
    <loadBalance>
        <failover>
            <exception>java.io.IOException</exception>
            <exception>com.mycompany.MyOtherException</exception>
        </failover>
        <to uri="direct:a"/>
        <to uri="direct:b"/>
    </loadBalance>
</route>

以下示例演示了如何以 round robin 模式进行故障转移：

from("direct:start")
    // Use failover load balancer in stateful round robin mode,
    // which means it will fail over immediately in case of an exception
    // as it does NOT inherit error handler. It will also keep retrying, as
    // it is configured to retry indefinitely.
    .loadBalance().failover(-1, false, true)
    .to("direct:bad", "direct:bad2", "direct:good", "direct:good2");

您可以在 XML 中配置相同的路由，如下所示：

<route>
    <from uri="direct:start"/>
    <loadBalance>
        <!-- failover using stateful round robin,
        which will keep retrying the 4 endpoints indefinitely.
        You can set the maximumFailoverAttempt to break out after X attempts -->
        <failover roundRobin="true"/>
        <to uri="direct:bad"/>
        <to uri="direct:bad2"/>
        <to uri="direct:good"/>
        <to uri="direct:good2"/>
    </loadBalance>
</route>

如果要尽快切换到下一个端点，您可以通过配置 inheritErrorHandler =false 来禁用 inheritErrorHandler。通过禁用 Error Handler，您可以确保它不会干预。这允许故障转移负载均衡器尽快处理故障转移。如果您也启用了 roundRobin 模式，则它会重试，直到成功为止。然后，您可以将 maximumFailoverAttempts 选项配置为高的值，使其最终耗尽并失败。

在许多企业环境中，因为无法处理能力的服务器节点是托管服务的，通常最好根据单个服务器处理容量分发负载。加权循环 算法或 加权随机 算法可用于解决这个问题。

加权负载平衡策略允许您为与其它服务器相关的 每台服务器指定处理负载均衡比率。您可以将这个值指定为每个服务器的正处理权重。较大的数字表示服务器可以处理更大的负载。处理权重用于确定与他人相关的每个处理端点的有效负载分布比率。

下表中描述了可以使用的参数：

以下 Java DSL 示例演示了如何定义加权循环路由和加权的随机路由：

// Java
// round-robin
from("direct:start")
  .loadBalance().weighted(true, "4:2:1" distributionRatioDelimiter=":")
  .to("mock:x", "mock:y", "mock:z");

//random
from("direct:start")
  .loadBalance().weighted(false, "4,2,1")
  .to("mock:x", "mock:y", "mock:z");

您可以在 XML 中配置循环路由，如下所示：

<!-- round-robin -->
<route>
  <from uri="direct:start"/>
  <loadBalance>
    <weighted roundRobin="true" distributionRatio="4:2:1" distributionRatioDelimiter=":" />
    <to uri="mock:x"/>
    <to uri="mock:y"/>
    <to uri="mock:z"/>
  </loadBalance>
</route>

您还可以使用自定义负载均衡器（如您自己的实现）。

使用 Java DSL 的示例：

from("direct:start")
     // using our custom load balancer
     .loadBalance(new MyLoadBalancer())
     .to("mock:x", "mock:y", "mock:z");

使用 XML DSL 的同一示例：

<!-- this is the implementation of our custom load balancer -->
 <bean id="myBalancer" class="org.apache.camel.processor.CustomLoadBalanceTest$MyLoadBalancer"/>

 <camelContext xmlns="http://camel.apache.org/schema/spring">
   <route>
     <from uri="direct:start"/>
     <loadBalance>
       <!-- refer to my custom load balancer -->
       <custom ref="myBalancer"/>
       <!-- these are the endpoints to balancer -->
       <to uri="mock:x"/>
       <to uri="mock:y"/>
       <to uri="mock:z"/>
     </loadBalance>
   </route>
 </camelContext>

请注意，在上面的 XML DSL 中，我们使用 <custom>，它仅在 Camel 2.8 以后提供。在旧版本中，您必须按如下方式进行：

       <loadBalance ref="myBalancer">
         <!-- these are the endpoints to balancer -->
         <to uri="mock:x"/>
         <to uri="mock:y"/>
         <to uri="mock:z"/>
       </loadBalance>

要实现自定义负载均衡器，您可以扩展一些支持类，如 LoadBalancerSupport 和 SimpleLoadBalancerSupport。前者支持异步路由引擎，后者则不支持。下面是一个示例：

public static class MyLoadBalancer extends LoadBalancerSupport {

     public boolean process(Exchange exchange, AsyncCallback callback) {
         String body = exchange.getIn().getBody(String.class);
         try {
             if ("x".equals(body)) {
                 getProcessors().get(0).process(exchange);
             } else if ("y".equals(body)) {
                 getProcessors().get(1).process(exchange);
             } else {
                 getProcessors().get(2).process(exchange);
             }
         } catch (Throwable e) {
             exchange.setException(e);
         }
         callback.done(true);
         return true;
     }
 }

Circuit Breaker 负载均衡器是一个有状态模式，用于监控某些例外的所有调用。最初，Circuit Breaker 处于 closed 状态，并传递所有消息。如果失败且达到阈值，它会进入 open 状态，并拒绝所有调用，直到达到 半OpenAfter 超时为止。超时后，如果存在新的调用，则 Circuit Breaker 会传递所有消息。如果结果成功，Circuit Breaker 会进入关闭状态（如果不是），它会重新变为打开状态。

Java DSL 示例：

from("direct:start").loadBalance()
    .circuitBreaker(2, 1000L, MyCustomException.class)
    .to("mock:result");

Spring XML 示例：

<camelContext id="camel" xmlns="http://camel.apache.org/schema/spring">
    <route>
    <from uri="direct:start"/>
    <loadBalance>
        <circuitBreaker threshold="2" halfOpenAfter="1000">
            <exception>MyCustomException</exception>
        </circuitBreaker>
        <to uri="mock:result"/>
    </loadBalance>
</route>
</camelContext>