反模式简介

您正在查看 Apigee Edge 文档。
前往 Apigee X 文档。 信息

本部分介绍在 Apigee Edge 平台上部署的 API 代理中观察到的常见反模式。

好消息是每种反模式都可以明确识别并采用相应的最佳做法予以纠正。因此，在 Edge 上部署的 API 可实现预期用途且具有更高的性能。

反模式总结表

下表列出了本部分介绍的反模式：

类别	反模式
政策反模式	在不调用刷新流的情况下发放刷新令牌 在 JavaScript 代码中使用 waitForComplete() 为 OAuth 令牌设置较长有效期 在 RegularExpressionProtection 政策中使用贪婪限定符 缓存错误响应 将大于 512kb 的数据存储在缓存中 使用 JavaScript 政策将数据记录到第三方服务器 使用不合规的 JSONPath 版本 在一个 API 代理中多次调用 MessageLogging 配额政策中的高基数标识符 配置非分布式配额 重复使用 Quota 政策 在不当条件下使用 RaiseFault 政策 在 API 代理中错误地访问多值 HTTP 标头 使用服务调出调用无目标代理中的后端服务 使用任何已弃用的 OAuth V1 政策。请参阅弃用。
性能反模式	让未使用的 NodeJS API 代理得到部署 不存在的 KVM 对延迟时间的影响
一般反模式	在 API 代理中进行 Management API 调用 使用自定义代码或作为目标在代理中调用代理 不使用源代码控制管理系统直接管理 Edge 资源 使用相同主机别名和端口号定义多个虚拟主机 配置单个目标服务器的负载均衡的 MaxFailures 设置为非零值 在启用流式传输时访问请求/响应载荷 在 API 代理中定义多个 ProxyEndpoint
后端反模式	允许运行缓慢的后端 停用 HTTP 持久（可重复使用的 keep-alive）连接
Edge Private Cloud 反模式	向 Postgres 数据库中 Apigee 拥有的架构添加自定义信息

下载反模式电子书

除了上述链接外，您还可以下载电子书格式的反模式文档：

• Apigee Edge 反模式文档 v2.0 (PDF)

什么是反模式？

维基百科对软件反模式的定义为：

format_quote

在软件工程中，反模式指的是在实践中经常出现但又低效或是适得其反的设计模式。

format_quote

简单来说，反模式是软件允许“用户”执行的操作，但它可能会对功能、可用性或性能产生负面影响。

以听起来无所不能的“上帝类/对象”为例。

在面向对象的说法中，“上帝类”这种类可控制给定应用的太多类。

例如，假设存在具有以下引用树的应用：

如图所示，上帝类使用和引用太多类。

开发应用的框架不会阻止创建这样的类，但它会存在许多缺点，主要包括：

• 难以维护
• 应用运行时出现单点故障

因此，应避免创建这样的类。这就是一个“反模式”。

目标受众群体

本部分最适合 Apigee Edge 开发者在为其服务设计和开发 API 代理的整个过程中参阅。最理想的用法是，在 API 开发生命周期和问题排查期间作为参考指南。