+
+
+
+
+
+
+ 为简化开发工作、提高生产效率而生 +
+ + + +# 简介 | Intro + +Easy-Es是一款简化ElasticSearch搜索引擎操作的开源框架,简化`CRUD`操作,可以更好的帮助开发者减轻开发负担 + +底层采用Es官方提供的RestHighLevelClient,保证其原生性能及拓展性. + +技术讨论 QQ 群 ：247637156 + +# 优点 | Advantages + +- **屏蔽语言差异:** 开发者只需要会MySQL语法即可使用Es + +- **低码:** 与直接使用RestHighLevelClient相比,相同的查询平均可以节3-5倍左右的代码量 +- **零魔法值:** 字段名称直接从实体中获取,无需输入字段名称字符串这种魔法值 +- **零额外学习成本:** 开发者只要会国内最受欢迎的Mybatis-Plus语法,即可无缝迁移至Easy-Es +- **降低开发者门槛:** 即便是只了解ES基础的初学者也可以轻松驾驭ES完成绝大多数需求的开发 +- **...** + +## 对比 | Compare +> 需求:查询出文档标题为 "中国功夫"且作者为"老汉"的所有文档 +```java +// 使用Easy-Es仅需3行代码即可完成查询 +LambdaEsQueryWrapper- 为简化开发工作、提高生产效率而生 + Born To Simplify Development
@@ -18,40 +18,47 @@
-# 简介 | Intro +## What is Easy-Es? -Easy-Es是一款简化ElasticSearch搜索引擎操作的开源框架,简化`CRUD`操作,可以更好的帮助开发者减轻开发负担 +Easy-Es is a powerfully enhanced toolkit of RestHighLevelClient for simplify development. This toolkit provides some efficient, useful, out-of-the-box features for ElasticSearch. By using Easy-Es, you can use MySQL syntax to complete Es queries. Use it can effectively save your development time. -底层采用Es官方提供的RestHighLevelClient,保证其原生性能及拓展性 -技术讨论 QQ 群 ： 待定 +## Links +- [中文版](https://github.com/xpc1024/easy-es/blob/main/README-ZH.md) +- [Documentation](https://www.yuque.com/laohan-14b9d/foyrfa/naw1ie) +- [Samples](https://github.com/xpc1024/easy-es/tree/main/easy-es-sample) +- [Demo in Springboot](https://github.com/xpc1024/easy-es-springboot-demo-en) -# 优点 | Advantages +## Features + +- Auto configuration on startup +- Out-of-the-box interfaces for operate es +- Powerful and flexible where condition wrapper +- Lambda-style API +- Automatic paging operation +- Support high-level syntax such as highlighting and weighting +- ... + +## Compare + +> Demand: Query all documents with title equals "Hi" and author equals "Guy" -- **屏蔽语言差异:** 开发者只需要会MySQL语法即可使用Es -- **低码:** 与直接使用RestHighLevelClient相比,相同的查询平均可以节3-5倍左右的代码量 -- **零魔法值:** 字段名称直接从实体中获取,无需输入字段名称字符串这种魔法值 -- **零额外学习成本:** 开发者只要会国内最受欢迎的Mybatis-Plus语法,即可无缝迁移至Easy-Es -- **降低开发者门槛:** 即便是只了解ES基础的初学者也可以轻松驾驭ES完成绝大多数需求的开发 -- **...** -## 对比 | Compare -> 需求:查询出文档标题为 "中国功夫"且作者为"老汉"的所有文档 ```java -// 使用Easy-Es仅需3行代码即可完成查询 +// Use Easy-Es to complete the query with only 3 lines of code LambdaEsQueryWrapper+ * Copyright © 2021 xpc1024 All Rights Reserved + **/ +@Documented +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.TYPE) +@Import(MapperScannerRegister.class) +public @interface EsMapperScan { + String value(); +} diff --git a/easy-es-boot-starter/src/main/java/com/xpc/easyes/autoconfig/config/EsAutoConfiguration.java b/easy-es-boot-starter/src/main/java/com/xpc/easyes/autoconfig/config/EsAutoConfiguration.java new file mode 100644 index 00000000..60222e20 --- /dev/null +++ b/easy-es-boot-starter/src/main/java/com/xpc/easyes/autoconfig/config/EsAutoConfiguration.java @@ -0,0 +1,106 @@ +package com.xpc.easyes.autoconfig.config; + +import com.xpc.easyes.autoconfig.constants.PropertyKeyConstants; +import com.xpc.easyes.core.cache.GlobalConfigCache; +import com.xpc.easyes.core.config.GlobalConfig; +import com.xpc.easyes.core.enums.FieldStrategy; +import com.xpc.easyes.core.enums.IdType; +import com.xpc.easyes.core.toolkit.ExceptionUtils; +import com.xpc.easyes.core.toolkit.StringUtils; +import org.apache.http.HttpHost; +import org.apache.http.auth.AuthScope; +import org.apache.http.auth.UsernamePasswordCredentials; +import org.apache.http.client.CredentialsProvider; +import org.apache.http.impl.client.BasicCredentialsProvider; +import org.elasticsearch.client.RestClient; +import org.elasticsearch.client.RestClientBuilder; +import org.elasticsearch.client.RestHighLevelClient; +import org.springframework.beans.factory.InitializingBean; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.context.EnvironmentAware; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.core.env.Environment; + +import java.util.*; + +import static com.xpc.easyes.core.constants.BaseEsConstants.COLON; +import static com.xpc.easyes.core.constants.BaseEsConstants.DEFAULT_SCHEMA; + +/** + * es自动配置 + *
+ * Copyright © 2021 xpc1024 All Rights Reserved
+ **/
+@Configuration
+@EnableConfigurationProperties(EsConfigProperties.class)
+@ConditionalOnClass(RestHighLevelClient.class)
+@ConditionalOnProperty(prefix = "easy-es", name = {"enable"}, havingValue = "true", matchIfMissing = true)
+public class EsAutoConfiguration implements InitializingBean, EnvironmentAware, PropertyKeyConstants {
+ @Autowired
+ private EsConfigProperties esConfigProperties;
+ private Environment environment;
+
+ @Override
+ public void setEnvironment(Environment environment) {
+ this.environment = environment;
+ }
+
+ @Bean
+ @ConditionalOnMissingBean
+ public RestHighLevelClient restHighLevelClient() {
+ // 处理地址
+ String address = environment.getProperty(ADDRESS);
+ if (StringUtils.isEmpty(address)) {
+ throw ExceptionUtils.eee("please config the es address");
+ }
+ if (!address.contains(COLON)) {
+ throw ExceptionUtils.eee("the address must contains port and separate by ':'");
+ }
+ String schema = StringUtils.isEmpty(esConfigProperties.getSchema())
+ ? DEFAULT_SCHEMA : esConfigProperties.getSchema();
+ List
+ * Copyright © 2021 xpc1024 All Rights Reserved
+ **/
+@Data
+@ConfigurationProperties(prefix = "easy-es")
+public class EsConfigProperties {
+ /**
+ * es 连接地址
+ */
+ private String address;
+ /**
+ * 模式
+ */
+ private String schema;
+ /**
+ * 用户名
+ */
+ private String username;
+ /**
+ * 密码 可缺省
+ */
+ private String password;
+}
diff --git a/easy-es-boot-starter/src/main/java/com/xpc/easyes/autoconfig/constants/PropertyKeyConstants.java b/easy-es-boot-starter/src/main/java/com/xpc/easyes/autoconfig/constants/PropertyKeyConstants.java
new file mode 100644
index 00000000..0f58c7fb
--- /dev/null
+++ b/easy-es-boot-starter/src/main/java/com/xpc/easyes/autoconfig/constants/PropertyKeyConstants.java
@@ -0,0 +1,41 @@
+package com.xpc.easyes.autoconfig.constants;
+
+/**
+ * 属性key常量
+ *
+ * Copyright © 2021 xpc1024 All Rights Reserved
+ **/
+public interface PropertyKeyConstants {
+ /**
+ * es 地址
+ */
+ String ADDRESS = "easy-es.address";
+ /**
+ * 属性
+ */
+ String SCHEMA = "easy-es.schema";
+ /**
+ * es用户名
+ */
+ String USERNAME = "easy-es.username";
+ /**
+ * es密码
+ */
+ String PASSWORD = "easy-es.password";
+ /**
+ * 框架banner是否展示
+ */
+ String BANNER = "easy-es.global-config.db-config.banner";
+ /**
+ * es索引前缀
+ */
+ String TABLE_PREFIX = "easy-es.global-config.db-config.table-prefix";
+ /**
+ * es id类型
+ */
+ String ID_TYPE = "easy-es.global-config.db-config.id-type";
+ /**
+ * es 字段策略
+ */
+ String FIELD_STRATEGY = "easy-es.global-config.db-config.field-strategy";
+}
diff --git a/easy-es-boot-starter/src/main/java/com/xpc/easyes/autoconfig/register/ClassPathMapperScanner.java b/easy-es-boot-starter/src/main/java/com/xpc/easyes/autoconfig/register/ClassPathMapperScanner.java
new file mode 100644
index 00000000..410505a8
--- /dev/null
+++ b/easy-es-boot-starter/src/main/java/com/xpc/easyes/autoconfig/register/ClassPathMapperScanner.java
@@ -0,0 +1,90 @@
+package com.xpc.easyes.autoconfig.register;
+
+import org.springframework.beans.factory.annotation.AnnotatedBeanDefinition;
+import org.springframework.beans.factory.config.BeanDefinition;
+import org.springframework.beans.factory.config.BeanDefinitionHolder;
+import org.springframework.beans.factory.support.AbstractBeanDefinition;
+import org.springframework.beans.factory.support.BeanDefinitionRegistry;
+import org.springframework.beans.factory.support.GenericBeanDefinition;
+import org.springframework.context.annotation.ClassPathBeanDefinitionScanner;
+
+import java.util.Arrays;
+import java.util.Set;
+
+/**
+ * 扫描指定路径下的所有接口
+ *
+ * Copyright © 2021 xpc1024 All Rights Reserved
+ **/
+public class ClassPathMapperScanner extends ClassPathBeanDefinitionScanner {
+ private MapperFactoryBean mapperFactoryBean = new MapperFactoryBean<>();
+
+ public void setMapperFactoryBean(MapperFactoryBean mapperFactoryBean) {
+ this.mapperFactoryBean = mapperFactoryBean != null ? mapperFactoryBean : new MapperFactoryBean<>();
+ }
+
+ public ClassPathMapperScanner(BeanDefinitionRegistry registry) {
+ super(registry, false);
+ }
+
+ public void registerFilters() {
+ // default include filter that accepts all classes
+ addIncludeFilter((metadataReader, metadataReaderFactory) -> true);
+
+ // exclude package-info.java
+ addExcludeFilter((metadataReader, metadataReaderFactory) -> {
+ String className = metadataReader.getClassMetadata().getClassName();
+ return className.endsWith("package-info");
+ });
+ }
+
+ @Override
+ public Set
+ * Copyright © 2021 xpc1024 All Rights Reserved
+ **/
+public class MapperFactoryBean
+ * Copyright © 2021 xpc1024 All Rights Reserved
+ **/
+public class MapperScannerRegister implements ImportBeanDefinitionRegistrar, ResourceLoaderAware {
+ private ResourceLoader resourceLoader;
+
+ @Override
+ public void setResourceLoader(ResourceLoader resourceLoader) {
+ this.resourceLoader = resourceLoader;
+ }
+
+ @Override
+ public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
+ AnnotationAttributes mapperScanAttrs = AnnotationAttributes
+ .fromMap(importingClassMetadata.getAnnotationAttributes(EsMapperScan.class.getName()));
+ if (mapperScanAttrs != null) {
+ registerBeanDefinitions(mapperScanAttrs, registry);
+ }
+ }
+
+ void registerBeanDefinitions(AnnotationAttributes annoAttrs, BeanDefinitionRegistry registry) {
+ ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);
+ // this check is needed in Spring 3.1
+ Optional.ofNullable(resourceLoader).ifPresent(scanner::setResourceLoader);
+
+ List
+ 
+