反模式:使用自定义代码或作为目标在代理中调用代理

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档
信息

Edge 允许您从一个 API 代理调用一个 API 代理。如果您的 API 代理包含可由其他 API 代理使用的可重用代码,此功能会非常有用。

反模式

使用目标端点中的 HTTPTargetConnection 或自定义 JavaScript 代码从另一个 API 代理调用一个 API 代理会导致产生额外的网络跃点。

使用 HTTPTargetConnection 从代理 1 调用代理 2

以下代码示例使用 HTTPTargetConnection 从代理 1 调用代理 2:

<!-- /antipatterns/examples/2-1.xml -->
<HTTPTargetConnection>
  <URL>http://myorg-test.apigee.net/proxy2</URL>
</HTTPTargetConnection>

通过 JavaScript 代码从代理 1 调用代理 2

下一个代码示例使用 JavaScript 从代理 1 调用代理 2:

<!-- /antipatterns/examples/2-2.xml -->
var response = httpClient.send('http://myorg-test.apigee.net/proxy2);
response.waitForComplete();

代码流

如需了解为何出现这一固有缺陷,我们需要了解请求采用的路由,如下图所示:

图 1:代码流

如图所示,一个请求遍历多个分布式组件,包括路由器和消息处理器。

在上面的代码示例中,从代理 1 调用代理 2 意味着请求必须在运行时通过传统路由(即路由器 > MP)进行路由。这类似于从客户端调用 API,因而会导致多个网络跃点,从而增加延迟时间。考虑到代理 1 请求已“到达”MP,因此这些跃点是不必要的。

影响

从一个 API 代理调用一个 API 代理会产生不必要的网络跃点,也就是将请求从一个消息处理器传递到另一个消息处理器。

最佳实践

  • 使用代理链功能从一个 API 代理调用另一个 API 代理。代理链更高效,因为它使用本地连接引用目标端点(另一个 API 代理)。

    以下代码示例展示了在您的端点定义中使用 LocalTargetConnection 的代理链:

    <!-- /antipatterns/examples/2-3.xml -->
    <LocalTargetConnection>
      <APIProxy>proxy2</APIProxy>
      <ProxyEndpoint>default</ProxyEndpoint>
    </LocalTargetConnection>
    

    调用的 API 代理将在同一消息处理器中执行;因此,它可避免网络跃点,如下图所示:

    图 2:包含代理链接的代码流

深入阅读