# essop

**Repository Path**: dbsop/essop

## Basic Information

- **Project Name**: essop
- **Description**: 数据库操作集
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 2
- **Created**: 2020-10-10
- **Last Updated**: 2021-09-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# essop

#### 介绍
一款ES 简单操作使用的组件,类似于mybatis-plus 操作数据库一样去使用;
此版本基于ES 7.0.1 进行封装; 有tcp 与 http 两种使用模式

#### 软件架构
暂无


#### 安装教程

1.  对项目进行打包; 
    执行 mvn clean package 
    将 es-opt-core 模块下的jar 进行复制到项目进行引用
2.  使用方式:
    引入依赖)
    
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>fastjson</artifactId>
                <version>1.2.56</version>
            </dependency>
            
    将es-opt-core 引入之后 
    如果使用的是http 端口 则引入
    
            <dependency>
                 <groupId>org.elasticsearch.client</groupId>
                 <artifactId>elasticsearch-rest-high-level-client</artifactId>
                 <version>${elasticsearch.version}</version>
             </dependency>
             
    如果使用到的是 tcp 端口 则引入 
    
            <dependency>
                <groupId>org.elasticsearch</groupId>
                <artifactId>elasticsearch</artifactId>
                <version>${elasticsearch.version}</version>
            </dependency>
            <dependency>
                <groupId>org.elasticsearch.client</groupId>
                <artifactId>transport</artifactId>
                <version>${elasticsearch.version}</version>
            </dependency>
    
            <dependency>
                <groupId>org.elasticsearch.plugin</groupId>
                <artifactId>transport-netty4-client</artifactId>
                <version>${elasticsearch.version}</version>
            </dependency>
            
3.  配置文件
```
    elasticsearch:
      use_type: tcp  # 使用类型 tcp , http 
      transport:
        hosts: # tcp 的地址配置
          - ${const.ip}:9310
        clusterName: yth # 集群名称配置
        setting:
          client.transport.ping_timeout: 30s
      http:
        hosts:
          - ${const.ip}:9200 # http 地址配置
        setting:
          client.transport.ping_timeout: 30s
```

4.  加载配置 
    spring boot 项目:
```java
        @Component
        @Configuration
        public class EsBeanLoad {
        
            @Bean
            @Order(Integer.MIN_VALUE)
            @ConfigurationProperties(prefix = "elasticsearch")
            public EsClientConfig getEsClientConfig(){
                return new EsClientConfig();
            }
        
        
            @Bean
            @Order(Integer.MIN_VALUE)
            public EsClient initEsClient(EsClientConfig esClientConfig,
                                         List<ESBaseMapper> esBaseMappers){
                EsOperation.run(esClientConfig,esBaseMappers);
                return EsClient.getEsClient();
            }
        }
```
   非spring boot 项目:
   手动配置
   ```java EsClientConfig esClientConfig``` 文件; 并将继承 ```java ESBaseMapper ``` 的类 进行单例配置;
   并且使用  ```java EsOperation.run(esClientConfig,esBaseMappers);```
进行初始化
    
#### 文档介绍
1.  [注解说明](./anthorizatiion.md)
2.  [ESCondition](./es_condition.md) 介绍
3.  [EsAggCondition](./agg_condition.md) 介绍
4.  [BaseMapper](./base_mapper.md) 介绍