SpringDataElasticsearch与SpEL表达式实现ES动态索引
作者:AnLingYi??????? 发布时间:2021-11-27 01:33:03
前言
一般情况下,当我们使用 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
,这样就会出现索引不存在的问题。
来源:https://juejin.cn/post/7140975221963505672
猜你喜欢
- 效果:原图加水印后的图片废话不多说,直接上代码代码:package com.example.demo;import java.awt.Alp
- 最近在刷力扣上的题目,刷到了65不同路径,当初上大学的时候,曾在hihocoder上刷到过这道题目,但是现在已经几乎全忘光了,大概的知识点是
- 1、问题描述几种代码写法会有不同的ID返回值,下面我们一一分析。2、问题分析 首先一种插入写法,源码如下:SysUser .java/**
- Spring boot默认使用的是SimpleCacheConfiguration,即使用ConcurrentMapCacheManager
- 本文实例讲述了Java实现SSL双向认证的方法。分享给大家供大家参考,具体如下:我们常见的SSL验证较多的只是验证我们的服务器是否是真实正确
- 本文实例讲述了java实现列表、集合与数组之间转化的方法。分享给大家供大家参考。具体实现方法如下:package test; i
- 将JavaDoc 注释 生成API文档1. 打开java代码,编写JavaDoc 注释,只有按照java的规范编写注释,才能很好的生成API
- Note:这篇文章是基于Android Studio 3.01版本的,NDK是R16。step1:创建一个包含C++的项目其他默认就可以了。
- 前言空间分配要点有:一是空间分配的连续性;二是动态内存申请;三是防止程序执行中出现异常错误。提示:开始讲解了嗷~后续会根据精力持续更新嗷!!
- 一、方法的定义1.方法体中最后返回值可以使用return, 如果使用了return, 那么方法体的返回值类型一定要指定2.如果方法体重没有r
- 更新了AS 3.1.2之后,发现新建Kotlin类,类注释依然木有,没办法只有自己动手了。方法很简单,编辑File Header就可以啦。只
- 一:什么是SparkSQL?(一)SparkSQL简介Spark SQL是Spark的一个模块,用于处理结构化的数据,它提供了一个数据抽象D
- Java设计模式的模板方法模式定义一个操作中算法的框架,而将一些步骤延迟到子类中,使得子类可以不改变算法的结构即可重定义该算法中的某些特定步
- 最近在做代码优化时学习和研究了下JAVA多线程的使用,看了菜鸟们的见解后做了下总结。1、继承Thread类实现多线程继承Thread类的方法
- 整理文档,搜刮出一个java后台接受app上传的图片的示例代码,稍微整理精简一下做下分享package com.sujinabo.file;
- 一、文件存储特点:openFileInput()和openFileOutput()读取设备上的文件。优点:适用于存储大量的数据,可以存储图片
- 先说一下对异步和同步的理解:同步调用:调用方在调用过程中,持续等待返回结果。异步调用:调用方在调用过程中,不直接等待返回结果,而是执行其他任
- 现在Java的大部分项目都是基于Maven, 在Maven项目中使用Selenium2. 非常简单。 首先你需要配置好
- 数据库里面表的字段中带有“”_“下划线,我们知道插件默认的是将这些带有下划线的字段默认的变成“优美的驼峰式”的。表是肯定不能动的,实体类的字
- 前言在使用Java开发接口请求中,我们需要对请求进行进行统一返回值,这时候我们自己封装一个统一的Result返回类,下面就介绍下我用的这种的