From 446c44b606804c4aacf4a0022fc2361df31207a6 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Wed, 9 Jul 2025 08:28:37 +0000 Subject: [PATCH] Update README.md --- README.md | 99 +++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 86 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index fcc041f..0726b7c 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,96 @@ +该项目是一个基于 Spring Boot 和 MyBatis-Plus 的复杂查询示例,适用于构建灵活的后端查询接口。以下是项目的 README.md 文件内容: + +--- + # springboot-mbp-complex-query -#### 介绍 -一个基于 Spring Boot 和 MyBatis-Plus 实现复杂查询接口的示例。这个接口支持多种查询条件组合,包括等于、不等于、大于、小于、In、Not in、Like 等,支持复杂的 AND/OR 嵌套查询,支持多字段排序,支持升序 / 降序,支持自然排序(针对包含数字的字符串) +## 介绍 + +本项目演示了如何使用 Spring Boot 和 MyBatis-Plus 实现复杂的动态查询功能。通过封装通用查询逻辑,支持多条件组合查询和排序功能,适用于构建灵活的后端数据接口。 + +主要技术栈: +- Spring Boot +- MyBatis-Plus +- Java 17+ + +## 安装教程 + +1. **克隆项目:** + + ```bash + git clone + ``` + +2. **进入项目目录:** + + ```bash + cd springboot-mbp-complex-query + ``` + +3. **配置数据库连接:** + + 修改 `application.yml` 文件中的数据库连接信息,包括 URL、用户名和密码。 + +4. **运行项目:** + + ```bash + mvn spring-boot:run + ``` + + 或者使用 IDE 直接运行 `DemoApplication.java`。 + +## 使用说明 + +### 查询接口 +请求地址:`POST /api/question/query` -#### 安装教程 +请求参数(JSON 格式): +```json +{ + "queryGroup": { + "connector": "AND", + "conditions": [ + { + "field": "name", + "operator": "like", + "value": "问题" + }, + { + "field": "type", + "operator": "=", + "value": "单选题" + } + ] + }, + "pageNum": 1, + "pageSize": 10, + "sortInfos": [ + { + "field": "createTime", + "direction": "desc" + } + ] +} +``` -1. 拷贝项目中的com.example.demo.mbp包到自有项目 +### 支持的查询操作符 +- `=`、`!=`、`>`、`>=`、`<`、`<=` +- `like`、`not like` +- `in`、`not in` -#### 使用说明 +### 支持的排序选项 +- 支持按字段排序,可指定升序或降序。 +- 支持忽略大小写和自然排序选项。 -1. 拷贝项目中的com.example.demo.mbp包到自有项目 -2. 结成BaseService -3. 调用queryByCondition方法 +## 参与贡献 -#### 参与贡献 +欢迎提交 Issue 和 Pull Request!请遵循以下步骤: +1. Fork 项目。 +2. 创建新分支。 +3. 提交代码更改。 +4. 发起 Pull Request。 -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request +--- +该项目提供了一个可扩展的查询框架,可根据实际需求进一步扩展支持的查询条件和字段。 \ No newline at end of file -- Gitee