Spring Data MongoDB如何实现带可选空参数的文档查询

在Spring Data MongoDB中，直接通过方法名定义的查询会将NULL参数作为"值为NULL"的条件查询，而不是忽略该参数。下面是几种可行的解决方案：

方法一：使用Example查询（推荐简单场景） #

通过Example API可以自动忽略实体中值为NULL的属性，仅用非NULL属性作为查询条件。

首先确保仓库接口继承QueryByExampleExecutor：

public interface MyRepo extends MongoRepository<User, String>, QueryByExampleExecutor<User> {
}

调用时构建查询示例对象，仅设置非NULL的参数：

// 初始化示例对象，仅填充非NULL的查询参数
User exampleUser = new User();
exampleUser.setParam1("abc");
exampleUser.setParam2("def");
// param3为NULL时不设置，会自动忽略该条件

// 创建Example实例并执行查询
Example<User> queryExample = Example.of(exampleUser);
List<User> result = myRepo.findAll(queryExample);

方法二：自定义@Query结合SpEL表达式 #

通过Spring表达式语言（SpEL）在查询语句中动态判断参数是否为NULL，仅当参数非空时添加对应条件。

修改仓库方法如下：

public interface MyRepo extends MongoRepository<User, String> {
    @Query("{$and: [" +
            "?0 != null ? {param1: ?0} : {}, " +
            "?1 != null ? {param2: ?1} : {}, " +
            "?2 != null ? {param3: ?2} : {}" +
            "]}")
    List<User> getByParams(String param1, String param2, String param3);
}

调用时直接传入参数，NULL参数对应的条件会被自动忽略：

List<User> result = myRepo.getByParams("abc", "def", null);

方法三：使用MongoTemplate手动构建查询 #

如果需要更高的灵活性（比如复杂查询逻辑），可以直接使用MongoTemplate手动拼接查询条件：

先注入MongoTemplate：

@Autowired
private MongoTemplate mongoTemplate;

编写自定义查询方法：

public List<User> queryUsers(String param1, String param2, String param3) {
    Query query = new Query();
    
    // 仅当参数非NULL时添加查询条件
    if (param1 != null) {
        query.addCriteria(Criteria.where("param1").is(param1));
    }
    if (param2 != null) {
        query.addCriteria(Criteria.where("param2").is(param2));
    }
    if (param3 != null) {
        query.addCriteria(Criteria.where("param3").is(param3));
    }
    
    return mongoTemplate.find(query, User.class);
}

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