tjx
2025-11-10 f2620a59a4e12ee645a659bf2d501e87baf5c60d
README.md
@@ -1,2 +1,174 @@
# gs-simple
# LBKBSql_Service - 菜单管理系统
基于 Spring Boot 3.1.5 的菜单管理服务,提供树形结构的菜单数据管理和查询功能。
## 技术栈
- **Spring Boot** 3.1.5
- **Java** 17
- **SQL Server** 2019
- **MyBatis Plus** 3.5.6
- **Druid** 连接池
- **Lombok** 简化代码
## 快速开始
### 1️⃣ 打包项目
```bash
mvn clean package -DskipTests
```
### 2️⃣ 修改配置
编辑 `startup.bat` 中的数据库配置:
```bat
set DB_HOST=192.168.0.51        # 数据库IP
set DB_PORT=1433                # 数据库端口
set DB_NAME=TEST_MES            # 数据库名
set DB_USERNAME=sa              # 用户名
set DB_PASSWORD=LanBao@2025     # 密码
```
### 3️⃣ 启动应用
```bash
# Windows
startup.bat
# 或者一键开发启动(自动编译+启动)
dev-start.bat
```
### 4️⃣ 访问接口
```
http://localhost:9091/simple/getTree    # 获取菜单树
http://localhost:9091/simple/list       # 获取菜单列表
```
## 📖 文档
- **[快速开始.txt](快速开始.txt)** - 3分钟快速部署指南
- **[使用手册.md](使用手册.md)** - 完整使用文档(配置、部署、API、FAQ)
- **[CLAUDE.md](CLAUDE.md)** - 开发者指南(架构、命令、技术细节)
## 项目结构
```
LBKBSql_Service/
├── src/
│   ├── main/
│   │   ├── java/com/gs/simple/
│   │   │   ├── controller/      # REST控制器
│   │   │   ├── service/          # 业务逻辑层
│   │   │   ├── mapper/           # MyBatis Mapper
│   │   │   ├── domain/           # 实体类
│   │   │   └── common/           # 通用工具类
│   │   └── resources/
│   │       ├── mapper/           # MyBatis XML
│   │       └── application.yml   # 配置文件
│   └── test/                     # 测试代码
├── startup.bat                   # 启动脚本(推荐)
├── dev-start.bat                 # 开发启动脚本
├── MES_SIMPLE_CREATE_TABLE.sql   # 菜单表建表脚本
├── MES_SIMPLE_CCB_CREATE_TABLE.sql  # BiView表建表脚本
└── pom.xml                       # Maven配置
```
## 主要功能
✅ 树形菜单结构管理
✅ 多级菜单数据查询
✅ 菜单权限控制
✅ 动态数据库配置
✅ RESTful API接口
✅ 跨域请求支持
## API 接口
### 获取菜单树
```http
POST /simple/getTree
```
返回树形结构的菜单数据,包含父子层级关系。
### 获取菜单列表
```http
POST /simple/list
```
返回平铺的菜单列表数据。
## 数据库初始化
首次部署需要执行以下SQL脚本创建数据表:
```sql
-- 1. 菜单维护表
source MES_SIMPLE_CREATE_TABLE.sql
-- 2. BiView数据表
source MES_SIMPLE_CCB_CREATE_TABLE.sql
```
## 配置说明
应用配置在 `application.yml` 中,支持通过 JVM 参数覆盖:
```bash
java -jar simple.jar \
  -Dspring.datasource.url="jdbc:sqlserver://HOST:PORT;..." \
  -Dspring.datasource.username=USER \
  -Dspring.datasource.password=PASS \
  -Dserver.port=9091
```
## 开发环境
### 运行开发模式
```bash
mvn spring-boot:run
```
### 运行测试
```bash
mvn test
```
### 构建生产包
```bash
mvn clean package -DskipTests
```
## 常见问题
**Q: 端口被占用怎么办?**
A: 修改 `startup.bat` 添加 `-Dserver.port=8080` 更改端口
**Q: 数据库连接失败?**
A: 检查数据库服务、防火墙、TCP/IP连接是否启用
**Q: 找不到JAR文件?**
A: 确保先执行 `mvn clean package` 生成JAR包
更多问题请查看 [使用手册.md](使用手册.md)
## 版本信息
- **版本**: 1.0.2-SNAPSHOT
- **端口**: 9091
- **编码**: UTF-8
## License
Copyright © 2023-2024