Spring Data Redis文本索引创建与搜索相关文档咨询

我之前做过Spring Data结合Redis文本索引的需求，刚好能给你分享下思路——确实Spring Data Redis核心里没有像MongoDB那样的@TextIndexed注解，因为Redis的文本索引依赖于RedisSearch模块，而Spring Data Redis默认没封装这块，不过结合JRediSearch我们完全可以自己实现类似的功能。

下面是具体的实现步骤和示例：

1. 前提准备 #

首先确保你的Redis实例已经安装并启用了RedisSearch模块（如果是用Redis Stack的话，默认已经包含了这个模块，不用额外安装）。

2. 自定义文本索引注解与索引初始化 #

我们可以自己定义一个类似@TextIndexed的注解，然后通过Spring的启动初始化逻辑，用JRediSearch的API来创建文本索引：

步骤1：自定义注解 #

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface RedisTextIndexed {
    // 可添加权重、分词器配置等参数
    double weight() default 1.0;
}

步骤2：实体类使用注解 #

@RedisHash("blog_post")
public class BlogPost {
    @Id
    private String id;
    private String title;
    @RedisTextIndexed(weight = 2.0)
    private String content;
    // getter、setter省略
}

步骤3：初始化文本索引 #

在Spring启动时，扫描带有@RedisHash和@RedisTextIndexed的实体，用JRediSearch的SchemaBuilder构建索引：

@Component
public class RedisSearchIndexInitializer implements ApplicationListener<ContextRefreshedEvent> {

    @Autowired
    private RedisConnectionFactory redisConnectionFactory;

    @Override
    public void onApplicationEvent(ContextRefreshedEvent event) {
        // 扫描指定包下所有带@RedisHash的实体
        Reflections reflections = new Reflections("com.yourpackage.entity");
        Set<Class<?>> redisHashEntities = reflections.getTypesAnnotatedWith(RedisHash.class);

        for (Class<?> entityClass : redisHashEntities) {
            RedisHash redisHash = entityClass.getAnnotation(RedisHash.class);
            String indexName = redisHash.value();

            // 构建索引Schema
            SchemaBuilder schemaBuilder = new SchemaBuilder();
            Field[] fields = entityClass.getDeclaredFields();
            for (Field field : fields) {
                if (field.isAnnotationPresent(RedisTextIndexed.class)) {
                    RedisTextIndexed annotation = field.getAnnotation(RedisTextIndexed.class);
                    schemaBuilder.addTextField(field.getName(), annotation.weight());
                } else {
                    // 非文本字段按类型添加，比如普通字符串字段
                    if (field.getType().equals(String.class)) {
                        schemaBuilder.addTextField(field.getName(), 1.0);
                    }
                }
            }

            // 创建索引
            try (Jedis jedis = (Jedis) redisConnectionFactory.getConnection().getNativeConnection()) {
                Client client = new Client(indexName, jedis);
                client.createIndex(schemaBuilder.build());
            }
        }
    }
}

3. 封装文本搜索方法 #

我们可以在Spring Data Repository里自定义方法，内部调用JRediSearch的API来执行文本搜索：

自定义Repository接口 #

public interface BlogPostRepository extends CrudRepository<BlogPost, String>, BlogPostRepositoryCustom {
}

// 自定义搜索方法接口
interface BlogPostRepositoryCustom {
    List<BlogPost> searchByContent(String keyword);
}

Repository实现类 #

public class BlogPostRepositoryImpl implements BlogPostRepositoryCustom {

    @Autowired
    private RedisConnectionFactory redisConnectionFactory;

    @Override
    public List<BlogPost> searchByContent(String keyword) {
        try (Jedis jedis = (Jedis) redisConnectionFactory.getConnection().getNativeConnection()) {
            Client client = new Client("blog_post", jedis);
            // 执行文本搜索，可设置分页、排序等参数
            SearchResult result = client.search(new Query(keyword).limit(0, 10));

            // 将搜索结果转换为实体类
            List<BlogPost> posts = new ArrayList<>();
            for (Document doc : result.getDocuments()) {
                BlogPost post = new BlogPost();
                post.setId(doc.getId());
                post.setTitle((String) doc.getProperties().get("title"));
                post.setContent((String) doc.getProperties().get("content"));
                posts.add(post);
            }
            return posts;
        }
    }
}

4. 注意事项 #

• 索引维护：当实体更新或删除时，需要确保索引同步更新，可以通过Spring Data的@RepositoryEventHandler监听实体增删改事件，调用JRediSearch的API更新索引。
• 分词器配置：如果需要中文分词，可在创建索引时指定自定义分词器（RedisSearch支持结合jieba等第三方分词工具）。
• 依赖引入：记得在项目依赖中添加JRediSearch的相关包。

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