DynamoDB查询报The provided key element does not match the schema错误如何解决

错误根因 #

ValidationException: The provided key element does not match the schema 报错的核心是请求传入的主键字段名、类型、数量和DynamoDB表定义的schema不匹配，你的代码里存在三处明确问题：

• 混用了DynamoDB两种客户端的传参格式：getUser方法里的Key写法'id': {S: userId}是原生底层客户端的格式，需要明确指定数据类型；validateUsername方法里的Key写法'id': username.toLowerCase()是DocumentClient的格式，会自动推断类型，两种格式不统一就会触发schema校验失败。
• validateUsername方法逻辑错误：你要按用户名查询，但传的主键还是id字段，如果用户名没有存在id字段里，直接用get接口查询本身就不符合表结构要求。
• 未确认表的主键结构：如果你的表除了分区键还设置了排序键，get操作必须同时传入分区键+排序键两个值，缺少任意一个也会触发该报错。

修复方案 #

1. 统一DynamoDB客户端传参格式 #

首先确认你初始化的客户端类型，全量统一传参格式：

• 如果你用的是原生AWS.DynamoDB客户端，两个方法的Key都要带类型标识：

Key: {
  'id': { S: userId } // 字符串类型用S，数字用N，布尔用B
}

• 如果你用的是更简便的AWS.DynamoDB.DocumentClient客户端，两个方法的Key都不需要带类型标识：

Key: {
  'id': userId
}

2. 修复用户名查询逻辑 #

get接口只能按主键查询，如果你要按用户名查询，需要先给username字段创建全局二级索引（GSI），再用query接口查询，示例代码如下：

// GET USER BY USERNAME
async function validateUsername(username) {
    console.log(username)
    const params = {
        TableName: DYNAMO_DB_TABLE_NAME,
        IndexName: 'username-index', // 替换为你实际创建的GSI名称
        KeyConditionExpression: '#username = :usernameVal',
        ExpressionAttributeNames: { '#username': 'username' },
        ExpressionAttributeValues: { ':usernameVal': username.toLowerCase() }
    };
    console.log(params);
    return await DYNAMO_DB.query(params).promise()
    .then((response) => {
        return generateUserResponse(response.Items.length > 0, true);
    }, (error) => {
        console.error(error);
        return generateUserResponse(null, false);
    })
}

3. 核对表结构 #

登录DynamoDB控制台确认你的表主键配置：

• 确认分区键名称是否为id，类型是否为字符串
• 如果存在排序键，所有get操作的Key字段里必须同时传入分区键和排序键的键值对

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