芋道 ruoyi-vue-pro 技术文档

1. 安装指南

1.1 环境要求

• JDK 8 或 JDK 17/21（根据分支选择）
• MySQL 5.7+
• Redis 5.0+
• Maven 3.6+
• Node.js 14+

1.2 后端安装

1. 克隆项目代码：

   git clone https://gitee.com/zhijiantianya/ruoyi-vue-pro.git
   

2. 根据JDK版本选择分支：
   • JDK 8：master分支
   • JDK 17/21：master-jdk17分支
3. 导入数据库脚本（位于sql目录）
4. 修改配置文件application-dev.yml中的数据库和Redis配置
5. 编译项目：

   mvn clean install
   

2. 项目使用说明

2.1 启动项目

1. 后端启动：

   java -jar yudao-server.jar
   

2. 前端启动（以Vue3为例）：

   cd yudao-ui-admin-vue3
   npm install
   npm run dev
   

2.2 系统功能

• 用户管理：系统用户配置
• 角色管理：菜单权限分配
• 菜单管理：系统菜单配置
• 部门管理：组织机构配置
• 租户管理：SaaS多租户功能
• 字典管理：固定数据维护
• 短信管理：短信渠道配置

3. 项目API使用文档

3.1 认证接口

@PostMapping("/login")
public CommonResult<AuthLoginRespVO> login(@Valid @RequestBody AuthLoginReqVO reqVO) {
    // 登录逻辑
}

@PostMapping("/logout")
public CommonResult<Boolean> logout() {
    // 登出逻辑
}

3.2 用户管理接口

@GetMapping("/user/page")
public CommonResult<PageResult<SysUserPageRespVO>> getUserPage(@Valid SysUserPageReqVO reqVO) {
    // 分页查询用户
}

@PostMapping("/user")
public CommonResult<Long> createUser(@Valid @RequestBody SysUserCreateReqVO reqVO) {
    // 创建用户
}

4. 项目安装方式

4.1 完整版安装

1. 克隆完整版仓库：

   git clone https://gitee.com/zhijiantianya/ruoyi-vue-pro.git
   

2. 按照1.2步骤配置

4.2 精简版安装

1. 克隆精简版仓库：

   git clone https://gitee.com/yudaocode/yudao-boot-mini.git
   

2. 按照1.2步骤配置

4.3 模块化安装

可通过迁移文档按需安装功能模块：

1. 参考迁移文档选择所需模块
2. 修改pom.xml文件引入对应模块
3. 执行数据库脚本（仅需执行所选模块）