目录
前言
一般情况下,当我们使用 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
,这样就会出现索引不存在的问题。
:本文采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可, 转载请附上原文出处链接。
1、本站提供的源码不保证资源的完整性以及安全性,不附带任何技术服务!
2、本站提供的模板、软件工具等其他资源,均不包含技术服务,请大家谅解!
3、本站提供的资源仅供下载者参考学习,请勿用于任何商业用途,请24小时内删除!
4、如需商用,请购买正版,由于未及时购买正版发生的侵权行为,与本站无关。
5、本站部分资源存放于百度网盘或其他网盘中,请提前注册好百度网盘账号,下载安装百度网盘客户端或其他网盘客户端进行下载;
6、本站部分资源文件是经压缩后的,请下载后安装解压软件,推荐使用WinRAR和7-Zip解压软件。
7、如果本站提供的资源侵犯到了您的权益,请邮件联系: 442469558@qq.com 进行处理!
猪小侠源码-最新源码下载平台 PHP教程 SpringDataElasticsearch与SpEL表达式实现ES动态索引 http://www.20zxx.cn/585828/xuexijiaocheng/qes.html
猪小侠源码,优质资源分享网
相关文章
- java非法字符‘\\ufeff‘解决方法 2024-03-11
- Java中单体应用锁的局限性&分布式锁 2024-03-11
- 如何通过php函数解决页面渲染慢的问题? 2024-03-11
- 如何评估php性能优化函数的效果? 2024-03-11
- 如何利用PHP脚本在Linux中进行目录操作 2024-03-11
- 如何通过PHP脚本在Linux中进行系统监测 2024-03-11
- 如何使用php函数来优化表单处理和提交功能? 2024-03-11
- 如何通过PHP脚本在Linux服务器上实现数据加密 2024-03-11
- 如何通过php函数来优化验证码生成和校验? 2024-03-11
- 如何使用php函数来优化多语言支持功能? 2024-03-11
做猪小侠源码的代理,提供一站式服务
如果你不懂得搭建网站或者服务器,小程序,源码之类的怎么办? 第一通过本站学习各种互联网的技术 第二就是联系客服,我帮帮你搭建(当然要收取部分的费用) 第三成为我们的代理,我们提供整套的服务。