如何在C#中实现通过二级索引哈希键查询DynamoDB的高阶方法

惯用实现说明 #

AWS官方提供的IDynamoDbContext高阶API确实没有内置二级索引的Load类方法，社区通用做法是基于内置的QueryAsync接口做轻量封装，通过反射读取模型上的索引特性元数据，屏蔽索引名、键条件构造等底层细节。

LoadBySecondaryKeyAsync<TItem> 实现示例 #

首先需要先缓存模型的索引元数据避免重复反射损耗，简化实现代码如下：

public async Task<IEnumerable<TItem>> LoadBySecondaryKeyAsync<TItem>(object secondaryHashKey, object secondaryRangeKey = null)
    where TItem : class
{
    // 生产环境建议将索引元数据提前缓存，此处简化实现直接反射仅做示例
    var gsiHashProperties = typeof(TItem).GetProperties()
        .Where(p => Attribute.IsDefined(p, typeof(DynamoDBGlobalSecondaryIndexHashKeyAttribute)))
        .Select(p => new {
            Property = p,
            IndexNames = p.GetCustomAttribute<DynamoDBGlobalSecondaryIndexHashKeyAttribute>().IndexNames
        }).ToList();

    if (!gsiHashProperties.Any())
    {
        throw new InvalidOperationException($"类型{typeof(TItem).Name}未标记任何二级索引哈希键");
    }

    // 取第一个匹配的GSI，可根据实际需求扩展指定索引的重载
    var targetGsi = gsiHashProperties.First();
    var indexName = targetGsi.IndexNames.First();

    var queryConfig = new QueryOperationConfig
    {
        IndexName = indexName,
        KeyExpression = new Expression
        {
            ExpressionStatement = $"{targetGsi.Property.Name} = :hashKey" + (secondaryRangeKey != null ? " AND #rangeKey = :rangeKey" : ""),
            ExpressionAttributeValues = new Dictionary<string, AttributeValue>
            {
                {":hashKey", AttributeValueHelper.ToAttributeValue(secondaryHashKey)}
            }
        }
    };

    if (secondaryRangeKey != null)
    {
        queryConfig.KeyExpression.ExpressionAttributeNames["#rangeKey"] = 
            typeof(TItem).GetProperties().First(p => 
                Attribute.IsDefined(p, typeof(DynamoDBGlobalSecondaryIndexRangeKeyAttribute)) 
                && p.GetCustomAttribute<DynamoDBGlobalSecondaryIndexRangeKeyAttribute>().IndexNames.Contains(indexName)
            ).Name;
        queryConfig.KeyExpression.ExpressionAttributeValues[":rangeKey"] = AttributeValueHelper.ToAttributeValue(secondaryRangeKey);
    }

    var search = _dynamoDbContext.FromQueryAsync<TItem>(queryConfig);
    var results = new List<TItem>();
    while (!search.IsDone)
    {
        results.AddRange(await search.GetNextSetAsync());
    }
    return results;
}

注：上述代码中的AttributeValueHelper可直接使用AWS SDK内置的转换逻辑，也可以根据自身项目的序列化规则自定义。

索引名相关问题说明 #

1. 索引名没有系统默认值，必须和你创建DynamoDB表时定义的GSI名称完全一致，这类配置推荐统一在模型的特性上标记，不要分散在业务代码中硬编码维护。
2. DynamoDBGlobalSecondaryIndexHashKey特性的IndexName参数非必填的原因是：如果一个字段仅作为单个GSI的哈希键，SDK内部会自动匹配关联，不需要显式指定索引名；支持传入多个值是为了兼容同一个字段作为多个GSI的哈希键的场景，例如两个不同的GSI使用同一个字段做分区键，仅排序键不同，就可以传入多个索引名关联同一个字段。

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