Tortoise-ORM 中 RawSQL 排序问题的分析与解决

在 Tortoise-ORM 项目中，开发者在使用 RawSQL 注解进行排序时遇到了一个 TypeError 异常。本文将深入分析这个问题的成因、影响范围以及最终的解决方案。

问题现象

当开发者尝试使用 RawSQL 注解并基于该注解结果进行排序时，系统会抛出"TypeError: Object of type RawSQL is not JSON serializable"异常。具体表现为：

Document.all().annotate(foo=RawSQL("'bar'")).order_by("foo").sql()

这段代码本应生成包含正确 ORDER BY 子句的 SQL 查询，但实际上却触发了 JSON 序列化错误。

技术背景

Tortoise-ORM 是一个异步 ORM 框架，它使用 PyPika 作为其查询构建器。在构建复杂查询时，开发者可以使用 RawSQL 表达式来注入原生 SQL 片段。当这些原生 SQL 片段被用作注解(annotation)并参与排序时，系统需要对查询结构进行序列化处理。

问题根源

经过深入分析，这个问题源于 Tortoise-ORM 内部对查询结构的处理方式。具体来说：

1. 当创建带有 RawSQL 注解的查询时，系统会将这些注解存储在查询结构中
2. 在生成 ORDER BY 子句时，系统尝试将整个查询结构(包括注解)序列化为 JSON
3. 由于 RawSQL 对象没有实现 JSON 序列化接口，导致序列化失败

解决方案

该问题已在 Tortoise-ORM 的最新版本中得到修复。修复方案主要涉及以下几个方面：

1. 修改了查询结构的内部表示方式，避免了对 RawSQL 对象的不必要序列化
2. 优化了 ORDER BY 子句的生成逻辑，直接处理 RawSQL 表达式而不是尝试序列化
3. 确保排序字段能够正确引用注解结果

最佳实践

为了避免类似问题，开发者在使用 Tortoise-ORM 时应注意：

1. 对于复杂的查询操作，建议先测试生成的 SQL 语句
2. 使用注解时，确保注解表达式与排序字段匹配
3. 保持 Tortoise-ORM 和 PyPika 依赖的最新版本

总结

这个问题的解决展示了 Tortoise-ORM 社区对用户体验的重视。通过及时识别和修复这类边界情况，框架的稳定性和可用性得到了进一步提升。开发者现在可以放心地使用 RawSQL 注解配合排序功能，构建更灵活的数据查询。