Spring Data Mongo中@Collation注解不生效问题咨询

问题背景 #

使用Spring Boot 3.1.5 + Spring Data Mongo 4.1.5 + MongoDB 6（MongoDB 4无差异）时，期望通过@Collation注解在实体类、仓库接口或查询方法上配置排序规则，让所有仓库方法（包括findAll(Pageable)这类默认方法）自动应用该规则，但实际仅在@Query注解中直接指定collation参数才生效，其余方式均失败。

已尝试的无效方式：

• 在数据实体类上添加@Collation注解
• 在仓库接口上添加@Collation注解
• 在查询方法上添加@Collation注解

仅生效方式：

• 在@Query注解中指定collation="..."参数

可行解决方案 #

方案1：配置全局默认Collation（推荐） #

通过自定义MongoTemplate，设置全局默认的Collation，这样所有通过Spring Data仓库执行的查询（包括默认方法和自定义查询）都会自动应用该规则，无需逐个方法配置。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.mongodb.MongoDatabaseFactory;
import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.data.mongodb.core.convert.MongoConverter;
import org.springframework.data.mongodb.core.mapping.Collation;

@Configuration
public class MongoConfig {

    @Bean
    public MongoTemplate mongoTemplate(MongoDatabaseFactory factory, MongoConverter converter) {
        MongoTemplate mongoTemplate = new MongoTemplate(factory, converter);
        // 设置全局默认Collation，示例为不区分大小写的英文排序规则
        Collation collation = Collation.of("en").strength(Collation.ComparisonLevel.secondary());
        mongoTemplate.setDefaultCollation(collation);
        return mongoTemplate;
    }
}

方案2：自定义仓库基类实现默认方法 #

如果需要针对特定仓库而非全局配置，可以自定义仓库基类，重写默认方法并显式应用Collation：

import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.mongodb.core.query.Query;
import org.springframework.data.mongodb.repository.query.MongoEntityInformation;
import org.springframework.data.mongodb.repository.support.SimpleMongoRepository;
import org.springframework.data.mongodb.core.mapping.Collation;

import java.io.Serializable;

public class CustomMongoRepository<T, ID extends Serializable> extends SimpleMongoRepository<T, ID> {

    private final MongoTemplate mongoTemplate;
    // 自定义默认排序规则
    private final Collation defaultCollation = Collation.of("en").strength(Collation.ComparisonLevel.secondary());

    public CustomMongoRepository(MongoEntityInformation<T, ID> entityInformation, MongoTemplate mongoTemplate) {
        super(entityInformation, mongoTemplate);
        this.mongoTemplate = mongoTemplate;
    }

    @Override
    public Page<T> findAll(Pageable pageable) {
        Query query = new Query().with(pageable).collation(defaultCollation);
        return readPage(query, pageable);
    }

    // 按需重写其他默认方法，如findAll()、findById()、count()等
}

然后定义仓库基类接口：

import org.springframework.data.mongodb.repository.MongoRepository;
import org.springframework.data.repository.NoRepositoryBean;

@NoRepositoryBean
public interface CustomMongoBaseRepository<T, ID extends Serializable> extends MongoRepository<T, ID> {
}

业务仓库继承该基类：

public interface UserRepository extends CustomMongoBaseRepository<User, String> {
    // 自定义查询方法会自动继承基类的Collation配置
}

方案3：确认@Collation注解的正确使用格式 #

如果坚持使用@Collation注解，需确保注解使用JSON字符串格式配置规则，例如：

import org.springframework.data.mongodb.core.mapping.Collation;

@Collation(value = "{ 'locale': 'en', 'strength': 2 }")
public class User {
    // 实体字段
}

或在仓库接口上：

@Collation("{ 'locale': 'en', 'strength': 2 }")
public interface UserRepository extends MongoRepository<User, String> {
}

注：部分版本中@Collation注解仅支持JSON字符串配置，若仍不生效，建议优先使用方案1或方案2

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