更新README.md,添加分店端实时聊天功能描述,调整技术栈版本信息,完善项目文档

This commit is contained in:
2025-06-23 01:43:27 +08:00
parent 6974dae845
commit 3a8cc64015

View File

@@ -5,7 +5,7 @@
## 主要功能 ## 主要功能
* **用户端:** 浏览分店、在线点餐、扫码支付、发表评价。 * **用户端:** 浏览分店、在线点餐、扫码支付、发表评价。
* **分店端:** 菜品管理、订单处理、数据统计、评论管理。 * **分店端:** 菜品管理、订单处理、数据统计、评论管理、实时聊天
* **管理后台:** 账户管理、分店信息管理、全局菜品信息管理。 * **管理后台:** 账户管理、分店信息管理、全局菜品信息管理。
## 技术栈 ## 技术栈
@@ -13,15 +13,19 @@
| 技术 | 说明 | 版本 | | 技术 | 说明 | 版本 |
| :--- | :--- | :--- | | :--- | :--- | :--- |
| **Spring Boot** | 核心框架 | `3.5.0` | | **Spring Boot** | 核心框架 | `3.5.0` |
| **Spring Security** | 认证和授权框架 | `6.3.1` (随Spring Boot) | | **Spring Security** | 认证和授权框架 | (随Spring Boot) |
| **Spring WebFlux** | 反应式Web框架 | (随Spring Boot) |
| **Spring WebSocket** | WebSocket支持 | (随Spring Boot) |
| **MyBatis-Plus** | 数据持久层框架 | `3.5.12` | | **MyBatis-Plus** | 数据持久层框架 | `3.5.12` |
| **MySQL** | 关系型数据库 | `8.0+` | | **MySQL** | 关系型数据库 | `8.0.26` |
| **Druid** | 数据库连接池 | `1.2.18` | | **Druid** | 数据库连接池 | `1.2.18` |
| **JWT (jjwt)** | Token认证 | `0.12.6` | | **JWT (jjwt)** | Token认证 | `0.12.6` |
| **Lombok** | 简化Java代码 | `1.18.36`| | **Lombok** | 简化Java代码 | `1.18.36`|
| **Alipay SDK** | 支付宝支付集成 | `4.39.40.ALL`| | **Alipay SDK** | 支付宝支付集成 | `4.39.40.ALL`|
| **Apache POI** | Excel文件操作 | `5.2.3` | | **Apache POI** | Excel文件操作 | `5.2.3` |
| **FastJSON** | JSON处理库 | `2.0.31` | | **FastJSON** | JSON处理库 | `2.0.31` |
| **Google Guava** | Google核心库 | `31.1-jre` |
| **Apache Commons Lang3** | 常用工具类 | `3.12.0` |
| **Amap Web API**| 高德地图Web服务 | `v3` | | **Amap Web API**| 高德地图Web服务 | `v3` |
| **Maven** | 项目构建和管理 | `3.6+` | | **Maven** | 项目构建和管理 | `3.6+` |
@@ -32,7 +36,7 @@ src/
├── main/ ├── main/
│ ├── java/com/example/javatest/ │ ├── java/com/example/javatest/
│ │ ├── JavaTestApplication.java # 主启动类 │ │ ├── JavaTestApplication.java # 主启动类
│ │ ├── config/ # 系统配置 (Security, Mybatis, CORS等) │ │ ├── config/ # 系统配置 (Security, Mybatis, CORS, WebSocket等)
│ │ ├── Controller/ │ │ ├── Controller/
│ │ │ ├── admin/ # 管理后台接口 │ │ │ ├── admin/ # 管理后台接口
│ │ │ ├── branch/ # 分店端接口 │ │ │ ├── branch/ # 分店端接口
@@ -89,12 +93,14 @@ cd java-beta
详细的API接口说明请参考项目中的文档 详细的API接口说明请参考项目中的文档
- [**分店端API文档**](./Branch_API_DOC.md) - `餐厅管理系统实体类设计文档.md`
- 暂未提供在线API文档请参考Controller层代码。
## 功能特性 ## 功能特性
-**多角色支持:** 内置用户、分店、管理员三种角色,权限分明。 -**多角色支持:** 内置用户、分店、管理员三种角色,权限分明。
-**认证授权:** 基于Spring Security和JWT保障接口安全。 -**认证授权:** 基于Spring Security和JWT保障接口安全。
-**实时通信:** 集成WebSocket支持分店与用户间的实时消息传递。
-**CRUD操作:** 提供完整的增删改查接口。 -**CRUD操作:** 提供完整的增删改查接口。
-**分页与筛选:** 支持对列表数据进行分页和多条件查询。 -**分页与筛选:** 支持对列表数据进行分页和多条件查询。
-**在线支付:** 集成支付宝SDK支持在线下单支付。 -**在线支付:** 集成支付宝SDK支持在线下单支付。