Sanic框架中datetime对象的JSON序列化问题解析

在Python的Sanic框架开发过程中，开发者经常会遇到需要将包含datetime类型数据的对象序列化为JSON格式返回给客户端的情况。然而，Sanic默认的JSON序列化器并不能直接处理datetime对象，这会导致TypeError异常。

问题本质

JSON规范本身只支持以下几种数据类型作为值：

• 数字（整数和浮点数）
• 字符串
• 数组
• 布尔值
• null
• JSON对象

datetime对象不属于上述任何一类，因此需要开发者自行决定如何将其转换为JSON兼容的格式。这种设计是合理的，因为datetime可以转换为多种格式（如时间戳、ISO格式字符串、自定义格式字符串等），框架不应该强制使用某一种特定格式。

解决方案

1. 针对单个路由的解决方案

对于只需要在特定路由中处理datetime序列化的情况，可以在response.json()方法中传入自定义的default处理器：

from datetime import datetime, date

def datetime_to_json_formatting(o):
    if isinstance(o, (date, datetime)):
        return o.strftime('%Y%m%d %H%M%S')

@app.get("/example")
async def example(request):
    body = {'time': datetime.now(), 'body': 'string'}
    return response.json(body, default=datetime_to_json_formatting)

这种方法灵活且不影响其他路由，适合只在少数地方需要处理datetime序列化的场景。

2. 全局解决方案

如果项目中大量路由都需要处理datetime序列化，可以创建自定义的JSON序列化器并应用到整个Sanic应用：

import functools
from datetime import datetime, date

def datetime_to_json_formatting(o):
    if isinstance(o, (date, datetime)):
        return o.strftime('%Y%m%d %H%M%S')

custom_dumps = functools.partial(ujson.dumps, default=datetime_to_json_formatting)

app = Sanic("app", dumps=custom_dumps)

这种方法确保了整个应用中的所有JSON响应都能正确处理datetime对象，避免了重复代码。

最佳实践建议

1. 格式一致性：在整个项目中保持datetime转换格式的一致性，建议使用ISO 8601格式（如'%Y-%m-%dT%H:%M:%S'）以便前端处理。

2. 时区处理：明确时区处理策略，建议存储和传输UTC时间，在前端显示时再转换为本地时间。

3. 性能考虑：对于高频接口，自定义序列化函数的性能会影响整体响应时间，应进行适当的性能测试。

4. 扩展性：自定义的default处理器可以扩展以处理其他非JSON原生类型，如Decimal、UUID等。