RuoYi v4.8.1 技术文档

1. 安装指南

1.1 环境要求

• JDK 1.8+
• MySQL 5.7+
• Maven 3.0+
• Redis 3.0+

1.2 数据库配置

1. 创建数据库ry并设置字符集为UTF-8
2. 执行项目中的sql/ry_2023xxxx.sql初始化数据库
3. 执行sql/quartz.sql初始化定时任务表

1.3 后端配置

1. 修改application.yml中的数据库连接信息
2. 修改application-druid.yml中的Druid监控账号
3. 配置Redis连接信息

2. 项目使用说明

2.1 启动项目

1. 编译打包：mvn clean package
2. 运行项目：java -jar ruoyi.jar
3. 访问地址：http://localhost:80

2.2 登录系统

• 默认管理员账号：admin/admin123
• 首次登录后建议修改密码

2.3 核心功能模块

1. 系统管理：包含用户、角色、菜单等基础配置
2. 系统监控：提供日志、缓存、服务状态监控
3. 代码生成：可视化生成前后端代码
4. 定时任务：配置和管理系统定时任务

3. 项目API使用文档

3.1 基础API规范

• 请求方式：RESTful风格
• 返回格式：JSON
• 认证方式：基于Token的JWT认证

3.2 常用API示例

1. 登录接口：

POST /login
{
  "username": "admin",
  "password": "admin123"
}

2. 获取用户信息：

GET /system/user/list
Headers: Authorization: Bearer {token}

3. 分页查询示例：

GET /system/user/list?pageNum=1&pageSize=10

3.3 API文档生成

系统内置Swagger支持，访问http://localhost:80/swagger-ui.html可查看完整API文档

4. 项目安装方式

4.1 源码安装

1. 克隆项目：git clone https://gitee.com/y_project/RuoYi.git
2. 导入IDE（推荐IntelliJ IDEA）
3. 配置Maven依赖
4. 启动主类RuoYiApplication

4.2 快速部署

1. 下载预编译包ruoyi.jar
2. 配置application.yml后直接运行
3. 支持Docker部署（需自行构建镜像）

4.3 开发建议

1. 代码生成器可快速生成基础CRUD代码
2. 系统参数建议通过"参数管理"配置
3. 业务异常使用ServiceException抛出
4. 前端页面基于H+框架开发，保持统一风格