Spring Data Redis中如何配置Redis Hash对象的复合索引？

Spring Data Redis 目前没有提供像 Spring Data MongoDB 那样开箱即用的@CompoundIndex注解，但可以通过自定义IndexResolver并结合CompositeIndexResolver来实现复合索引的功能，以下是具体实现步骤：

1. 自定义复合索引解析器 #

创建一个自定义的IndexResolver实现类，用于生成多字段组合的索引定义：

import org.springframework.data.redis.core.convert.IndexResolver;
import org.springframework.data.redis.core.convert.IndexDefinition;
import org.springframework.data.redis.core.convert.SimpleIndexDefinition;
import org.springframework.data.redis.core.mapping.RedisPersistentEntity;
import org.springframework.data.redis.core.mapping.RedisPersistentProperty;

import java.util.Collections;
import java.util.HashSet;
import java.util.Set;

public class CompoundIndexResolver implements IndexResolver {

    private final Class<?> targetEntity;
    private final String[] compoundFields;
    private final String indexNamePrefix;

    // 构造函数：指定目标实体类、复合字段数组、索引前缀
    public CompoundIndexResolver(Class<?> targetEntity, String[] compoundFields, String indexNamePrefix) {
        this.targetEntity = targetEntity;
        this.compoundFields = compoundFields;
        this.indexNamePrefix = indexNamePrefix;
    }

    @Override
    public Set<IndexDefinition> resolveIndexFor(RedisPersistentEntity<?> entity, RedisPersistentProperty property) {
        // 仅处理目标实体的字段
        if (!targetEntity.equals(entity.getType())) {
            return Collections.emptySet();
        }

        // 当复合字段中的任意一个被更新时，生成复合索引定义
        for (String field : compoundFields) {
            if (field.equals(property.getName())) {
                Set<IndexDefinition> indexes = new HashSet<>();
                // 定义复合索引的key格式：{前缀}:{实体名}:{字段组合}:{字段值组合}
                String indexName = String.format("%s:%s:%s", indexNamePrefix, entity.getType().getSimpleName(), String.join("-", compoundFields));
                indexes.add(new SimpleIndexDefinition(entity.getKeySpace(), indexName, compoundFields));
                return indexes;
            }
        }
        return Collections.emptySet();
    }
}

2. 配置Redis Mapping Context，整合复合索引解析器 #

在Java配置类中，将自定义的复合索引解析器与默认的RedisIndexResolver组合到CompositeIndexResolver中，替换默认的索引解析逻辑：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.core.convert.DefaultRedisConverter;
import org.springframework.data.redis.core.convert.IndexResolver;
import org.springframework.data.redis.core.convert.RedisConverter;
import org.springframework.data.redis.core.convert.RedisIndexResolver;
import org.springframework.data.redis.core.convert.CompositeIndexResolver;
import org.springframework.data.redis.core.mapping.RedisMappingContext;

@Configuration
public class RedisConfig {

    @Bean
    public RedisMappingContext redisMappingContext() {
        return new RedisMappingContext();
    }

    @Bean
    public RedisConverter redisConverter(RedisMappingContext mappingContext) {
        return new DefaultRedisConverter(mappingContext, indexResolver(mappingContext));
    }

    private IndexResolver indexResolver(RedisMappingContext mappingContext) {
        // 默认索引解析器，处理@Indexed注解的单字段索引
        IndexResolver defaultResolver = new RedisIndexResolver(mappingContext);
        // 自定义复合索引解析器：针对User实体，创建name和age的复合索引
        IndexResolver userCompoundResolver = new CompoundIndexResolver(User.class, new String[]{"name", "age"}, "idx");
        // 组合两个解析器
        return new CompositeIndexResolver(defaultResolver, userCompoundResolver);
    }
}

3. 复合索引的查询使用 #

复合索引创建后，查询时需要构造对应的索引key来匹配，例如要查询name为"张三"且age为25的User：

@Autowired
private RedisTemplate<String, User> redisTemplate;

public User findUserByNameAndAge(String name, int age) {
    // 构造复合索引的key
    String indexKey = "idx:User:name-age:" + name + "-" + age;
    // 通过索引key获取对应的实体hash key
    Set<String> hashKeys = redisTemplate.opsForSet().members(indexKey);
    if (hashKeys == null || hashKeys.isEmpty()) {
        return null;
    }
    // 取出第一个hash key（假设复合字段组合唯一）
    String userKey = hashKeys.iterator().next();
    return redisTemplate.opsForHash().entries(userKey);
}

注意事项 #

• 索引维护：当实体的复合字段值更新时，Spring Data Redis不会自动删除旧的复合索引条目，需要在业务代码中手动处理旧索引的删除和新索引的添加，或者自定义AfterSaveCallback来自动维护。
• 唯一性保证：如果复合字段组合需要唯一约束，需要在写入前检查索引是否存在，避免重复数据。
• 索引命名规范：统一索引key的命名格式，方便后续维护和查询。

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