SpringDataElasticsearch與SpEL表達(dá)式實現(xiàn)ES動態(tài)索引
前言
一般情況下，當(dāng)我們使用 SpringDataElasticsearch 去操作 ES 時，索引名稱都會在 @Document 注解中寫死，每次都是對這個固定的索引進(jìn)行操作。
假如我們現(xiàn)在處于一個多租戶系統(tǒng)中，每個租戶都有自己所對應(yīng)的用戶數(shù)據(jù)，而這些用戶數(shù)據(jù)都會被導(dǎo)入到 ES 中，那怎么實現(xiàn)各個租戶的用戶數(shù)據(jù)索引隔離呢？
換言之，在同一個索引結(jié)構(gòu)的情況下怎么實現(xiàn)一個租戶一個索引？
解決方案：使用 SpEL 表達(dá)式動態(tài)獲取索引。
實現(xiàn)
動態(tài)獲取索引類
DynamicIndex.java
package cn.xeblog.userprovider.es;
import cn.hutool.core.util.StrUtil;
import org.springframework.stereotype.Component;
/**
* 動態(tài)索引
*
* @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();
}
/**
* 設(shè)置索引名稱后綴
*
* @param suffix
*/
public void setSuffix(String suffix) {
THREAD_LOCAL.set(suffix);
}
/**
* 移除當(dāng)前索引
*/
public void remove() {
THREAD_LOCAL.remove();
}
/**
* 獲取當(dāng)前索引
*
* @return
*/
public String getIndex() {
if (StrUtil.isBlank(getSuffix())) {
return null;
}
return "user_" + getSuffix();
}
}原理：一般在請求后臺接口的時候，我們會根據(jù)前端傳過來的 Token ，解析出當(dāng)前的用戶信息，然后放置在當(dāng)前請求線程的 ThreadLocal 中，當(dāng)調(diào)用 getIndex() 方法時，會從當(dāng)前線程的 ThreadLocal 中獲取出用戶的編號（索引后綴），然后拼接為一個完整的索引返回。
我這里為了方便測試，提供了 setSuffix()、remove() 等方法，用于手動設(shè)置或移除當(dāng)前索引后綴。
索引數(shù)據(jù)模型
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 設(shè)置為 #{@dynamicIndex.getIndex()} ，這是一個 SpEL 表達(dá)式，dynamicIndex 就是我們上面創(chuàng)建的動態(tài)獲取索引類的對象，當(dāng)需要獲取索引名稱的時候，getIndex() 方法就會被調(diào)用。
createIndex 一定要設(shè)置為 false，避免當(dāng)項目啟動時索引被自動創(chuàng)建。
ES存儲庫實現(xiàn)
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);
// 索引后綴為當(dāng)前租戶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);
// 索引后綴為當(dāng)前租戶ID：10002
dynamicIndex.setSuffix("10002");
// 為租戶10002添加用戶
esUserInfoRepository.save(userInfo2);
// 移除后綴
dynamicIndex.remove();
}
}我這里分別為 租戶10001 和 租戶10002 各創(chuàng)建了一個用戶。
注意
除了 createIndex 一定要設(shè)置為 false 之外，還有一個需要特別注意的地方：
DynamicIndex 的 getIndex() 方法在獲取不到當(dāng)前的索引后綴的情況下，一定要返回null ?。?！
/**
* 獲取當(dāng)前索引
*
* @return
*/
public String getIndex() {
if (StrUtil.isBlank(getSuffix())) {
// 一定要返回null
return null;
}
return "user_" + getSuffix();
}為什么呢？
淺看一下 ElasticsearchRepository.java 源碼你就懂了。
AbstractElasticsearchRepository.java 是 ElasticsearchRepository.java 的具體實現(xiàn)類，我們看一下這個類的 save() 方法的實現(xiàn)代碼
@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;
}當(dāng)執(zhí)行到 elasticsearchOperations.refresh(entityInformation.getIndexName()); 這行代碼時，獲取到的索引后綴可能為空。
原因在于 entityInformation.getIndexName()
MappingElasticsearchEntityInformation.java
@Override
public String getIndexName() {
return indexName != null ? indexName : entityMetadata.getIndexName();
}在項目啟動時，SpringDataElasticsearch 會去解析一次 @Document 注解獲取出索引名稱，并將索引名稱保存到 MappingElasticsearchEntityInformation.java 類的 indexName 字段中，后續(xù)調(diào)用 entityInformation.getIndexName() 時，indexName 字段值不為 null 時會直接返回，不會再去解析 @Document 注解。
這樣就存在一個問題，當(dāng)項目啟動的時候 getSuffix() 返回的肯定是 null，如果在 getIndex() 方法中去掉判空代碼，第一次調(diào)用時，返回的索引名稱肯定會是 user_null，這樣就會出現(xiàn)索引不存在的問題。
到此這篇關(guān)于SpringDataElasticsearch與SpEL表達(dá)式實現(xiàn)ES動態(tài)索引的文章就介紹到這了,更多相關(guān)SpringDataElasticsearch實現(xiàn)ES動態(tài)索引內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
Java中BigInteger類的使用方法詳解(全網(wǎng)最新)
這篇文章主要介紹了Java中BigInteger類的使用方法詳解，常用最全系列,本章作為筆記使用，內(nèi)容比較全面，但常用的只有：構(gòu)造函數(shù)，基本運算以及compareTo()，intValue()，setBit()，testBit()方法，需要的朋友可以參考下2023-05-05
如何將DeepSeek 集成到 Java 的 Spring Boot&
本文介紹了如何將DeepSeek集成到Java的SpringBoot項目中,包括準(zhǔn)備工作、集成步驟和示例說明,感興趣的朋友一起看看吧2025-02-02
Spring Boot2+JPA之悲觀鎖和樂觀鎖實戰(zhàn)教程
這篇文章主要介紹了Spring Boot2+JPA之悲觀鎖和樂觀鎖實戰(zhàn)教程，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-10-10
本文介紹了如何在微服務(wù)項目導(dǎo)入時將所有服務(wù)加入同一窗口中,解決啟動項目服務(wù)時顯示不全的問題,通過點擊左上角的View,選擇ToolWindows,然后選擇Services,使用快捷鍵Alt+8,選擇Spring Boot,就可以將所有服務(wù)加到同一窗口中2025-02-02
這是工作中遇到的問題,記錄下來,也方便自己后面查看操作步驟,也方便各位遇到這個問題,不至于卡太久,如有錯誤或未考慮完全的地方,望不吝賜教2023-11-11
Lombok中@EqualsAndHashCode注解的使用及說明
這篇文章主要介紹了Lombok中@EqualsAndHashCode注解的使用及說明，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-03-03
詳解Springboot-MyBatis配置-配置端口號與服務(wù)路徑(idea社區(qū)版2023.1.4+apache-mav
這篇文章主要介紹了Springboot-MyBatis配置-配置端口號與服務(wù)路徑(idea社區(qū)版2023.1.4+apache-maven-3.9.3-bin),本文通過實例代碼給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下2023-07-07
這篇文章主要介紹了Spring之基于xml的聲明式事務(wù),本文通過圖文實例代碼相結(jié)合給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2023-09-09
SpringBoot詳細(xì)探究講解默認(rèn)組件掃描
在項目中我們創(chuàng)建了Controller，這個Controller是如何被spring自動加載的呢？為什么Controller必須放在啟動類的同級目錄下呢2022-06-06
Java語言描述存儲結(jié)構(gòu)與鄰接矩陣代碼示例
這篇文章主要介紹了Java語言描述存儲結(jié)構(gòu)與鄰接矩陣代碼示例，涉及Java存儲結(jié)構(gòu)，鄰接矩陣，鄰接表的介紹與比較，然后分享了鄰接矩陣的Java實現(xiàn)等相關(guān)內(nèi)容，具有一定借鑒價值，需要的朋友可以參考。2017-11-11