Falcon v1.0.0 Documentation

• 语言: 英语
• 格式: .epub
• 来源: falcon.readthedocs.io

摘要

Falcon是一个 minimalist WSGI库，用于构建快速的Web API和应用程序后端。它专注于HTTP协议和REST架构风格，提供高性能和轻量级的解决方案。文档详细介绍了Falcon的安装、使用、路由、中间件、钩子、错误处理等功能，并提到了版本更新中的重要变更，如移除全局钩子、改进性能以及调整自动解析表单参数的选项。Falcon强调代码简洁和可读性，适合需要快速响应和灵活性的应用场景。

AI总结

### Falcon v1.0.0 和 v1.1.0 文档总结

#### 1. Falcon v1.0.0 更新日志

##### 突破性更改（Breaking Changes）
1. **移除全局钩子功能**
全局钩子（global hooks）已被移除，API不再接受 `before` 和 `after` 的关键字参数。建议将全局钩子中的逻辑迁移到中间件组件中。

2. **middleware方法的参数变化**
`process_resource()` 方法现在需要接受一个额外的 `params` 参数，以便与路由 URI 模板中的字段值交互。当没有找到路由时，此方法将被跳过，开发者可以通过使用“_sink”来执行逻辑。

3. **自动解析表单参数的更改**
Falcon 默认不再自动解析 `application/x-www-form-urlencoded` 类型的请求。开发者需要通过设置 `app.req_options.auto_parse_form_urlencoded = True` 来启用此功能。

4. **HTTPUnauthorized 初始化参数变化**
`HTTPUnauthorized` 现在需要额外的 `challenges` 参数，符合 RFC 7235 要求。

5. **移除 `Response.body_encoded` 属性**
该属性已被移除，开发者可以通过检查 `resp.body` 来获取响应正文。

##### 新功能与改进
- 响应正文的生成性能得到提升。

#### 2. Falcon v1.1.0 更新日志

##### 突破性更改（Breaking Changes）
- 无突破性更改。

##### 新功能与改进
1. **新增 `bounded_stream` 属性**
该属性用于替代 `stream` 属性，以解决某些 WSGI 服务器的阻塞行为。

2. **新增 `uri_template` 属性**
`Request` 对象现在提供 `uri_template` 属性，用于暴露与请求路径对应的路由模板。

3. **新增 `context` 属性**
`Response` 对象新增 `context` 属性，与 `Request` 对象的 `context` 属性对齐。

4. **JSON 查询参数支持**
`get_param_as_dict()` 方法支持直接获取和解码 JSON 编码的查询参数。

5. **CSV 解析支持**
开发者可以禁用 CSV 风格的查询参数解析。

6. **布尔值解析改进**
`get_param_as_bool()` 现在支持 `on` 和 `off`，以支持 IE 浏览器的默认复选框值。

7. **新增错误类**
新增 `HTTPUriTooLong` 和 `HTTPGone` 错误类。

8. **测试功能增强**
- 新增 `falcon.testing.Cookie` 类，用于表示模拟请求返回的 Cookie。
- `falcon.testing.Result` 现在提供 `cookie` 属性，用于检查返回的 Cookie。

9. **性能优化**
新增 `accept_ranges` 属性，便于设置 `Accept-Ranges` 响应头。

10. **文档改进**
- 修复了多个文档错误和歧义。
- 新增了友好常量的 HTTP 状态码（如 `falcon.HTTP_NO_CONTENT`）。

#### 3. Falcon 框架简介

Falcon 是一个 minimalist WSGI 框架，专注于构建高性能的 RESTful 服务和应用后端。其特点包括：
- **基于 URI 模板的路由**：支持 RFC 标准的路由。
- **高效的性能**：在性能与可⽤性之间取得平衡。
- **无魔法设计**：代码输入与输出之间的关系清晰，便于调试。
- **轻量级依赖**：仅依赖 `six` 和 `mimeparse`。

#### 4. 安装与资源
- **安装**：通过 PyPI 或 GitHub 下载 Falcon。
- **文档**：提供详细的使用指南、教程和 API 文档。
- **社区**：支持 IRC 和邮件列表，便于获取帮助和参与讨论。

#### 5. 特点与优势
- **快速**：在速度上表现优异。
- **轻量**：专注于 HTTP API，不捆绑不必要的依赖。
- **简单**：代码简洁，易于理解和维护。

#### 6. 兼容性
Falcon 支持 Python 2.6、2.7、3.3、3.4 以及 PyPy。

#### 7. 许可证
Falcon 采用 Apache 2.0 许可证，适合商业应用。

---

总结：Falcon 是一个高性能、轻量级的 WSGI 框架，专注于构建 RESTful 服务。v1.0.0 和 v1.1.0 版本带来了多项改进和新功能，包括性能优化、新的属性和方法，以及对中间件和错误处理的支持增强。开发者可以根据需求选择合适的版本，并参考详细的文档和社区资源进行开发。