AWS Lambda Powertools Python 中 Logger 自定义 JSON 序列化器的异常处理

在 AWS Lambda Powertools Python 库中，Logger 组件提供了强大的日志记录功能，但当开发者尝试使用自定义 JSON 序列化器处理异常时，可能会遇到一些意料之外的行为。本文将深入探讨这一现象及其解决方案。

问题背景

当开发者使用 Python 标准库中的 json.dumps 作为 Logger 的 JSON 序列化器时，如果尝试记录自定义异常类，会遇到 TypeError 错误，提示异常对象无法被 JSON 序列化。这与开发者预期的行为不符，特别是当他们习惯了 Powertools 默认提供的异常处理能力时。

技术原理

AWS Lambda Powertools 的 Logger 组件在默认情况下能够自动处理异常对象的序列化，这是因为其内部实现已经包含了将异常转换为字典形式的逻辑。然而，当开发者显式指定使用 json.dumps 作为序列化器时，这一默认处理机制就被覆盖了。

Python 的 json 模块只能序列化基本数据类型（如字符串、数字、列表、字典等），对于自定义异常类这样的复杂对象，json.dumps 无法直接处理，因为它不知道如何将这些对象转换为 JSON 可表示的形式。

解决方案

要解决这个问题，开发者有以下几种选择：

1. 使用 Powertools 默认序列化器：这是最简单的解决方案，适用于大多数场景。Powertools 的默认序列化器已经内置了对异常对象的处理能力。

2. 实现自定义 JSON 编码器：如果需要特定的序列化行为，可以创建一个继承自 json.JSONEncoder 的子类，并覆盖其 default 方法，添加对异常对象的处理逻辑。

class CustomJSONEncoder(json.JSONEncoder):
    def default(self, obj):
        if isinstance(obj, BaseException):
            return {
                'type': type(obj).__name__,
                'message': str(obj),
                'traceback': traceback.format_exc()
            }
        return super().default(obj)

3. 创建自定义序列化函数：基于自定义编码器构建一个序列化函数，然后将其传递给 Logger。

def custom_json_serializer(obj):
    return json.dumps(obj, cls=CustomJSONEncoder)

logger = Logger(json_serializer=custom_json_serializer)

最佳实践

在实际开发中，建议：

1. 优先使用 Powertools 提供的默认序列化器，除非有特殊需求。
2. 如果需要自定义序列化行为，确保全面考虑所有可能的数据类型，包括异常对象。
3. 在自定义序列化器中，为异常对象提供足够的信息（如类型、消息和堆栈跟踪），以便于调试。
4. 考虑使用 Python 的 dataclasses 或类似的工具来简化复杂对象的序列化过程。

通过理解这些原理和解决方案，开发者可以更有效地利用 AWS Lambda Powertools 的日志功能，同时避免常见的序列化陷阱。