v2.0.0-beta6

Author: xpc1024

easy-es-annotation/src/main/java/org/dromara/easyes/annotation/Join.java

@@ -0,0 +1,38 @@
+package org.dromara.easyes.annotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import static org.dromara.easyes.annotation.rely.AnnotationConstants.DEFAULT_JOIN_FIELD_NAME;
+
+/**
+ * 父子类型
+ * <p>
+ * Copyright © 2024 xpc1024 All Rights Reserved
+ **/
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+public @interface Join {
+    /**
+     * join字段在es中的名字
+     *
+     * @return 索引中的join字段名称 默认为joinField
+     */
+    String joinField() default DEFAULT_JOIN_FIELD_NAME;
+
+    /**
+     * 根节点别名 不指定则默认使用加了当前注解的根类的名称小写作为根节点别名(推荐)
+     *
+     * @return 根节点别名
+     */
+    String rootAlias() default "";
+
+    /**
+     * 非根节点
+     *
+     * @return 非根节点列表
+     */
+    Node[] nodes() default {};
+}

easy-es-annotation/src/main/java/org/dromara/easyes/annotation/Node.java

@@ -0,0 +1,43 @@
+package org.dromara.easyes.annotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * 父子类型
+ * <p>
+ * Copyright © 2024 xpc1024 All Rights Reserved
+ **/
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ElementType.ANNOTATION_TYPE, ElementType.TYPE})
+public @interface Node {
+    /**
+     * 父文档别名 非必填,不指定时默认值为parentClass类名小写(推荐)
+     *
+     * @return 父文档别名
+     */
+    String parentAlias() default "";
+
+    /**
+     * 父文档实体类,必填项
+     *
+     * @return 父文档实体类
+     */
+    Class<?> parentClass();
+
+    /**
+     * 子文档别名列表,不指定则为子文档类名小写列表(推荐) 若要自定义必须与childClasses数量和顺序一致
+     *
+     * @return 子文档别名列表 非必填,默认值为子文档类名小写列表
+     */
+    String[] childAliases() default {};
+
+    /**
+     * 子文档实体类列表,必填项
+     *
+     * @return 子文档实体类列表
+     */
+    Class<?>[] childClasses();
+}

easy-es-annotation/src/main/java/org/dromara/easyes/annotation/Settings.java

@@ -0,0 +1,54 @@
+package org.dromara.easyes.annotation;
+
+import org.dromara.easyes.annotation.rely.DefaultSettingsProvider;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import static org.dromara.easyes.annotation.rely.AnnotationConstants.*;
+
+/**
+ * es 索引 settings
+ * <p>
+ * Copyright © 2024 xpc1024 All Rights Reserved
+ **/
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+public @interface Settings {
+    /**
+     * 分片数
+     *
+     * @return 默认为1
+     */
+    int shardsNum() default DEFAULT_SHARDS;
+
+    /**
+     * 副本数
+     *
+     * @return 默认为1
+     */
+    int replicasNum() default DEFAULT_REPLICAS;
+
+    /**
+     * 默认最大返回数
+     *
+     * @return 默认1w条
+     */
+    int maxResultWindow() default DEFAULT_MAX_RESULT_WINDOW;
+
+    /**
+     * 索引的刷新间隔 es默认值为1s ms：表示毫秒 s：表示秒 m：表示分钟
+     *
+     * @return 索引的刷新间隔
+     */
+    String refreshInterval() default "";
+
+    /**
+     * 自定义settings提供类
+     *
+     * @return 自定义settings提供类 默认为DefaultSettingsProvider空实现 如需自定义,可继承此类并覆写getSettings方法 将settings信息以Map返回
+     */
+    Class<? extends DefaultSettingsProvider> settingsProvider() default DefaultSettingsProvider.class;
+}

easy-es-annotation/src/main/java/org/dromara/easyes/annotation/rely/DefaultSettingsProvider.java

@@ -0,0 +1,16 @@
+package org.dromara.easyes.annotation.rely;
+
+import java.util.Collections;
+import java.util.Map;
+
+/**
+ * es 索引 默认settings 如需拓展须继承此类并覆写getSettings方法提供自定义索引settings实现
+ * <p>
+ * Copyright © 2024 xpc1024 All Rights Reserved
+ **/
+public class DefaultSettingsProvider implements ISettingsProvider {
+    @Override
+    public Map<String, Object> getSettings() {
+        return Collections.emptyMap();
+    }
+}

easy-es-annotation/src/main/java/org/dromara/easyes/annotation/rely/ISettingsProvider.java

@@ -0,0 +1,17 @@
+package org.dromara.easyes.annotation.rely;
+
+import java.util.Map;
+
+/**
+ * es 索引 settings 提供接口
+ * <p>
+ * Copyright © 2024 xpc1024 All Rights Reserved
+ **/
+public interface ISettingsProvider {
+    /**
+     * 获取settings
+     *
+     * @return settingsMap
+     */
+    Map<String, Object> getSettings();
+}

easy-es-test/src/main/java/org/dromara/easyes/test/entity/Author.java

@@ -0,0 +1,27 @@
+package org.dromara.easyes.test.entity;
+
+
+import lombok.Data;
+import org.dromara.easyes.annotation.IndexField;
+import org.dromara.easyes.annotation.IndexId;
+import org.dromara.easyes.annotation.rely.FieldType;
+
+
+/**
+ * 作者 数据模型 Document的子文档,Document是其父文档
+ * <p>
+ * Copyright © 2024 xpc1024 All Rights Reserved
+ **/
+@Data
+public class Author {
+    /**
+     * 作者id
+     */
+    @IndexId
+    private String authorId;
+    /**
+     * 作者姓名
+     */
+    @IndexField(fieldType = FieldType.KEYWORD)
+    private String authorName;
+}

easy-es-test/src/main/java/org/dromara/easyes/test/entity/Contact.java

@@ -0,0 +1,27 @@
+package org.dromara.easyes.test.entity;
+
+
+import lombok.Data;
+import org.dromara.easyes.annotation.IndexField;
+import org.dromara.easyes.annotation.IndexId;
+import org.dromara.easyes.annotation.rely.FieldType;
+
+
+/**
+ * 联系方式 数据模型 Author的子文档,Author是其父文档,Document是其爷文档
+ * <p>
+ * Copyright © 2024 xpc1024 All Rights Reserved
+ **/
+@Data
+public class Contact {
+    /**
+     * 联系人id
+     */
+    @IndexId
+    private String contactId;
+    /**
+     * 地址
+     */
+    @IndexField(fieldType = FieldType.TEXT)
+    private String address;
+}

easy-es-test/src/main/java/org/dromara/easyes/test/mapper/AuthorMapper.java

@@ -0,0 +1,15 @@
+package org.dromara.easyes.test.mapper;
+
+
+import org.dromara.easyes.annotation.EsDS;
+import org.dromara.easyes.core.core.BaseEsMapper;
+import org.dromara.easyes.test.entity.Author;
+
+/**
+ * 父子类型-子文档的mapper
+ * <p>
+ * Copyright © 2024 xpc1024 All Rights Reserved
+ **/
+@EsDS("ds1")
+public interface AuthorMapper extends BaseEsMapper<Author> {
+}

easy-es-test/src/main/java/org/dromara/easyes/test/mapper/ContactMapper.java

@@ -0,0 +1,15 @@
+package org.dromara.easyes.test.mapper;
+
+
+import org.dromara.easyes.annotation.EsDS;
+import org.dromara.easyes.core.core.BaseEsMapper;
+import org.dromara.easyes.test.entity.Contact;
+
+/**
+ * 父子类型-子文档的mapper
+ * <p>
+ * Copyright © 2024 xpc1024 All Rights Reserved
+ **/
+@EsDS("ds1")
+public interface ContactMapper extends BaseEsMapper<Contact> {
+}

easy-es-test/src/main/java/org/dromara/easyes/test/settings/MySettingsProvider.java

@@ -0,0 +1,22 @@
+package org.dromara.easyes.test.settings;
+
+import org.dromara.easyes.annotation.rely.DefaultSettingsProvider;
+
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * 由于es索引的settings灵活多变,框架只能针对一部分场景作简化,其余场景需要用户自定义实现
+ * <p>
+ * Copyright © 2024 xpc1024 All Rights Reserved
+ **/
+public class MySettingsProvider extends DefaultSettingsProvider {
+    @Override
+    public Map<String, Object> getSettings() {
+        // TODO 这里可以自定义你的settings实现,将自定义的settings置入map并返回即可
+        Map<String, Object> mySettings = new HashMap<>();
+        // 例如指定查询操作的慢日志阈值为30秒,当查询操作的执行时间超过此阈值时，Elasticsearch会记录相应的慢日志并发出警告
+        mySettings.put("index.search.slowlog.threshold.query.warn", "30s");
+        return mySettings;
+    }
+}