Salesforce Java调用中含单引号Email引发QueryResult格式错误问题

为什么会出现Malformed Query异常？ #

• 用双引号包裹Email：SOQL规定字符串必须用单引号作为边界，双引号在SOQL中仅用于引用字段别名或特定语法场景，直接用双引号包裹Email会触发语法错误。
• 反斜杠转义单引号：SOQL不支持反斜杠作为转义符，只有两个连续单引号才是合法的单引号转义方式，用\'只会被当成普通字符，导致查询字符串语法断裂。
• 替换双单引号但未正确应用：你可能只是想到了这个方法，但代码里直接用String.format拼接原始Email，没先对Email做替换处理，导致转义操作根本没生效。

正确处理方法 #

方法1：使用绑定变量（推荐，安全且无需手动转义） #

Salesforce API支持绑定变量，能自动处理特殊字符，还能防范SOQL注入风险，代码修改如下：

public String contactSearch(String email){
    String request = "select Id from Contact where Email = :emailVar";
    // 创建绑定变量映射
    Map<String, Object> bindings = new HashMap<>();
    bindings.put("emailVar", email);
    
    final QueryResult queryResult = withTry(r -> connection().queryWithBinds(r, bindings), request, errMsg);

    if (!queryResult.isDone()) {
        throw new IllegalStateException(err);
    }

    return queryResult.getRecords().length == 0 ? null : queryResult.getRecords()[0].getId();
}

注：queryWithBinds是Salesforce Connector中支持绑定变量的查询方法，不同Salesforce API客户端可能有细微差异，核心逻辑是用绑定变量替代直接字符串拼接。

方法2：手动转义单引号（仅当无法使用绑定变量时） #

如果必须用字符串拼接，先把Email中的单引号替换为两个单引号，再传入String.format：

public String contactSearch(String email){
    // 转义单引号：把'替换为''
    String escapedEmail = email.replace("'", "''");
    String request = String.format(
                "select Id from Contact where Email = '%s'",
                escapedEmail
        );

    final QueryResult queryResult = withTry(r -> connection().query(r), request, errMsg);

    if (!queryResult.isDone()) {
        throw new IllegalStateException(err);
    }

    return queryResult.getRecords().length == 0 ? null : queryResult.getRecords()[0].getId();
}

该方法会将Prash.O'Brian@testdomain.com转成Prash.O''Brian@testdomain.com，完全符合SOQL的语法要求。

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