From 0e282e84850442751a97061150619387e3720d5c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E9=98=BF=E6=9D=B0?= <ajie20999@163.com>
Date: Mon, 14 Apr 2025 08:53:37 +0800
Subject: [PATCH] =?UTF-8?q?docs(solon):=20solon=E6=B3=A8=E9=87=8A?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../solon/config/EsAutoConfiguration.java     | 31 +++++++++++++++++++
 .../solon/factory/IndexStrategyFactory.java   |  6 ++++
 2 files changed, 37 insertions(+)

diff --git a/easy-es-solon-plugin/src/main/java/org/dromara/easyes/solon/config/EsAutoConfiguration.java b/easy-es-solon-plugin/src/main/java/org/dromara/easyes/solon/config/EsAutoConfiguration.java
index 4601f8f5..bd2375a2 100644
--- a/easy-es-solon-plugin/src/main/java/org/dromara/easyes/solon/config/EsAutoConfiguration.java
+++ b/easy-es-solon-plugin/src/main/java/org/dromara/easyes/solon/config/EsAutoConfiguration.java
@@ -24,12 +24,24 @@ import java.util.Map;
 @Condition(onClass = ElasticsearchClient.class, onProperty = "${easy-es.enable:true} = true")
 public class EsAutoConfiguration {
 
+    /**
+     * 加载easy-es属性变量
+     * @param properties 配置
+     * @return {@link EasyEsProperties}
+     * @author MoJie
+     */
     @Bean
     public EasyEsProperties easyEsProperties(
             @Inject(value = "${easy-es}", autoRefreshed = true) EasyEsProperties properties) {
         return properties;
     }
 
+    /**
+     * 动态数据源配置
+     * @param dynamicProperties 动态数据源
+     * @return {@link EasyEsDynamicProperties}
+     * @author MoJie
+     */
     @Bean
     public EasyEsDynamicProperties easyEsDynamicProperties(
             @Inject(value = "${easy-es.dynamic:}", autoRefreshed = true) EasyEsDynamicProperties dynamicProperties) {
@@ -50,6 +62,13 @@ public class EsAutoConfiguration {
         return EsClientUtils.buildClient(easyEsProperties);
     }
 
+    /**
+     * 构建连接对象，在EasyEsProperties和EasyEsDynamicProperties构建完成后执行
+     * @param properties 基础配置
+     * @param dynamicProperties 动态数据源配置
+     * @return {@link EsClientUtils}
+     * @author MoJie
+     */
     @Bean
     public EsClientUtils esClientUtils(EasyEsProperties properties, EasyEsDynamicProperties dynamicProperties) {
         EsClientUtils esClientUtils = new EsClientUtils();
@@ -65,11 +84,23 @@ public class EsAutoConfiguration {
         return esClientUtils;
     }
 
+    /**
+     * 自动平滑托管索引
+     * 过程零停机,数据会自动转移至新索引
+     * @return {@link AutoProcessIndexStrategy}
+     * @author MoJie
+     */
     @Bean
     public AutoProcessIndexStrategy autoProcessIndexSmoothlyStrategy() {
         return new AutoProcessIndexSmoothlyStrategy();
     }
 
+    /**
+     * 自动平滑托管索引
+     * 重建索引时原索引数据会被删除
+     * @return {@link AutoProcessIndexStrategy}
+     * @author MoJie
+     */
     @Bean
     public AutoProcessIndexStrategy autoProcessIndexNotSmoothlyStrategy() {
         return new AutoProcessIndexNotSmoothlyStrategy();
diff --git a/easy-es-solon-plugin/src/main/java/org/dromara/easyes/solon/factory/IndexStrategyFactory.java b/easy-es-solon-plugin/src/main/java/org/dromara/easyes/solon/factory/IndexStrategyFactory.java
index 4b69edc8..462d29c1 100644
--- a/easy-es-solon-plugin/src/main/java/org/dromara/easyes/solon/factory/IndexStrategyFactory.java
+++ b/easy-es-solon-plugin/src/main/java/org/dromara/easyes/solon/factory/IndexStrategyFactory.java
@@ -53,6 +53,12 @@ public class IndexStrategyFactory implements LifecycleBean {
         }
     }
 
+    /**
+     * 获取索引托管的对象
+     * @param strategyType {@link ProcessIndexStrategyEnum} 托管参数
+     * @return {@link AutoProcessIndexStrategy}
+     * @author MoJie
+     */
     public AutoProcessIndexStrategy getByStrategyType(Integer strategyType) {
         return Optional.ofNullable(SERVICE_MAP.get(strategyType))
                 .orElseThrow(() -> ExceptionUtils.eee("no such service strategyType:{}", strategyType));