反模式简介

您正在查看 Apigee 和 Apigee Hybrid 文档。
查看 Apigee Edge 文档。

本部分介绍在 Apigee 上部署 API 代理时出现的常见反模式。

什么是反模式？

反模式是低效或适得其反的软件设计做法（换句话说，与“最佳做法”相反）。从另一个角度说，反模式是软件允许您执行的操作，但它可能会对功能或性能产生负面影响。

以听起来无所不能的“上帝类/对象”为例。 在面向对象的编程中，上帝类是一个为给定应用控制太多类的类，如以下参考树所示：

图 1：上帝类

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

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

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

因此，这种类是应避免创建的反模式。

好在您可以识别这些反模式并采用相应的最佳做法进行纠正，从而使您在 Apigee 上部署的 API 最适合其预期用途。

反模式总结表

下表列出了一些常见的 API 反模式：

类别	反模式
政策反模式	在 JavaScript 代码中使用 waitForComplete() 为 OAuth 令牌设置较长有效期 在 RegularExpressionProtection 政策中使用贪婪限定符 缓存错误响应 将大小超过 256 KB 的数据存储在缓存中 在一个 API 代理中多次调用 MessageLogging 配置非分布式配额 重复使用 Quota 政策 在不当条件下使用 RaiseFault 政策 在 API 代理中错误地访问多值 HTTP 标头 使用服务调出调用无目标代理中的后端服务
一般反模式	在 API 代理中进行 Management API 调用 使用自定义代码或作为目标在代理中调用代理 不使用源代码控制管理系统直接管理 Apigee 资源 配置单个目标服务器的负载平衡的 MaxFailures 设置为非零值 在启用流式传输时访问请求/响应载荷 在 API 代理中定义多个 ProxyEndpoint
后端反模式	允许运行缓慢的后端 停用 HTTP 持久（可重复使用的 keep-alive）连接

下载反模式电子书

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

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