From 60fcd3c937c3f3ccf51bfc27f1fdd1a5d4792ae4 Mon Sep 17 00:00:00 2001 From: xpc Date: Sun, 13 Apr 2025 21:15:16 +0800 Subject: [PATCH] =?UTF-8?q?v3.0.0=20-=20fix:=20javadoc=E6=B3=A8=E9=87=8A?= =?UTF-8?q?=E8=B0=83=E6=95=B4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../dromara/easyes/annotation/IndexId.java | 3 +- .../annotation/rely/ISettingsProvider.java | 1 + .../common/utils/jackson/JsonUtils.java | 166 +--------------- .../dromara/easyes/core/cache/BaseCache.java | 6 +- .../core/conditions/function/Index.java | 4 +- .../easyes/core/kernel/WrapperProcessor.java | 9 +- .../easyes/core/toolkit/Generator.java | 1 + .../dromara/easyes/core/toolkit/GeoUtils.java | 4 +- .../easyes/core/toolkit/IndexUtils.java | 2 + .../easyes/core/toolkit/PrintUtils.java | 4 + easy-es-parent/pom.xml | 186 +++++++++--------- .../solon/config/EsAutoConfiguration.java | 2 +- .../src/test/resources/application.yml | 2 +- 13 files changed, 125 insertions(+), 265 deletions(-) diff --git a/easy-es-annotation/src/main/java/org/dromara/easyes/annotation/IndexId.java b/easy-es-annotation/src/main/java/org/dromara/easyes/annotation/IndexId.java index 524acebd..baf6ad3f 100644 --- a/easy-es-annotation/src/main/java/org/dromara/easyes/annotation/IndexId.java +++ b/easy-es-annotation/src/main/java/org/dromara/easyes/annotation/IndexId.java @@ -32,6 +32,7 @@ public @interface IndexId { /** * 是否将主键写入到source中 + * @return 默认写入 */ - boolean writeToSource() default false; + boolean writeToSource() default true; } diff --git a/easy-es-annotation/src/main/java/org/dromara/easyes/annotation/rely/ISettingsProvider.java b/easy-es-annotation/src/main/java/org/dromara/easyes/annotation/rely/ISettingsProvider.java index 048e1881..175ac1e0 100644 --- a/easy-es-annotation/src/main/java/org/dromara/easyes/annotation/rely/ISettingsProvider.java +++ b/easy-es-annotation/src/main/java/org/dromara/easyes/annotation/rely/ISettingsProvider.java @@ -10,6 +10,7 @@ import co.elastic.clients.elasticsearch.indices.IndexSettings; public interface ISettingsProvider { /** * 获取settings + * @param builder 索引建造者 */ void settings(IndexSettings.Builder builder); } diff --git a/easy-es-common/src/main/java/org/dromara/easyes/common/utils/jackson/JsonUtils.java b/easy-es-common/src/main/java/org/dromara/easyes/common/utils/jackson/JsonUtils.java index 52da2b09..350a5388 100644 --- a/easy-es-common/src/main/java/org/dromara/easyes/common/utils/jackson/JsonUtils.java +++ b/easy-es-common/src/main/java/org/dromara/easyes/common/utils/jackson/JsonUtils.java @@ -42,136 +42,52 @@ public class JsonUtils { return base; } - /** - * 打印字符串 - * - * @param data 数据 - * @return json字符串 - */ public static String toJsonStr(Object data) { return toJsonStr(OM_DEFAULT, data); } - /** - * 字符数组 - * - * @param data 数据 - * @return json字符串 - */ public static byte[] toBytes(Object data) { return toBytes(OM_DEFAULT, data); } - /** - * 格式化打印字符串 - * - * @param data 数据 - * @return json字符串 - */ public static String toJsonPrettyStr(Object data) { return toJsonPrettyStr(OM_DEFAULT, data); } - /** - * 字符串 ==》 bean - * - * @param json 字符串 - * @param type 类型 - * @param 数据泛型 - * @return bean - */ public static T toBean(String json, Class type) { return toBean(OM_DEFAULT, json, type); } - /** - * 字符串 ==》 bean - * - * @param json 字符串 - * @param type 类型 - * @param 数据泛型 - * @return bean - */ public static T toBean(String json, TypeReference type) { return toBean(OM_DEFAULT, json, type); } - /** - * 字符串 ==》 bean - * - * @param json 字符串 - * @param type 类型 - * @param 数据泛型 - * @return bean - */ public static T toBean(String json, Type type) { return toBean(OM_DEFAULT, json, type); } - /** - * 字符串 ==》 List - * - * @param json 字符串 - * @param 数据泛型 - * @return List - */ public static List toList(String json, Class v) { return toList(OM_DEFAULT, json, v); } - /** - * 字符串 ==》 Set - * - * @param json 字符串 - * @param 数据泛型 - * @return Set - */ + public static Set toSet(String json, Class v) { return toSet(OM_DEFAULT, json, v); } - /** - * 字符串 ==》 Map - * - * @param json 字符串 - * @param 键泛型 - * @param 值泛型 - * @return Map - */ + public static Map toMap(String json, Class k, Class v) { return toMap(OM_DEFAULT, json, k, v); } - /** - * 字符串 ==》 集合（Map, List, Set等） - * - * @param json 字符串 - * @param parametrized 主类型 - * @param parameterClasses 类型参数 - * @param 集合泛型 - * @return 集合 - * @throws Exception 异常 - */ public static T toCollection(String json, Class parametrized, Class... parameterClasses) throws Exception { return toCollection(OM_DEFAULT, json, parametrized, parameterClasses); } - /** - * 字符串 ==》 JsonNode - * - * @param json 字符串 - * @return JsonNode - */ public static JsonNode readTree(String json) { return readTree(OM_DEFAULT, json); } - /** - * 打印字符串 - * - * @param data 数据 - * @return json字符串 - */ public static String toJsonStr(ObjectMapper om, Object data) { try { if (data == null) { @@ -184,12 +100,6 @@ public class JsonUtils { } } - /** - * 字符数组 - * - * @param data 数据 - * @return json字符串 - */ public static byte[] toBytes(ObjectMapper om, Object data) { try { if (data == null) { @@ -202,12 +112,7 @@ public class JsonUtils { } } - /** - * 格式化打印字符串 - * - * @param data 数据 - * @return json字符串 - */ + public static String toJsonPrettyStr(ObjectMapper om, Object data) { try { if (data == null) { @@ -220,14 +125,7 @@ public class JsonUtils { } } - /** - * 字符串 ==》 bean - * - * @param json 字符串 - * @param type 类型 - * @param 数据泛型 - * @return bean - */ + public static T toBean(ObjectMapper om, String json, Class type) { try { if (StringUtils.isEmpty(json)) { @@ -240,14 +138,7 @@ public class JsonUtils { } } - /** - * 字符串 ==》 bean - * - * @param json 字符串 - * @param type 类型 - * @param 数据泛型 - * @return bean - */ + public static T toBean(ObjectMapper om, String json, TypeReference type) { try { if (StringUtils.isEmpty(json)) { @@ -260,14 +151,7 @@ public class JsonUtils { } } - /** - * 字符串 ==》 bean - * - * @param json 字符串 - * @param type 类型 - * @param 数据泛型 - * @return bean - */ + public static T toBean(ObjectMapper om, String json, Type type) { try { if (StringUtils.isEmpty(json)) { @@ -280,13 +164,6 @@ public class JsonUtils { } } - /** - * 字符串 ==》 List - * - * @param json 字符串 - * @param 数据泛型 - * @return List - */ public static List toList(ObjectMapper om, String json, Class v) { try { return toCollection(om, json, List.class, v); @@ -296,13 +173,6 @@ public class JsonUtils { } } - /** - * 字符串 ==》 Set - * - * @param json 字符串 - * @param 数据泛型 - * @return Set - */ public static Set toSet(ObjectMapper om, String json, Class v) { try { return toCollection(om, json, Set.class, v); @@ -312,14 +182,6 @@ public class JsonUtils { } } - /** - * 字符串 ==》 Map - * - * @param json 字符串 - * @param 键泛型 - * @param 值泛型 - * @return Map - */ public static Map toMap(ObjectMapper om, String json, Class k, Class v) { try { return toCollection(om, json, Map.class, k, v); @@ -329,16 +191,6 @@ public class JsonUtils { } } - /** - * 字符串 ==》 集合（Map, List, Set等） - * - * @param json 字符串 - * @param parametrized 主类型 - * @param parameterClasses 类型参数 - * @param 集合泛型 - * @return 集合 - * @throws Exception 异常 - */ public static T toCollection(ObjectMapper om, String json, Class parametrized, Class... parameterClasses) throws Exception { if (StringUtils.isEmpty(json)) { return null; @@ -347,12 +199,6 @@ public class JsonUtils { return om.readValue(json, type); } - /** - * 字符串 ==》 JsonNode - * - * @param json 字符串 - * @return JsonNode - */ public static JsonNode readTree(ObjectMapper om, String json) { try { if (StringUtils.isEmpty(json)) { diff --git a/easy-es-core/src/main/java/org/dromara/easyes/core/cache/BaseCache.java b/easy-es-core/src/main/java/org/dromara/easyes/core/cache/BaseCache.java index bced986c..c5f51182 100644 --- a/easy-es-core/src/main/java/org/dromara/easyes/core/cache/BaseCache.java +++ b/easy-es-core/src/main/java/org/dromara/easyes/core/cache/BaseCache.java @@ -30,10 +30,10 @@ public class BaseCache { /** * 初始化mapper缓存 - * * @param mapperInterface mapper接口 - * @param client es客户端 - * @param entityClass 实体类 + * @param entityClass 实体类 + * @param client es客户端 + * @param 泛型 */ public static void initMapperCache(Class mapperInterface, Class entityClass, ElasticsearchClient client) { // 初始化baseEsMapper的所有实现类实例 diff --git a/easy-es-core/src/main/java/org/dromara/easyes/core/conditions/function/Index.java b/easy-es-core/src/main/java/org/dromara/easyes/core/conditions/function/Index.java index ab5ef19e..7c796314 100644 --- a/easy-es-core/src/main/java/org/dromara/easyes/core/conditions/function/Index.java +++ b/easy-es-core/src/main/java/org/dromara/easyes/core/conditions/function/Index.java @@ -23,9 +23,9 @@ public interface Index extends Serializable { /** * 设置索引的分片数和副本数 - * - * @param shards 分片数 + * @param shards 分片数 * @param replicas 副本数 + * @param maxResultWindow 最大返回窗口 * @return wrapper */ Children settings(Integer shards, Integer replicas, Integer maxResultWindow); diff --git a/easy-es-core/src/main/java/org/dromara/easyes/core/kernel/WrapperProcessor.java b/easy-es-core/src/main/java/org/dromara/easyes/core/kernel/WrapperProcessor.java index d9327849..d17228b9 100644 --- a/easy-es-core/src/main/java/org/dromara/easyes/core/kernel/WrapperProcessor.java +++ b/easy-es-core/src/main/java/org/dromara/easyes/core/kernel/WrapperProcessor.java @@ -470,7 +470,9 @@ public class WrapperProcessor { /** * 获取兜底索引名称 - * + * @param entityClass 实体类 + * @param indexName 索引名 + * @param 泛型 * @return 索引名称 */ public static String getIndexName(Class entityClass, String indexName) { @@ -484,7 +486,9 @@ public class WrapperProcessor { /** * 获取兜底索引名称数组 * + * @param entityClass 实体类 * @param indexNames 原始索引名称数组 + * @param 泛型 * @return 目标索引名称数组 */ public static List getIndexName(Class entityClass, String[] indexNames) { @@ -502,8 +506,9 @@ public class WrapperProcessor { /** * 获取兜底索引名称数组 - * + * @param entityClass 实体类 * @param indexNames 原始索引名称数组 + * @param 泛型 * @return 目标索引名称数组 */ public static List getIndexName(Class entityClass, Collection indexNames) { diff --git a/easy-es-core/src/main/java/org/dromara/easyes/core/toolkit/Generator.java b/easy-es-core/src/main/java/org/dromara/easyes/core/toolkit/Generator.java index 9a39eeb5..b8fa32e2 100644 --- a/easy-es-core/src/main/java/org/dromara/easyes/core/toolkit/Generator.java +++ b/easy-es-core/src/main/java/org/dromara/easyes/core/toolkit/Generator.java @@ -34,6 +34,7 @@ public abstract class Generator { * generate model entity 生成实体类 * * @param config 配置 + * @param client 客户端 */ @SneakyThrows public void generateEntity(GeneratorConfig config, ElasticsearchClient client) { diff --git a/easy-es-core/src/main/java/org/dromara/easyes/core/toolkit/GeoUtils.java b/easy-es-core/src/main/java/org/dromara/easyes/core/toolkit/GeoUtils.java index c7529db3..4b200ffa 100644 --- a/easy-es-core/src/main/java/org/dromara/easyes/core/toolkit/GeoUtils.java +++ b/easy-es-core/src/main/java/org/dromara/easyes/core/toolkit/GeoUtils.java @@ -127,9 +127,8 @@ public class GeoUtils { /** * geoJson 转换 - * * @param geometry geometry - * @return Map + * @return map */ public static Map toMap(Geometry geometry) { String geoJsonName = null; @@ -276,6 +275,7 @@ public class GeoUtils { * * @param geometry geometry * @return String + * @throws Exception RuntimeException */ public static String getGeoJsonName(Geometry geometry) throws Exception { return geometry.visit(new GeometryVisitor() { diff --git a/easy-es-core/src/main/java/org/dromara/easyes/core/toolkit/IndexUtils.java b/easy-es-core/src/main/java/org/dromara/easyes/core/toolkit/IndexUtils.java index 33a9cbef..4686994e 100644 --- a/easy-es-core/src/main/java/org/dromara/easyes/core/toolkit/IndexUtils.java +++ b/easy-es-core/src/main/java/org/dromara/easyes/core/toolkit/IndexUtils.java @@ -967,6 +967,7 @@ public class IndexUtils { * 根据配置生成创建索引参数 * * @param entityInfo 配置信息 + * @param clazz 实体类 * @return 创建索引参数 */ public static CreateIndexParam getCreateIndexParam(EntityInfo entityInfo, Class clazz) { @@ -999,6 +1000,7 @@ public class IndexUtils { * * @param entityInfo 实体信息 * @param fieldList 字段列表 + * @param clazz 实体类 * @return 索引参数列表 */ public static List initIndexParam(EntityInfo entityInfo, Class clazz, List fieldList) { diff --git a/easy-es-core/src/main/java/org/dromara/easyes/core/toolkit/PrintUtils.java b/easy-es-core/src/main/java/org/dromara/easyes/core/toolkit/PrintUtils.java index dff94205..1cbc9f88 100644 --- a/easy-es-core/src/main/java/org/dromara/easyes/core/toolkit/PrintUtils.java +++ b/easy-es-core/src/main/java/org/dromara/easyes/core/toolkit/PrintUtils.java @@ -32,6 +32,9 @@ public class PrintUtils { * 参考{@link ElasticsearchTransportBase#prepareTransportRequest(Object, Endpoint)}获取相关数据 * * @param request es请求参数 + * @param 泛型 + * @param 泛型 + * @param 泛型 * @param mapper 序列化mapper */ public static void printDsl(RequestT request, JsonpMapper mapper) { @@ -96,6 +99,7 @@ public class PrintUtils { * * @param request es请求参数 * @param client es客户端 + * @param 泛型 */ public static void printDsl(RequestT request, ElasticsearchClient client) { printDsl(request, client._jsonpMapper()); diff --git a/easy-es-parent/pom.xml b/easy-es-parent/pom.xml index 66a0064d..d1ede771 100644 --- a/easy-es-parent/pom.xml +++ b/easy-es-parent/pom.xml @@ -162,103 +162,103 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + release + + + true + + + + + org.sonatype.central + central-publishing-maven-plugin + 0.5.0 + true + + central + + + + org.apache.maven.plugins + maven-source-plugin + 2.2.1 + + + attach-sources + + jar + + + + - - - - - - - - - - - - - - - - - - + + org.apache.maven.plugins + maven-javadoc-plugin + + UTF-8 + UTF-8 + UTF-8 + + 2.9.1 + + + attach-javadocs + + jar + + + + - - - - - - - - - - - - - - - + + + org.apache.maven.plugins + maven-gpg-plugin + 1.5 + + + sign-artifacts + verify + + sign + + + + - - - - - - - - - - - - - + + + org.apache.maven.plugins + maven-jar-plugin + ${maven-jar-plugin.version} + + + + true + + + + - - - - - - - - - - - - - - - + + + + + + + release + https://oss.sonatype.org/content/repositories/snapshots + + + central + https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/ + + + - + 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 75d3920b..4601f8f5 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 @@ -41,7 +41,7 @@ public class EsAutoConfiguration { /** * 装配ElasticsearchClient - * + * @param easyEsProperties 配置 * @return ElasticsearchClient bean */ @Bean diff --git a/easy-es-springboot-test/src/test/resources/application.yml b/easy-es-springboot-test/src/test/resources/application.yml index bfafedae..c7a729b2 100644 --- a/easy-es-springboot-test/src/test/resources/application.yml +++ b/easy-es-springboot-test/src/test/resources/application.yml @@ -1,6 +1,7 @@ easy-es: # enable: true address: 10.18.2.45:9200 + compatible: true # schema: http # username: elastic # password: mg123456 @@ -25,7 +26,6 @@ easy-es: # address: 10.18.2.45:9200 # 数据源2 #username: '若无可去掉此行' #password: '若无可去掉此行' - compatible: true #logging: # level: # tracer: trace