本教程将详细介绍如何使用marshmallow序列化库，将模型实例中的字符串id字段（例如`parent_id`）转换为嵌套的json对象结构，如`{“id”: “123-345”}`。文章将探讨两种主要方法：利用`fields.nested`结合`pre_dump`钩子进行预处理，以及通过`fields.method`直接定义序列化逻辑。此外，还将简要提及自定义字段的实现，旨在帮助开发者根据具体需求选择最合适的序列化策略，确保数据输出格式的灵活性与准确性。
在构建API时，我们经常需要对数据进行序列化，以符合特定的JSON输出格式。有时，模型中的某个字段可能只是一个简单的字符串（例如，一个关联对象的ID），但在API响应中，我们希望它以一个嵌套对象的形式呈现，例如{“id”: “value”}。本文将以一个具体的场景为例，演示如何在Marshmallow中实现这种转换。
场景描述
假设我们有一个User模型，其中包含name字段和一个parent字段。parent字段在模型实例中存储为一个字符串，代表父级用户的ID。我们期望在序列化后，parent字段能够以{“id”: “…”}的格式输出。
期望的输出格式：
{ "name": "John", "parent": {"id": "123-345"}}
准备工作
首先，定义一个简单的Python类来模拟我们的模型实例：
import marshmallow as mfrom marshmallow import Schema, fields, pre_dump# 模拟模型类class User: def __init__(self, name, parent_id=None): self.name = name self.parent = parent_id # parent_id 在模型中是一个字符串或None# 创建一个用户实例user_instance = User("John Doe", "123-345")user_without_parent = User("Jane Smith")
解决方案一：使用 fields.Nested 结合 pre_dump 钩子
这是解决此问题的一种巧妙且有效的方法，它利用了Marshmallow的fields.Nested字段和pre_dump钩子。
实现原理
定义一个嵌套Schema (IdSchema)：这个Schema只包含一个id字段，用于表示最终的嵌套结构。在 IdSchema 中使用 pre_dump 钩子：当UserSchema尝试序列化parent字段时，它会将parent的原始值（即字符串ID）传递给IdSchema。pre_dump钩子会在IdSchema的实际字段处理之前被调用，此时data参数就是那个原始的字符串ID。我们可以在pre_dump中将这个字符串ID包装成{“id”: “…”}的字典格式，然后返回。这样，IdSchema的id字段就能正确地从这个新字典中提取值。
代码示例
class IdSchema(Schema): id = fields.String(required=True) @pre_dump def wrap(self, data, **_): """ 在IdSchema处理数据之前，将原始字符串ID包装成字典。 当fields.Nested(IdSchema)接收到'123-345'这样的字符串时， 这个字符串会作为data参数传递给pre_dump。 """ if data is None: return None # 处理parent为None的情况 return {"id": data}class UserSchemaNestedPreDump(Schema): name = fields.String(required=True) # parent字段使用IdSchema进行嵌套序列化 parent = fields.Nested(IdSchema, allow_none=True) # 允许parent字段为None# 序列化并查看结果schema_pre_dump = UserSchemaNestedPreDump()result_with_parent = schema_pre_dump.dump(user_instance)print("--- Solution 1 (Nested with pre_dump) ---")print("With parent:", result_with_parent)result_without_parent = schema_pre_dump.dump(user_without_parent)print("Without parent:", result_without_parent)
输出：
--- Solution 1 (Nested with pre_dump) ---With parent: {'name': 'John Doe', 'parent': {'id': '123-345'}}Without parent: {'name': 'Jane Smith', 'parent': None}
优点与注意事项
优点：结构清晰，IdSchema可以复用于其他需要将ID包装成{“id”: “…”}格式的场景。注意事项：pre_dump钩子在嵌套Schema中接收的是原始值，这与在主Schema中接收整个对象有所不同。理解这一点对于正确使用pre_dump至关重要。同时，要确保处理None值，以避免序列化失败。
解决方案二：使用 fields.Method
fields.Method提供了一种更直接的方式来定义字段的序列化逻辑，它允许你指定一个方法来处理特定字段的输出。
怪兽AI数字人
数字人短视频创作，数字人直播，实时驱动数字人
44 查看详情 
实现原理
在主Schema中定义一个方法：这个方法接收模型实例作为参数，并返回该字段的最终序列化结果。fields.Method 引用该方法：parent字段直接调用这个方法来生成其序列化后的值。
代码示例
class UserSchemaMethodField(Schema): name = fields.String(required=True) # parent字段通过get_parent_id_wrapped方法进行序列化 parent = fields.Method("get_parent_id_wrapped", allow_none=True) def get_parent_id_wrapped(self, obj): """ 根据模型实例的parent属性，返回包装后的字典。 obj参数是当前的User模型实例。 """ if obj.parent is None: return None return {"id": obj.parent}# 序列化并查看结果schema_method_field = UserSchemaMethodField()result_with_parent_method = schema_method_field.dump(user_instance)print("n--- Solution 2 (Method Field) ---")print("With parent:", result_with_parent_method)result_without_parent_method = schema_method_field.dump(user_without_parent)print("Without parent:", result_without_parent_method)
输出：
--- Solution 2 (Method Field) ---With parent: {'name': 'John Doe', 'parent': {'id': '123-345'}}Without parent: {'name': 'Jane Smith', 'parent': None}
优点与注意事项
优点：逻辑非常直观和明确，易于理解和维护。可以直接访问模型实例的任何属性。注意事项：如果这种包装逻辑需要在多个Schema中复用，每次都定义一个fields.Method可能会导致代码重复。
解决方案三：创建自定义字段 (进阶/可复用)
对于更复杂的或需要在多个地方复用的序列化逻辑，创建自定义字段是最佳选择。
实现原理
继承marshmallow.fields.Field并重写其_serialize方法。_serialize方法负责将原始值转换为序列化后的值。
代码示例
class WrappedIdField(fields.Field): def _serialize(self, value, attr, obj, **kwargs): """ 将原始值（value）包装成{"id": value}的格式。 value是模型实例中对应属性的原始值。 """ if value is None: return None return {"id": str(value)} # 确保value是字符串类型class UserSchemaCustomField(Schema): name = fields.String(required=True) # parent字段使用自定义的WrappedIdField parent = WrappedIdField(attribute="parent", allow_none=True) # attribute指定模型实例的哪个属性被序列化# 序列化并查看结果schema_custom_field = UserSchemaCustomField()result_with_parent_custom = schema_custom_field.dump(user_instance)print("n--- Solution 3 (Custom Field) ---")print("With parent:", result_with_parent_custom)result_without_parent_custom = schema_custom_field.dump(user_without_parent)print("Without parent:", result_without_parent_custom)
输出：
--- Solution 3 (Custom Field) ---With parent: {'name': 'John Doe', 'parent': {'id': '123-345'}}Without parent: {'name': 'Jane Smith', 'parent': None}
优点与注意事项
优点：高度可复用，可以将复杂的序列化逻辑封装在一个独立的字段类中，提高代码的模块化和可维护性。注意事项：相对于前两种方法，创建自定义字段的初期投入略大，适用于需要频繁复用相同转换逻辑的场景。
总结与选择建议
Marshmallow提供了多种灵活的方式来处理数据序列化，即使是看似简单的字符串包装成嵌套对象的需求，也有多种实现路径。
fields.Nested + pre_dump：适用于嵌套结构简单且原始值可以直接作为嵌套Schema的输入的情况。它的优点是能够复用一个小的Schema来定义嵌套结构，但需要理解pre_dump在嵌套字段中的行为。fields.Method：如果序列化逻辑相对简单，且不需要在多个Schema中复用，或者需要直接访问整个模型实例的多个属性来构建字段值，fields.Method是最直接和易于理解的选择。自定义字段 (fields.Field 子类)：当序列化逻辑复杂、需要在多个Schema或项目中复用，或者需要更精细的控制（例如，反序列化行为）时，创建自定义字段是最佳实践。它提供了最高的灵活性和可维护性。
在实际开发中，开发者应根据具体场景的复杂性、复用需求和团队偏好，选择最合适的Marshmallow序列化策略。无论选择哪种方法，清晰的代码结构和对None值的妥善处理都是确保API健壮性的关键。
以上就是Marshmallow 教程：实现字符串字段到嵌套字典的优雅序列化的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/571297.html
微信扫一扫 
支付宝扫一扫 
