.NET中接收MongoDB风格动态查询并解析为BsonDocument/Filter的方案咨询

核心思路 #

利用MongoDB .NET驱动原生对BSON语法的支持，直接解析URL中传入的类MongoDB查询字符串，转换为驱动可识别的查询条件，无需手动映射复杂的查询操作符（如$eq、$gt等）。

具体实现步骤 #

1. 接口参数接收与解码

GET请求的QueryString中，filter参数的特殊字符（如大括号、冒号）可能被URL编码，ASP.NET Core会自动解码HttpContext.Request.Query中的参数值，直接取用即可。

2. 解析类MongoDB查询字符串为BsonDocument

MongoDB .NET驱动的BsonDocument.Parse()方法原生支持类JSON的语法（包括无引号的键名），完美匹配你需要的查询格式。

3. 转换BsonDocument为FilterDefinition

将解析后的BsonDocument直接转换为对应实体类型的FilterDefinition<T>，即可用于MongoDB的查询操作。

完整代码示例 #

假设你的实体类为Entity，接口实现如下：

using Microsoft.AspNetCore.Mvc;
using MongoDB.Driver;
using MongoDB.Bson;

[ApiController]
[Route("[controller]")]
public class EntitiesController : ControllerBase
{
    private readonly IMongoCollection<Entity> _entitiesCollection;

    // 构造函数注入MongoDB集合
    public EntitiesController(IMongoDatabase database)
    {
        _entitiesCollection = database.GetCollection<Entity>("entities");
    }

    [HttpGet]
    public async Task<IActionResult> GetEntities([FromQuery] string filter)
    {
        // 处理空filter的情况
        if (string.IsNullOrWhiteSpace(filter))
        {
            var allEntities = await _entitiesCollection.Find(_ => true).ToListAsync();
            return Ok(allEntities);
        }

        try
        {
            // 解析filter字符串为BsonDocument
            var filterDoc = BsonDocument.Parse(filter);
            // 转换为FilterDefinition<Entity>
            var mongoFilter = new BsonDocumentFilterDefinition<Entity>(filterDoc);
            
            // 执行查询
            var entities = await _entitiesCollection.Find(mongoFilter).ToListAsync();
            return Ok(entities);
        }
        catch (BsonSerializationException ex)
        {
            // 处理非法的查询语法
            return BadRequest($"无效的筛选条件: {ex.Message}");
        }
        catch (Exception ex)
        {
            return StatusCode(500, $"查询失败: {ex.Message}");
        }
    }
}

// 示例实体类
public class Entity
{
    public ObjectId Id { get; set; }
    // 其他业务属性...
}

关键注意事项 #

• 语法兼容性：BsonDocument.Parse()完全支持MongoDB的所有查询操作符（如$eq、$gt、$in、$and等），直接使用MongoDB原生语法即可，无需额外适配。
• URL编码问题：前端传入filter参数时，若包含空格、&等特殊字符，需确保正确进行URL编码，ASP.NET Core会自动完成解码。
• 安全性：动态查询存在注入风险，建议：
  • 校验BsonDocument中的字段，只允许查询实体类已定义的字段
  • 拦截禁用高危操作符（如$where）
  • 添加请求频率限制，抵御恶意请求
• 异常处理：必须捕获BsonSerializationException来处理非法查询语法，返回友好的错误提示。

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