使用AWS DynamoDBDocumentClient处理复杂对象编解码时报错

你遇到的核心问题是：DynamoDBDocumentClient 默认无法识别类实例（带有原型链的对象），直接传入会触发序列化错误；开启 convertClassInstanceToMap=true 后，虽然能完成序列化，但会把类实例转成无原型的普通 JSON 对象，导致从数据库读取后无法直接恢复为原类实例，需要手动处理，这就是你觉得繁琐的原因。

这里提供两种实用方案，按需选择：

方案1：序列化前将类实例转为普通对象 #

在存入数据库前，手动把类实例转换为纯数据对象，无需开启 convertClassInstanceToMap，从数据库读取后也能更方便地恢复实例。

实现方式 #

• 利用 JSON.parse(JSON.stringify(instance)) 快速转换（适合简单类）：

const createEntity = async (instance: ComplexEntityType): Promise<ComplexEntityType> => {
    const client = getClient();
    // 将类实例转为无原型的普通对象
    const plainData = JSON.parse(JSON.stringify(instance));
    try {
        await client.send(
            new PutCommand({
                TableName: 'TableName',
                Item: {
                    PK: instance.pk,
                    SK: instance.sk,
                    ...plainData, // 展开属性，避免嵌套整个instance对象
                },
            }),
        );
    } catch (error) {
        console.log(error);
        throw error;
    }

    return instance;
};

• 自定义类的 toJSON 方法（适合复杂类，精准控制序列化逻辑）：

class ComplexEntityType {
    pk: string;
    sk: string;
    nestedInstance: NestedClass;

    // 自定义序列化规则
    toJSON() {
        return {
            pk: this.pk,
            sk: this.sk,
            nestedInstance: this.nestedInstance.toJSON() // 调用嵌套类的toJSON
        };
    }
}

class NestedClass {
    prop1: string;
    prop2: number;

    toJSON() {
        return { prop1: this.prop1, prop2: this.prop2 };
    }
}

之后直接用 JSON.stringify(instance) 就能得到干净的普通对象，marshall 时不会报错。

方案2：自定义unmarshall转换逻辑 #

如果必须开启 convertClassInstanceToMap，可以封装转换函数，把读取后的普通对象恢复为类实例。

实现方式 #

// 封装转换函数
function restoreComplexEntity(plainObj: any): ComplexEntityType {
    const entity = new ComplexEntityType();
    entity.pk = plainObj.pk;
    entity.sk = plainObj.sk;
    // 手动恢复嵌套类实例
    entity.nestedInstance = new NestedClass(plainObj.nestedInstance.prop1, plainObj.nestedInstance.prop2);
    // 其他属性依次赋值
    return entity;
}

// 查询后使用
const getEntity = async (pk: string, sk: string): Promise<ComplexEntityType | null> => {
    const client = getClient();
    const result = await client.send(new GetCommand({
        TableName: 'TableName',
        Key: { PK: pk, SK: sk }
    }));
    return result.Item ? restoreComplexEntity(result.Item) : null;
};

也可以把转换逻辑写到类的静态方法中，更符合面向对象风格：

class ComplexEntityType {
    static fromPlainObject(plainObj: any): ComplexEntityType {
        const entity = new ComplexEntityType();
        entity.pk = plainObj.pk;
        entity.sk = plainObj.sk;
        entity.nestedInstance = NestedClass.fromPlainObject(plainObj.nestedInstance);
        return entity;
    }
}

• 不要在 Item 中嵌套整个 instance 对象，应该把实例的属性展开到 Item 中，这更符合 DynamoDB 的扁平存储结构，也能避免不必要的嵌套层级问题。
• 类的方法不会被序列化到数据库（JSON 仅处理数据属性），所以恢复实例后，方法会自动通过原型链继承，无需额外处理。

内容的提问来源于stack exchange，提问作者LioRz