如何在.NET中记录已应用参数的QueryDefinition？

当使用Microsoft.Azure.Cosmos包的QueryDefinition创建参数化查询后，该类并没有提供直接获取替换参数后完整SQL的内置方法（因为Cosmos DB实际执行时是参数化传递，而非直接拼接字符串）。如果需要将替换后的SQL输出到控制台用于日志或调试，可以自行实现一个扩展方法来完成参数替换。

实现扩展方法 #

创建一个静态扩展类，遍历QueryDefinition的参数并替换SQL模板中的占位符：

public static class QueryDefinitionExtensions
{
    public static string ToSqlString(this QueryDefinition queryDefinition)
    {
        var sqlTemplate = queryDefinition.QueryText;
        foreach (var param in queryDefinition.GetParameters())
        {
            string formattedValue;
            // 根据参数类型处理值的格式，适配Cosmos SQL语法
            switch (param.Value)
            {
                case string str:
                    // 转义字符串中的单引号，避免SQL语法错误
                    formattedValue = $"'{str.Replace("'", "''")}'";
                    break;
                case bool b:
                    formattedValue = b ? "true" : "false";
                    break;
                case null:
                    formattedValue = "null";
                    break;
                default:
                    formattedValue = param.Value.ToString();
                    break;
            }
            // 替换SQL模板中的参数占位符
            sqlTemplate = sqlTemplate.Replace(param.Name, formattedValue);
        }
        return sqlTemplate;
    }
}

使用示例 #

调用扩展方法即可得到替换参数后的SQL字符串：

QueryDefinition query = new QueryDefinition(
    "select * from t where t.Account = @account")
    .WithParameter("@account", 12345);

string queryWithParameters = query.ToSqlString();
Console.WriteLine(queryWithParameters);

执行后控制台会输出：select * from t where t.Account = 12345

注意事项 #

• 上述扩展方法仅处理了基础数据类型，对于嵌套对象、数组等复杂参数，需要额外添加类型判断和格式化逻辑。
• 字符串替换是简单的文本匹配，如果SQL模板中存在与参数名相同的普通字符串（非参数占位符），会被误替换，建议遵循参数命名规范（比如统一使用@前缀）避免此类问题。
• 该方法仅用于日志或调试，不要将拼接后的SQL直接用于执行，参数化查询本身才是防止SQL注入的安全方式。

内容的提问来源于stack exchange，提问作者Kaarlo Räihä