Azure 表存储 RowKey 受限字符模式？

Question

Azure TableStorage RowKeys 中是否存在受限字符模式？我无法通过多次搜索找到任何记录。但是，在某些性能测试中，我得到的行为暗示了这种情况。

RowKeys 包含随机字符时出现了一些奇怪的行为（测试驱动程序确实阻止了受限字符 (/ \ # ?) 以及阻止单引号出现在 RowKey 中）。结果是我有一个 RowKey 可以很好地插入表中，但无法查询（结果是 InvalidInput）。例如：

RowKey: 9}5O0J=5Z,4,D,{!IKPE,~M]%54+9G0ZQ&G34!G+

尝试通过此 RowKwy（相等）进行查询将导致错误（在我们的应用程序中，使用 Azure Storage Explorer 和 Cloud Storage Studio 2）。我查看了通过 Fiddler 发送的请求：

GET /foo()?$filter=RowKey%20eq%20'9%7D5O0J=5Z,4,D,%7B!IKPE,~M%5D%54+9G0ZQ&G34!G+' HTTP/1.1

RowKey 中的 %54 似乎没有在过滤器中转义。有趣的是，对于使用包含此 RowKey 的批处理 XML 中的 URI 对表存储的批处理请求，我得到了类似的行为。我也看到了带有嵌入双引号的 RowKeys 的类似行为，尽管我还没有隔离这种模式。

有人遇到过这种行为吗？我可以轻松地限制其他字符出现在 RowKeys 中，但我真的很想知道“规则”。

Answer 1

PartitionKey 和 RowKey 字段中不允许使用以下字符：

• 正斜杠 (/) 字符
• 反斜杠 (\) 字符
• 数字符号 (#) 字符
• 问号 (?) 字符

延伸阅读：Azure Docs > Understanding the Table service data model

Answer 2

我使用这个函数转换密钥：

private static string EncodeKey(string key)
{
    return HttpUtility.UrlEncode(key);
}

这需要为插入和检索完成。

Answer 3

public static readonly Regex DisallowedCharsInTableKeys = new Regex(@"[\\\\#%+/?\u0000-\u001F\u007F-\u009F]");

检测无效的表分区和行键：

bool invalidKey = DisallowedCharsInTableKeys.IsMatch(tableKey);

清理无效的分区或行键：

string sanitizedKey = DisallowedCharsInTableKeys.Replace(tableKey, disallowedCharReplacement);

在此阶段，您可能还希望在已清理的键（分区键或行键）前加上原始键的哈希值，以避免具有相同已清理值的不同无效键的错误冲突。

不要使用 string.GetHashCode()，因为它可能会为同一个字符串产生不同的哈希码，并且不能用于识别唯一性，也不能持久化。

我使用 SHA256：https://msdn.microsoft.com/en-us/library/s02tk69a(v=vs.110).aspx

要创建无效键的字节数组散列，将字节数组转换为十六进制字符串，并在经过清理的表键前加上前缀。

另请参阅相关的 MSDN 文档： https://msdn.microsoft.com/en-us/library/azure/dd179338.aspx

链接中的相关部分： 关键字段中不允许出现的字符

PartitionKey 和 RowKey 属性的值中不允许使用以下字符：

正斜杠 (/) 字符

反斜杠 (\) 字符

数字符号 (#) 字符

问号 (?) 字符

从U+0000到U+001F的控制字符，包括：

• 水平制表符 (\t) 字符

• 换行符（\n）

• 回车 (\r) 字符

控制字符从 U+007F 到 U+009F

请注意，除了 MSDN 文章中提到的字符之外，我还在模式中添加了 % 字符，因为我在一些地方看到人们提到它有问题。我想其中一些还取决于您用于访问表存储的语言和技术。

如果您在案例中检测到其他有问题的字符，则可以将它们添加到正则表达式模式中，无需更改任何其他内容。

Answer 4

我刚刚（艰难地）发现“+”号是允许的，但不能在 PartitionKey 中查询。

Answer 5

我发现除了 Igorek 的回答中列出的字符之外，这些也会导致问题（例如插入会失败）：

• |
• []
• {}
• $^&

使用 Azure Node.js SDK 测试。