docs(solon): solon注释

This commit is contained in:
阿杰 2025-04-14 08:53:37 +08:00
parent 3bc2a7a860
commit 0e282e8485
2 changed files with 37 additions and 0 deletions

View File

@ -24,12 +24,24 @@ import java.util.Map;
@Condition(onClass = ElasticsearchClient.class, onProperty = "${easy-es.enable:true} = true") @Condition(onClass = ElasticsearchClient.class, onProperty = "${easy-es.enable:true} = true")
public class EsAutoConfiguration { public class EsAutoConfiguration {
/**
* 加载easy-es属性变量
* @param properties 配置
* @return {@link EasyEsProperties}
* @author MoJie
*/
@Bean @Bean
public EasyEsProperties easyEsProperties( public EasyEsProperties easyEsProperties(
@Inject(value = "${easy-es}", autoRefreshed = true) EasyEsProperties properties) { @Inject(value = "${easy-es}", autoRefreshed = true) EasyEsProperties properties) {
return properties; return properties;
} }
/**
* 动态数据源配置
* @param dynamicProperties 动态数据源
* @return {@link EasyEsDynamicProperties}
* @author MoJie
*/
@Bean @Bean
public EasyEsDynamicProperties easyEsDynamicProperties( public EasyEsDynamicProperties easyEsDynamicProperties(
@Inject(value = "${easy-es.dynamic:}", autoRefreshed = true) EasyEsDynamicProperties dynamicProperties) { @Inject(value = "${easy-es.dynamic:}", autoRefreshed = true) EasyEsDynamicProperties dynamicProperties) {
@ -50,6 +62,13 @@ public class EsAutoConfiguration {
return EsClientUtils.buildClient(easyEsProperties); return EsClientUtils.buildClient(easyEsProperties);
} }
/**
* 构建连接对象在EasyEsProperties和EasyEsDynamicProperties构建完成后执行
* @param properties 基础配置
* @param dynamicProperties 动态数据源配置
* @return {@link EsClientUtils}
* @author MoJie
*/
@Bean @Bean
public EsClientUtils esClientUtils(EasyEsProperties properties, EasyEsDynamicProperties dynamicProperties) { public EsClientUtils esClientUtils(EasyEsProperties properties, EasyEsDynamicProperties dynamicProperties) {
EsClientUtils esClientUtils = new EsClientUtils(); EsClientUtils esClientUtils = new EsClientUtils();
@ -65,11 +84,23 @@ public class EsAutoConfiguration {
return esClientUtils; return esClientUtils;
} }
/**
* 自动平滑托管索引
* 过程零停机,数据会自动转移至新索引
* @return {@link AutoProcessIndexStrategy}
* @author MoJie
*/
@Bean @Bean
public AutoProcessIndexStrategy autoProcessIndexSmoothlyStrategy() { public AutoProcessIndexStrategy autoProcessIndexSmoothlyStrategy() {
return new AutoProcessIndexSmoothlyStrategy(); return new AutoProcessIndexSmoothlyStrategy();
} }
/**
* 自动平滑托管索引
* 重建索引时原索引数据会被删除
* @return {@link AutoProcessIndexStrategy}
* @author MoJie
*/
@Bean @Bean
public AutoProcessIndexStrategy autoProcessIndexNotSmoothlyStrategy() { public AutoProcessIndexStrategy autoProcessIndexNotSmoothlyStrategy() {
return new AutoProcessIndexNotSmoothlyStrategy(); return new AutoProcessIndexNotSmoothlyStrategy();

View File

@ -53,6 +53,12 @@ public class IndexStrategyFactory implements LifecycleBean {
} }
} }
/**
* 获取索引托管的对象
* @param strategyType {@link ProcessIndexStrategyEnum} 托管参数
* @return {@link AutoProcessIndexStrategy}
* @author MoJie
*/
public AutoProcessIndexStrategy getByStrategyType(Integer strategyType) { public AutoProcessIndexStrategy getByStrategyType(Integer strategyType) {
return Optional.ofNullable(SERVICE_MAP.get(strategyType)) return Optional.ofNullable(SERVICE_MAP.get(strategyType))
.orElseThrow(() -> ExceptionUtils.eee("no such service strategyType:{}", strategyType)); .orElseThrow(() -> ExceptionUtils.eee("no such service strategyType:{}", strategyType));