190 lines
5.4 KiB
Plaintext
190 lines
5.4 KiB
Plaintext
|
========================================
|
|||
|
|
瑞来兹医助管理系统 - 项目文档（简化版）
|
|||
|
|
========================================
|
|||
|
|
|
|||
|
|
一、项目概述
|
|||
|
|
-----------
|
|||
|
|
项目名称：瑞来兹医助管理系统
|
|||
|
|
项目版本：3.8.3
|
|||
|
|
框架基础：RuoYi前后端分离框架
|
|||
|
|
项目描述：基于SpringBoot+Vue前后端分离的Java快速开发框架
|
|||
|
|
|
|||
|
|
二、技术架构
|
|||
|
|
-----------
|
|||
|
|
【后端技术栈】
|
|||
|
|
- 核心框架：Spring Boot 2.5.14
|
|||
|
|
- 安全框架：Spring Security + JWT
|
|||
|
|
- 持久层框架：MyBatis
|
|||
|
|
- 数据库连接池：Druid 1.2.11
|
|||
|
|
- 缓存框架：Redis
|
|||
|
|
- API文档：Swagger 3.0.0
|
|||
|
|
- 定时任务：Quartz
|
|||
|
|
- 代码生成：Velocity模板引擎
|
|||
|
|
- 其他工具：FastJSON2、POI、Kaptcha验证码
|
|||
|
|
|
|||
|
|
【前端技术栈】
|
|||
|
|
- 核心框架：Vue 2.6.12
|
|||
|
|
- UI组件库：Element UI 2.15.8
|
|||
|
|
- 状态管理：Vuex 3.6.0
|
|||
|
|
- 路由管理：Vue Router 3.4.9
|
|||
|
|
- HTTP客户端：Axios 0.24.0
|
|||
|
|
- 图表库：ECharts 4.9.0
|
|||
|
|
- 富文本编辑器：Quill 1.3.7
|
|||
|
|
- 构建工具：Vue CLI 4.4.6
|
|||
|
|
|
|||
|
|
【数据库】
|
|||
|
|
- MySQL（支持其他数据库）
|
|||
|
|
|
|||
|
|
三、项目结构
|
|||
|
|
-----------
|
|||
|
|
【后端结构（rlz目录）】
|
|||
|
|
rlz/
|
|||
|
|
├── ruoyi-admin/ # 后台管理模块（启动类）
|
|||
|
|
├── ruoyi-common/ # 通用工具类模块
|
|||
|
|
├── ruoyi-framework/ # 核心框架模块
|
|||
|
|
├── ruoyi-system/ # 系统业务模块
|
|||
|
|
├── ruoyi-quartz/ # 定时任务模块
|
|||
|
|
├── ruoyi-generator/ # 代码生成模块
|
|||
|
|
├── sql/ # 数据库脚本
|
|||
|
|
│ ├── ry_20220625.sql # 主数据库脚本
|
|||
|
|
│ └── quartz.sql # 定时任务表脚本
|
|||
|
|
└── pom.xml # Maven父工程配置
|
|||
|
|
|
|||
|
|
【前端结构（rlz-ui目录）】
|
|||
|
|
rlz-ui/
|
|||
|
|
├── src/
|
|||
|
|
│ ├── api/ # API接口定义
|
|||
|
|
│ ├── assets/ # 静态资源
|
|||
|
|
│ ├── components/ # 公共组件
|
|||
|
|
│ ├── directive/ # 自定义指令
|
|||
|
|
│ ├── layout/ # 布局组件
|
|||
|
|
│ ├── router/ # 路由配置
|
|||
|
|
│ ├── store/ # Vuex状态管理
|
|||
|
|
│ ├── utils/ # 工具函数
|
|||
|
|
│ ├── views/ # 页面视图
|
|||
|
|
│ │ ├── system/ # 系统管理页面
|
|||
|
|
│ │ ├── monitor/ # 系统监控页面
|
|||
|
|
│ │ ├── tool/ # 系统工具页面
|
|||
|
|
│ │ └── dashboard/ # 首页仪表盘
|
|||
|
|
│ ├── App.vue # 根组件
|
|||
|
|
│ └── main.js # 入口文件
|
|||
|
|
├── public/ # 公共文件
|
|||
|
|
└── package.json # 依赖配置
|
|||
|
|
|
|||
|
|
四、核心功能模块
|
|||
|
|
-----------
|
|||
|
|
1. 系统管理
|
|||
|
|
- 用户管理：系统用户配置
|
|||
|
|
- 部门管理：组织机构树形结构
|
|||
|
|
- 岗位管理：用户职务配置
|
|||
|
|
- 菜单管理：系统菜单和权限配置
|
|||
|
|
- 角色管理：角色权限分配
|
|||
|
|
- 字典管理：系统字典数据维护
|
|||
|
|
- 参数管理：系统参数配置
|
|||
|
|
- 通知公告：系统公告发布
|
|||
|
|
|
|||
|
|
2. 系统监控
|
|||
|
|
- 操作日志：系统操作记录查询
|
|||
|
|
- 登录日志：登录记录和异常查询
|
|||
|
|
- 在线用户：活跃用户状态监控
|
|||
|
|
- 定时任务：任务调度管理
|
|||
|
|
- 服务监控：系统性能监控（CPU、内存、磁盘等）
|
|||
|
|
- 缓存监控：Redis缓存信息查询
|
|||
|
|
|
|||
|
|
3. 系统工具
|
|||
|
|
- 代码生成：前后端代码自动生成
|
|||
|
|
- 系统接口：API接口文档（Swagger）
|
|||
|
|
- 在线构建器：表单元素拖拽生成HTML
|
|||
|
|
|
|||
|
|
4. 其他功能
|
|||
|
|
- 微信支付相关功能（WXPay相关控制器）
|
|||
|
|
- 用户注册功能
|
|||
|
|
- 文件上传下载
|
|||
|
|
|
|||
|
|
五、配置说明
|
|||
|
|
-----------
|
|||
|
|
【后端配置（application.yml）】
|
|||
|
|
- 服务端口：9090
|
|||
|
|
- 数据库：MySQL（需配置）
|
|||
|
|
- Redis：localhost:6379
|
|||
|
|
- 文件上传路径：C:/ruoyi/uploadPath（Windows）或 /home/ruoyi/uploadPath（Linux）
|
|||
|
|
- JWT令牌有效期：30000分钟
|
|||
|
|
- 验证码类型：math（数学计算）
|
|||
|
|
|
|||
|
|
【前端配置】
|
|||
|
|
- 开发环境端口：80
|
|||
|
|
- API代理：/dev-api
|
|||
|
|
- 构建命令：
|
|||
|
|
* 开发：npm run dev
|
|||
|
|
* 测试构建：npm run build:stage
|
|||
|
|
* 生产构建：npm run build:prod
|
|||
|
|
|
|||
|
|
六、开发环境要求
|
|||
|
|
-----------
|
|||
|
|
【后端】
|
|||
|
|
- JDK 1.8+
|
|||
|
|
- Maven 3.0+
|
|||
|
|
- MySQL 5.7+
|
|||
|
|
- Redis 3.0+
|
|||
|
|
|
|||
|
|
【前端】
|
|||
|
|
- Node.js >= 8.9
|
|||
|
|
- npm >= 3.0.0
|
|||
|
|
|
|||
|
|
七、快速开始
|
|||
|
|
-----------
|
|||
|
|
【后端启动】
|
|||
|
|
1. 导入数据库脚本（sql/ry_20220625.sql 和 sql/quartz.sql）
|
|||
|
|
2. 修改 application.yml 中的数据库和Redis配置
|
|||
|
|
3. 运行 RuoYiApplication.java 启动类
|
|||
|
|
|
|||
|
|
【前端启动】
|
|||
|
|
1. 进入 rlz-ui 目录
|
|||
|
|
2. 安装依赖：npm install
|
|||
|
|
3. 启动开发服务器：npm run dev
|
|||
|
|
4. 访问：http://localhost:80
|
|||
|
|
|
|||
|
|
【默认账号】
|
|||
|
|
- 用户名：admin
|
|||
|
|
- 密码：admin123
|
|||
|
|
|
|||
|
|
八、主要依赖版本
|
|||
|
|
-----------
|
|||
|
|
后端：
|
|||
|
|
- Spring Boot: 2.5.14
|
|||
|
|
- MyBatis Spring Boot: 2.2.2
|
|||
|
|
- Druid: 1.2.11
|
|||
|
|
- JWT: 0.9.1
|
|||
|
|
- FastJSON2: 2.0.8
|
|||
|
|
- Swagger: 3.0.0
|
|||
|
|
|
|||
|
|
前端：
|
|||
|
|
- Vue: 2.6.12
|
|||
|
|
- Element UI: 2.15.8
|
|||
|
|
- Vuex: 3.6.0
|
|||
|
|
- Vue Router: 3.4.9
|
|||
|
|
- Axios: 0.24.0
|
|||
|
|
- ECharts: 4.9.0
|
|||
|
|
|
|||
|
|
九、安全特性
|
|||
|
|
-----------
|
|||
|
|
- JWT令牌认证
|
|||
|
|
- Spring Security权限控制
|
|||
|
|
- XSS攻击防护
|
|||
|
|
- 密码加密存储
|
|||
|
|
- 操作日志记录
|
|||
|
|
- 登录日志监控
|
|||
|
|
|
|||
|
|
十、注意事项
|
|||
|
|
-----------
|
|||
|
|
1. 项目基于RuoYi框架，保留了框架的基础功能
|
|||
|
|
2. 已集成微信支付相关功能模块
|
|||
|
|
3. 文件上传路径需要根据实际部署环境配置
|
|||
|
|
4. 生产环境建议关闭演示模式（demoEnabled: false）
|
|||
|
|
5. 建议使用HTTPS协议部署（配置文件中已预留SSL配置）
|
|||
|
|
|
|||
|
|
========================================
|
|||
|
|
文档生成时间：2024年
|
|||
|
|
文档版本：简化版 v1.0
|
|||
|
|
========================================
|