MongoRepository@Meta注解maxExecutionTimeMs超时无效及全局配置咨询

一、@Meta注解不生效的原因 #

在Spring Data MongoDB 3.0.0.RELEASE版本中，@Meta(maxExecutionTimeMs)仅对自动派生的查询方法（如findByTenantIdAndProductKey这类基于方法名生成的查询）生效，不会作用于@Aggregation注解定义的聚合查询。这是因为该版本的注解处理器并未将@Meta的超时配置传递到聚合操作的构建逻辑中，所以你设置的1ms超时不会被MongoDB服务器应用。

二、针对单个聚合查询的修复方案 #

要让超时限制生效，你可以直接在聚合管道的第一个阶段添加$maxTimeMS操作符，MongoDB会将这个超时限制应用到整个聚合流程：

@Aggregation({
    "{ $maxTimeMS: 1 }", // 必须放在管道第一个位置
    "{ $match : { $and :  [" +
    "   {'tenantId' :  ?0, 'productKey' :  ?1 }, " +
    "   { $or : [" +
    "       {'phoneNumber' :           {$in :  ?2}},",
    "       {'secondaryPhoneNumber' :  {$in :  ?2}},",
    "   ] }" +
    "] } }",
    "{ $sort : { 'updated' : -1 } }"
})
List<PII> getPiiByTenantProductAnyPhone(UUID tenantId, ProductKey productKey, String... phone);

注意：$maxTimeMS必须是聚合管道的第一个阶段，否则MongoDB不会识别这个超时设置。

三、全局配置方案（无需修改每个查询） #

如果你希望所有聚合查询都自动应用超时限制，无需逐个修改注解，可以通过以下两种方式实现：

1. 自定义MongoTemplate设置默认超时 #

Spring Data Repository默认使用MongoTemplate执行操作，你可以通过配置自定义MongoTemplate，设置全局默认的查询超时：

@Configuration
public class MongoConfig extends AbstractMongoClientConfiguration {

    @Value("${spring.data.mongodb.uri}")
    private String mongoUri;

    @Override
    protected String getDatabaseName() {
        return MongoClientURI.create(mongoUri).getDatabase();
    }

    @Override
    public MongoClient mongoClient() {
        return MongoClients.create(mongoUri);
    }

    @Override
    public MongoTemplate mongoTemplate() throws Exception {
        MongoTemplate template = super.mongoTemplate();
        // 设置全局默认超时（单位：毫秒），所有通过该Template执行的聚合/查询都会继承
        template.setDefaultMaxTime(5000); 
        return template;
    }
}

这个配置会让所有通过MongoTemplate执行的操作（包括@Aggregation注解生成的聚合查询）自动带上maxTimeMS限制，无需修改现有Repository方法。

2. 自定义Repository基类统一处理聚合超时 #

如果需要更灵活的控制，可以自定义一个Repository基类，让所有业务Repository继承它，在基类中统一为聚合查询添加超时配置：

public interface CustomAggregationRepository<T, ID> extends MongoRepository<T, ID> {

    default <O> List<O> runAggregation(Aggregation aggregation, Class<O> outputType) {
        // 为聚合添加超时配置
        Aggregation aggregationWithTimeout = aggregation.withOptions(
                Aggregation.newAggregationOptions()
                        .maxTime(Duration.ofMillis(5000))
                        .build()
        );
        return mongoTemplate().aggregate(aggregationWithTimeout, getCollectionName(), outputType).getMappedResults();
    }

    default String getCollectionName() {
        return MongoCollectionUtils.getCollectionName(getDomainClass());
    }

    Class<T> getDomainClass();

    MongoTemplate mongoTemplate();
}

之后你的PiiRepository继承这个基类，将原来的注解式聚合查询改为调用自定义方法即可，这种方式适合需要对不同聚合查询设置不同超时的场景。

验证注意事项 #

• 测试时注意：MongoDB的maxTimeMS是服务器端执行时间限制，不包含网络传输、客户端处理时间，所以测试时要确保服务器端执行时间确实超过设置值（比如你可以构造一个需要大量计算的聚合查询来触发超时）。
• 版本兼容性：以上方案针对Spring Data MongoDB 3.0.0.RELEASE和MongoDB 4.4.22验证有效，升级版本后可能需要调整配置方式。

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