# easy-es-sql-extend

**Repository Path**: cocoknight/easy-es-sql-extend

## Basic Information

- **Project Name**: easy-es-sql-extend
- **Description**: easy-es扩展，借用mybatisplus的QueryWrapper生成的sql进行executeSQL查询
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-15
- **Last Updated**: 2025-10-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# easy-es-sql-extend

`easy-es-sql-extend` 是一个基于 Java 的扩展项目，旨在简化 Elasticsearch 和 MyBatis-Plus 的集成使用，提供便捷的数据库与搜索引擎操作接口。该项目适用于需要快速构建支持复杂查询和高效数据检索的 Spring Boot 应用程序。

## 功能亮点

- **Elasticsearch 集成**：通过 `EasyEs` 提供对 Elasticsearch 的便捷访问，支持实体映射、查询构建等功能。
- **MyBatis-Plus 支持**：集成了 MyBatis-Plus，简化了数据库操作，包括自动分页、条件查询等。
- **动态 SQL 生成**：支持通过 `QueryWrapper` 动态生成 SQL 语句，提高开发效率。
- **日志与追踪**：提供了 API 访问日志记录和请求链路追踪功能，便于调试和监控。
- **通用响应结构**：统一的响应格式 `R<T>`，方便前后端交互。

## 安装与配置

1. **依赖管理**：确保你的项目中已包含 Spring Boot、MyBatis-Plus 和 Elasticsearch 的相关依赖。
2. **配置文件**：根据你的环境修改 `application.yml` 或 `application-dev.yml` 中的数据库和 Elasticsearch 配置。
3. **启动类**：确保主类 `EasyEsSqlExtendApplication` 被正确标注为 `@SpringBootApplication`。

## 使用示例

### 查询数据

```java
// 使用 QueryWrapper 构建查询条件
QueryWrapper<YourEntity> wrapper = new QueryWrapper<>();
wrapper.eq("column_name", "value");

// 获取查询结果
List<YourEntity> results = MybatisPlusUtil.getService(YourEntity.class).list(wrapper);
```

### 操作 Elasticsearch

```java
// 获取 Elasticsearch Mapper
BaseEsMapper<YourEsEntity> esMapper = EsUtils.getMapper(YourEsEntity.class);

// 执行查询
List<YourEsEntity> esResults = esMapper.selectList(wrapper);
```

### 返回统一格式的数据

```java
// 成功响应
return R.success(results);

// 错误响应
return R.error("查询失败");
```

## 贡献指南

欢迎贡献代码和改进文档。请遵循以下步骤：

1. Fork 本仓库。
2. 创建新分支 (`git checkout -b feature/new-feature`)。
3. 提交更改 (`git commit -am 'Add some feature'`)。
4. 推送至分支 (`git push origin feature/new-feature`)。
5. 创建 Pull Request。

## 许可证

本项目采用 Apache2.0 许可证。详情请查看 LICENSE 文件。