如何转义 OData 查询中使用的单引号？

Question

我正在使用 OData 查询我的数据库。当“adapterName”仅包含文本时，以下代码行可以正常工作。

ds.query('/DataAdapters?$filter=Name eq \'' + adapterName + '\'', ifmgr_CreateAdapter_Step1, onGenericFailure, '');

如果“adapterName”包含单引号，则会失败。我尝试使用以下代码转义单引号：

adapterName = adapterName.replace(/\'/g, '\\\'');

尽管这正确地转义了用户定义的文本，但该函数仍然失败。谁能告诉我查询中文本的正确格式是什么？

Answer 1

实际上 %27 不是一个解决方案。正确的转义方法是在字符串中放置两个单引号，而不是一个。
在示例中“o''clock”

Answer 2

我想稍微扩展一下答案，以便它也适用于调用 oData 服务操作操作。发布的答案是正确的，但是服务操作的参数必须按照特定的顺序进行编码。

oData 服务操作接收原始类型参数，其中字符串包含在 ' 中，这样有效的 url（预编码）将是这样的

AddString?value='o''clock'

这将导致服务器看到

AddString?value='o '

和

'clock'

将产生“错误请求 - 查询语法错误”。

要纠正此问题，您必须在插入 url 之前对 ' 进行双重转义并对其进行 UrlEncode。

不要对 url 本身进行 UrlEncode。

这是一个可行的示例。

// value passed as "o'clock"
public async Task AddString(string value)
{
    // Escape ' with '' and UrlEncode value
    value = HttpUtility.UrlEncode(value.Replace("'", "''"));

    string url = String.Format("AddString?value='{0}'", value);

    // No need to UrlEncode url here as dynamic content has already been escaped 

    // Execute .....
}

[WebGet]
public void AddString(string value) 
{
    // here value will be "o'clock"
}

Answer 3

它实际上在 oData 文档中进行了描述： http://docs.oasis-open.org/odata/odata/v4.01/cs01/part2-url-conventions/odata-v4.01-cs01- part2-url-conventions.html#sec_URLComponents

例如，这些规则之一是字符串文字中的单引号表示为两个连续的单引号。

示例 3：有效的 OData URL：

http://host/service/People('O''Neil')

http://host/service/People(%27O%27%27Neil) %27)

http://host/service/People%28%27O% 27%27尼尔%27%29

http://host/service/Categories('Sm​​artphone%2FTablet')

示例 4：无效的 OData URL：

http://host/service/People('O'Neil')

http://host/service/People('O%27Neil')

http://host/service/Categories('智能手机/平板电脑')

第一个和第二个示例无效，因为字符串中的单引号 >文字必须表示为两个连续的单引号。第三个示例无效，因为正斜杠被解释为路径段分隔符和类别（“智能手机不是有效的 OData 路径段，平板电脑也不是”）。

Answer 4

当使用 wit substringof 时，需要使用 4 个而不是 1 个撇号来转义：


a'b->
$filter=(substringof('a'''b', FirstName))


Answer 5

我没有使用 $filter=Title eq 'text'，而是

使用 oDatastartswith() 函数。

$filter=startswith(Title, key)

然后我传入尽可能多的 key 。

var pos = key.indexOf("'");
if(pos > -1) {
key = key.substring(0, pos);
<代码>}