快速启动（后端项目）

目标：使用 IDEA 工具，将项目 [ruoyi-vue-pro **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro) 的后端项目运行起来 🛫

整个过程非常简单，预计 10 分钟就可以完成，取决于大家的网速。

> ↓↓↓ 技术交流群，一起苦练技术基本功，每日精进 30 公里！↓↓↓

![交流群](/media/202404/2024-04-25_1855250.34416395258759125.png)

## [#](https://doc.iocoder.cn/quick-start/#%F0%9F%91%8D-%E7%9B%B8%E5%85%B3%E8%A7%86%E9%A2%91%E6%95%99%E7%A8%8B)👍 相关视频教程

* [从零开始 02：在 Windows 环境下，如何运行前后端项目？(opens new window)](https://t.zsxq.com/07BeiEA6Q)
* [从零开始 03：在 MacOS 环境下，如何运行前后端项目？(opens new window)](https://t.zsxq.com/07FUNnYFm)

## [#](https://doc.iocoder.cn/quick-start/#_1-%E5%85%8B%E9%9A%86%E4%BB%A3%E7%A0%81)1. 克隆代码

使用 [IDEA **(opens new window)**](http://www.iocoder.cn/categories/IDEA/?self) 克隆 [https://github.com/YunaiV/ruoyi-vue-pro **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro) 仓库的最新代码，并给该仓库一个 [Star **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro)。

> 注意：不建议使用 Eclipse，因为它没有支持 Lombok 和 Mapstruct 插件。

克隆完成后，耐心等待 Maven 下载完相关的依赖。一定要注意：

① 默认情况下，使用 `master` 分支，它对应 JDK 8 + Spring Boot 2.7.18 版本。

② 如果你想体验 JDK 21 + Spring Boot 3.X 版本，需要切换到 `master-jdk17` 分支。

![项目一览](/media/202404/2024-04-25_1855250.28844816431537557.png)

> 友情提示：项目的每个模块的作用，可见 [《开发指南 —— 项目结构》](https://doc.iocoder.cn/project-intro/) 文档。

使用的 Spring Boot 版本较新，所以需要下载一段时间。趁着这个时间，胖友可以给项目添加一个 [Star **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro)，支持下艿艿。

![Star 一波](/media/202404/2024-04-25_1855250.10835872710914596.png)

## [#](https://doc.iocoder.cn/quick-start/#_2-apifox-%E6%8E%A5%E5%8F%A3%E5%B7%A5%E5%85%B7)2. Apifox 接口工具

点击 [Apifox **(opens new window)**](http://mtw.so/5NZLsX) 首页，下载对应的 Apifox 桌面版。如下图所示：

为什么要下载 Apifox 桌面版？

艿艿已经卸载 Postman，使用 Apifox 进行替代。国产软件，yyds 永远滴神！

国内很多互联网公司，包括百度、阿里、腾讯、字节跳动等等在内，都在使用 Apifox 作为 API 工具。

![Apifox 下载](/media/202404/2024-04-25_1855250.8035745735131331.png)

解压后，双击进行安装即可。黑色界面，非常酷炫。

![Apifox 界面](/media/202404/2024-04-25_1855250.012209602059855995.png)

接口文档？

阅读 [《开发指南 —— 接口文档》](https://doc.iocoder.cn/api-doc) 呀~~

## [#](https://doc.iocoder.cn/quick-start/#_3-%E5%88%9D%E5%A7%8B%E5%8C%96-mysql)3. 初始化 MySQL

友情提示？

如果你是 PostgreSQL、Oracle、SQL Server、DM 等其它数据库，也是可以的。

因为我主要使用 MySQL 数据库为主，所以其它数据库的 SQL 文件可能存在滞后，可以加入 [用户群](https://doc.iocoder.cn/qun) 反馈。

项目使用 MySQL 存储数据，所以需要启动一个 MySQL 服务，建议使用 **5.7** 版本。

① 创建一个名字为 `ruoyi-vue-pro` 数据库，**【只要】** 执行对应数据库类型的 [`sql` **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro/tree/master/sql)目录下的 `ruoyi-vue-pro.sql` SQL 文件，进行初始化。

![导入 MySQL 数据库](/media/202404/2024-04-25_1855250.26387290287998666.png)

② 默认配置下，MySQL 需要启动在 3306 端口，并且账号是 root，密码是 123456。如果不一致，需要修改 `application-local.yaml` 配置文件。

![修改配置文件](/media/202404/2024-04-25_1855250.2931628809607101.png)

---

**如果是 MySQL 数据库，不需要看 ③、④ 两点！！！**

③ 【如果是 PostgreSQL、Oracle、SQL Server 数据库】，修改 `yudao-spring-boot-starter-mybatis` 模块的 `pom.xml` 文件，将对应的 JDBC Driver 的 `optional` 移除。如下图所示：

![数据库依赖](/media/202404/2024-04-25_1855250.9083101050125466.png)

注意，需要使用 IDEA 刷新下 Maven 的依赖。

④ 【如果是 DM 达梦数据库】建议先使用 MySQL 跑通，然后再阅读 [《达梦数据库专属》](https://doc.iocoder.cn/db-dameng/) 文档。

## [#](https://doc.iocoder.cn/quick-start/#_4-%E5%88%9D%E5%A7%8B%E5%8C%96-redis)4. 初始化 Redis

项目使用 Redis 缓存数据，所以需要启动一个 Redis 服务。

> 不会安装的胖友，可以选择阅读下文，良心的艿艿。
> 
> * Windows 安装 Redis 指南：[http://www.iocoder.cn/Redis/windows-install(opens new window)](http://www.iocoder.cn/Redis/windows-install)
> * Mac 安装 Redis 指南：[http://www.iocoder.cn/Redis/mac-install(opens new window)](http://www.iocoder.cn/Redis/mac-install)

默认配置下，Redis 启动在 6379 端口，不设置账号密码。如果不一致，需要修改 `application-local.yaml` 配置文件。

![修改配置文件](/media/202404/2024-04-25_1855250.2972419424132393.png)

## [#](https://doc.iocoder.cn/quick-start/#_5-%E5%90%AF%E5%8A%A8%E5%90%8E%E7%AB%AF%E9%A1%B9%E7%9B%AE)5. 启动后端项目

[`yudao-server` **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro/blob/master/yudao-server)是后端项目，提供管理后台、用户 APP 的 RESTful API 接口。

### [#](https://doc.iocoder.cn/quick-start/#_5-1-%E7%BC%96%E8%AF%91%E9%A1%B9%E7%9B%AE)5.1 编译项目

第一步，使用 IDEA 打开 Terminal 终端，在 **根目录** 下直接执行 `mvn clean install package '-Dmaven.test.skip=true'` 命令，将项目进行初始化的打包，预计需要 1 分钟左右。成功后，控制台日志如下：

```bash
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 01:12 min
[INFO] Finished at: 2022-02-12T09:52:38+08:00
[INFO] Final Memory: 250M/2256M
[INFO] ------------------------------------------------------------------------
```

Maven 补充说明：

① 只有首次需要执行 Maven 命令，解决基础 `pom.xml` 文件不存在，导致报 BaseDbUnitTest 类不存在的问题。

② 如果执行报 `Unknown lifecycle phase “.test.skip=true”` 错误，使用 `mvn clean install package -Dmaven.test.skip=true` 即可。

### [#](https://doc.iocoder.cn/quick-start/#_5-2-%E5%90%AF%E5%8A%A8%E9%A1%B9%E7%9B%AE)5.2 启动项目

第二步，执行 [YudaoServerApplication **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro/blob/master/yudao-server/src/main/java/cn/iocoder/yudao/server/YudaoServerApplication.java) 类，进行启动。

启动还是报类不存在？

可能是 IDEA 的 bug，点击 [File -> Invalidate Caches] 菜单，清空下缓存，重启后在试试看。

![启动后端项目](/media/202404/2024-04-25_1855250.27322666567326137.png)

启动完成后，使用浏览器访问 [http://127.0.0.1:48080 **(opens new window)**](http://127.0.0.1:48080/) 地址，返回如下 JSON 字符串，说明成功。

> 友情提示：注意，默认配置下，后端项目启动在 48080 端口。

```json
{
    "code": 401,
    "data": null,
    "msg": "账号未登录"
}
```

如果报 “Command line is too long” 错误，参考 [《Intellij IDEA 运行时报 Command line is too long 解决方法 》 **(opens new window)**](https://www.iocoder.cn/Fight/Intellij-IDEA-Indicates-that-Command-Line-is-too-long/?yudao)文章解决，或者直接点击 YudaoServerApplication **蓝字**部分！

![“Command line is too long” 错误](/media/202404/2024-04-25_1855250.38285976945777056.png)

### [#](https://doc.iocoder.cn/quick-start/#_5-3-%E5%90%AF%E5%8A%A8%E5%85%B6%E5%AE%83%E6%A8%A1%E5%9D%97)5.3 启动其它模块

考虑到启动速度，默认值启动 `system` 系统服务，`infra` 基础设施两个模块。如果你需要启动其它模块，可以参考下面的文档：

* [《工作流手册 —— 工作流》](https://doc.iocoder.cn/bpm/)
* [《公众号手册 —— 功能开启》](https://doc.iocoder.cn/mp/build/)
* [《支付手册 —— 功能开启》](https://doc.iocoder.cn/pay/build/)
* [《大屏手册 —— 报表设计器》](https://doc.iocoder.cn/report/)
* [《商城手册 —— 功能开启》](https://doc.iocoder.cn/mall/build/)

## [#](https://doc.iocoder.cn/quick-start/#_6-%E5%90%AF%E5%8A%A8%E5%89%8D%E7%AB%AF%E9%A1%B9%E7%9B%AE%E3%80%90%E7%AE%80%E6%98%93%E3%80%91)6. 启动前端项目【简易】

友情提示：这是可选步骤，想要完整启动前端，可以直接看「7. 启动前端项目【完整】」小节噢！

在 [yudao-ui-static **(opens new window)**](https://gitee.com/yudaocode/yudao-ui-static) 项目中，提前编译好了前端项目的静态资源，可以直接体验和使用。操作步骤如下：

① 克隆 [https://gitee.com/yudaocode/yudao-ui-static **(opens new window)**](https://gitee.com/yudaocode/yudao-ui-static) 项目，运行 UiConfiguration 类，进行启动。

![演示项目](/media/202404/2024-04-25_1855250.6042474994627495.png)

② 访问 [http://127.0.0.1:2048/admin-ui-vue2/ **(opens new window)**](http://127.0.0.1:2048/admin-ui-vue2/)地址，可以看到 Vue2 管理后台。

② 访问 [http://127.0.0.1:2048/admin-ui-vue3/ **(opens new window)**](http://127.0.0.1:2048/admin-ui-vue3/)地址，可以看到 Vue3 + element-plus 管理后台。

③ 访问 [http://127.0.0.1:2048/admin-ui-vben/ **(opens new window)**](http://127.0.0.1:2048/admin-ui-vben/)地址，可以看到 Vue3 + vben(ant-design-vue) 管理后台。

补充说明：

前端项目是不定期编译，可能不是最新版本。

如果需要最新版本，请继续往下看。

## [#](https://doc.iocoder.cn/quick-start/#_7-%E5%90%AF%E5%8A%A8%E5%89%8D%E7%AB%AF%E9%A1%B9%E7%9B%AE%E3%80%90%E5%AE%8C%E6%95%B4%E3%80%91)7. 启动前端项目【完整】

参考 [《快速启动（前端项目）》](https://doc.iocoder.cn/quick-start-front) 文档

## [#](https://doc.iocoder.cn/quick-start/#_666-%E5%BD%A9%E8%9B%8B)666. 彩蛋

至此，我们已经完成了项目 [ruoyi-vue-pro **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro) 的启动。

胖友可以根据自己的兴趣，阅读相关源码。如果你想更快速的学习，可以看看 [《视频教程 》](https://doc.iocoder.cn/video/) 教程哟。

![架构图](/media/202404/2024-04-25_1855250.8817378873316244.png)

后面，艿艿会花大量的时间，继续优化这个项目。同时，输出与项目匹配的技术博客，方便胖友更好的学习与理解。

还是那句话，😆 为开源继绝学，我辈义不容辞！

---

嘿嘿嘿，记得一定要给 [https://github.com/YunaiV/ruoyi-vue-pro **(opens new window)**](https://github.com/YunaiV/ruoyi-vue-pro) 一个 star，这对艿艿真的很重要。

![Star 一波](/media/202404/2024-04-25_1855250.10835872710914596.png)