SpringDataElasticsearch与SpEL表达式实现ES动态索引

 更新时间:2022年09月09日 08:44:18   作者:AnLingYi​​​​​​​  
这篇文章主要介绍了SpringDataElasticsearch与SpEL表达式实现ES动态索引,文章围绕主题展开详细的内容介绍,具有一定的参考价值,需要的朋友可以参考一下

前言

一般情况下,当我们使用 SpringDataElasticsearch 去操作 ES 时,索引名称都会在 @Document 注解中写死,每次都是对这个固定的索引进行操作。

假如我们现在处于一个多租户系统中,每个租户都有自己所对应的用户数据,而这些用户数据都会被导入到 ES 中,那怎么实现各个租户的用户数据索引隔离呢?

换言之,在同一个索引结构的情况下怎么实现一个租户一个索引?

解决方案:使用 SpEL 表达式动态获取索引。

实现

动态获取索引类

DynamicIndex.java

package cn.xeblog.userprovider.es;

import cn.hutool.core.util.StrUtil;
import org.springframework.stereotype.Component;

/**
 * 动态索引
 *
 * @author anlingyi
 * @date 2022/2/19 6:52 下午
 */
@Component
public class DynamicIndex {

    private static final ThreadLocal<String> THREAD_LOCAL = new ThreadLocal<>();

    /**
     * 获取索引名称后缀
     *
     * @return
     */
    public String getSuffix() {
        return THREAD_LOCAL.get();
    }

    /**
     * 设置索引名称后缀
     *
     * @param suffix
     */
    public void setSuffix(String suffix) {
        THREAD_LOCAL.set(suffix);
    }

    /**
     * 移除当前索引
     */
    public void remove() {
        THREAD_LOCAL.remove();
    }

    /**
     * 获取当前索引
     *
     * @return
     */
    public String getIndex() {
        if (StrUtil.isBlank(getSuffix())) {
            return null;
        }

        return "user_" + getSuffix();
    }

}

原理:一般在请求后台接口的时候,我们会根据前端传过来的 Token ,解析出当前的用户信息,然后放置在当前请求线程的 ThreadLocal 中,当调用 getIndex() 方法时,会从当前线程的 ThreadLocal 中获取出用户的编号(索引后缀),然后拼接为一个完整的索引返回。

我这里为了方便测试,提供了 setSuffix()、remove() 等方法,用于手动设置或移除当前索引后缀。

索引数据模型

EsUserInfo.java

package cn.xeblog.userprovider.es.model;

import lombok.Data;
import org.springframework.data.annotation.Id;
import org.springframework.data.elasticsearch.annotations.Document;

/**
 * 用户信息
 *
 * @author anlingyi
 * @date 2022/2/19 6:47 下午
 */
@Data
@Document(indexName = "#{@dynamicIndex.getIndex()}", type = "_doc", createIndex = false)
public class EsUserInfo {

    @Id
    private Long id;

    /**
     * 用户名
     */
    private String username;

    /**
     * 性别
     */
    private String gender;

    /**
     * 年龄
     */
    private Integer age;

}

indexName 设置为 #{@dynamicIndex.getIndex()} ,这是一个 SpEL 表达式,dynamicIndex 就是我们上面创建的动态获取索引类的对象,当需要获取索引名称的时候,getIndex() 方法就会被调用。

createIndex 一定要设置为 false,避免当项目启动时索引被自动创建。

ES存储库实现

EsUserInfoRepository.java

无需定义任何方法

package cn.xeblog.userprovider.es;

import cn.xeblog.userprovider.es.model.EsUserInfo;
import org.springframework.data.elasticsearch.repository.ElasticsearchRepository;
/**
 * @author anlingyi
 * @date 2022/2/19 6:55 下午
 */
public interface EsUserInfoRepository extends ElasticsearchRepository<EsUserInfo, Long> {

}

测试

package cn.xeblog.userprovider.es;

import cn.xeblog.userprovider.es.model.EsUserInfo;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import javax.annotation.Resource;
import static org.junit.jupiter.api.Assertions.*;
/**
 * @author anlingyi
 * @date 2022/2/19 6:57 下午
 */
@SpringBootTest
class EsUserInfoRepositoryTest {

    @Resource
    private EsUserInfoRepository esUserInfoRepository;
    @Resource
    private DynamicIndex dynamicIndex;

    @Test
    public void addUserInfo() {
        EsUserInfo userInfo = new EsUserInfo();
        userInfo.setId(1L);
        userInfo.setUsername("张三");
        userInfo.setGender("男");
        userInfo.setAge(18);
        // 索引后缀为当前租户ID:10001
        dynamicIndex.setSuffix("10001");
        // 为租户10001添加用户
        esUserInfoRepository.save(userInfo);
        // 移除后缀
        dynamicIndex.remove();

        EsUserInfo userInfo2 = new EsUserInfo();
        userInfo2.setId(2L);
        userInfo2.setUsername("李四");
        userInfo2.setGender("男");
        userInfo2.setAge(21);
        // 索引后缀为当前租户ID:10002
        dynamicIndex.setSuffix("10002");
        // 为租户10002添加用户
        esUserInfoRepository.save(userInfo2);
        // 移除后缀
        dynamicIndex.remove();
    }

}

我这里分别为 租户10001 和 租户10002 各创建了一个用户。

注意

除了 createIndex 一定要设置为 false 之外,还有一个需要特别注意的地方:

DynamicIndex 的 getIndex() 方法在获取不到当前的索引后缀的情况下,一定要返回null !!!

    /**
     * 获取当前索引
     *
     * @return
     */
    public String getIndex() {
        if (StrUtil.isBlank(getSuffix())) {
	    // 一定要返回null
            return null;
        }

        return "user_" + getSuffix();
    }

为什么呢?

浅看一下 ElasticsearchRepository.java 源码你就懂了。

AbstractElasticsearchRepository.java 是 ElasticsearchRepository.java 的具体实现类,我们看一下这个类的 save() 方法的实现代码

	@Override
	public <S extends T> S save(S entity) {

		Assert.notNull(entity, "Cannot save 'null' entity.");

		elasticsearchOperations.index(createIndexQuery(entity));
		elasticsearchOperations.refresh(entityInformation.getIndexName());

		return entity;
	}

当执行到 elasticsearchOperations.refresh(entityInformation.getIndexName()); 这行代码时,获取到的索引后缀可能为空。

原因在于 entityInformation.getIndexName()

MappingElasticsearchEntityInformation.java

	@Override
	public String getIndexName() {
		return indexName != null ? indexName : entityMetadata.getIndexName();
	}

在项目启动时,SpringDataElasticsearch 会去解析一次 @Document 注解获取出索引名称,并将索引名称保存到 MappingElasticsearchEntityInformation.java 类的 indexName 字段中,后续调用 entityInformation.getIndexName() 时,indexName 字段值不为 null 时会直接返回,不会再去解析 @Document 注解。

这样就存在一个问题,当项目启动的时候 getSuffix() 返回的肯定是 null,如果在 getIndex() 方法中去掉判空代码,第一次调用时,返回的索引名称肯定会是 user_null,这样就会出现索引不存在的问题。

到此这篇关于SpringDataElasticsearch与SpEL表达式实现ES动态索引的文章就介绍到这了,更多相关SpringDataElasticsearch实现ES动态索引内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java中BigInteger类的使用方法详解(全网最新)

    Java中BigInteger类的使用方法详解(全网最新)

    这篇文章主要介绍了Java中BigInteger类的使用方法详解,常用最全系列,本章作为笔记使用,内容比较全面,但常用的只有:构造函数,基本运算以及compareTo(),intValue(),setBit(),testBit()方法,需要的朋友可以参考下
    2023-05-05
  • 如何将DeepSeek 集成到 Java 的 Spring Boot 项目中

    如何将DeepSeek 集成到 Java 的 Spring Boot&

    本文介绍了如何将DeepSeek集成到Java的SpringBoot项目中,包括准备工作、集成步骤和示例说明,感兴趣的朋友一起看看吧
    2025-02-02
  • Spring Boot2+JPA之悲观锁和乐观锁实战教程

    Spring Boot2+JPA之悲观锁和乐观锁实战教程

    这篇文章主要介绍了Spring Boot2+JPA之悲观锁和乐观锁实战教程,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-10-10
  • idea微服务项目服务如何显示在同一窗口

    idea微服务项目服务如何显示在同一窗口

    本文介绍了如何在微服务项目导入时将所有服务加入同一窗口中,解决启动项目服务时显示不全的问题,通过点击左上角的View,选择ToolWindows,然后选择Services,使用快捷键Alt+8,选择Spring Boot,就可以将所有服务加到同一窗口中
    2025-02-02
  • GitLab在IDEA中回滚主分支问题

    GitLab在IDEA中回滚主分支问题

    这是工作中遇到的问题,记录下来,也方便自己后面查看操作步骤,也方便各位遇到这个问题,不至于卡太久,如有错误或未考虑完全的地方,望不吝赐教
    2023-11-11
  • Lombok中@EqualsAndHashCode注解的使用及说明

    Lombok中@EqualsAndHashCode注解的使用及说明

    这篇文章主要介绍了Lombok中@EqualsAndHashCode注解的使用及说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-03-03
  • 详解Springboot-MyBatis配置-配置端口号与服务路径(idea社区版2023.1.4+apache-maven-3.9.3-bin)

    详解Springboot-MyBatis配置-配置端口号与服务路径(idea社区版2023.1.4+apache-mav

    这篇文章主要介绍了Springboot-MyBatis配置-配置端口号与服务路径(idea社区版2023.1.4+apache-maven-3.9.3-bin),本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-07-07
  • Spring中基于xml的声明式事务示例详解

    Spring中基于xml的声明式事务示例详解

    这篇文章主要介绍了Spring之基于xml的声明式事务,本文通过图文实例代码相结合给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-09-09
  • SpringBoot详细探究讲解默认组件扫描

    SpringBoot详细探究讲解默认组件扫描

    在项目中我们创建了Controller,这个Controller是如何被spring自动加载的呢?为什么Controller必须放在启动类的同级目录下呢
    2022-06-06
  • Java语言描述存储结构与邻接矩阵代码示例

    Java语言描述存储结构与邻接矩阵代码示例

    这篇文章主要介绍了Java语言描述存储结构与邻接矩阵代码示例,涉及Java存储结构,邻接矩阵,邻接表的介绍与比较,然后分享了邻接矩阵的Java实现等相关内容,具有一定借鉴价值,需要的朋友可以参考。
    2017-11-11

最新评论