目錄
前景提示
- 若伊是國內一款很好的開源項目,非常的便於學習,而且它是開源免費的,但是,它的開發部署文檔實在是沒法按照那個文檔,快速高效的在本地搭建一套可以運行的項目,對於學習開發和使用實在是一大難題,為此本博主耗時一個多星期,特意編輯了這套高效,快捷合理的部署文檔,希望看到的人可以快速搭建項目,快速學習,文檔不全,不合理,不可復用性一直是我國開發界的弊病,看看鄰國印度,就是文檔寫的好,都享譽硅谷了,希望我國的開發不要僅僅是技術好,文檔的狀況也要提上日程,畢竟可以一直讓更多人開發學習的才是最好的開源軟件,才能更好的做大做強.
| 日期 | 修改人 | 修改內容 |
|---|---|---|
| 2021年3月11日 | 北極的大企鵝 | 十三.登陸 |
| 2023年1月10日 | 北極的大企鵝 | 接口文檔swagger訪問 |
一、環境整合
構建工具(參考工具部署方式)
| 軟件名稱 | 版本 | 相關文章推薦 |
|---|---|---|
| Git | 13.5.0 | https://www.cnblogs.com/liuyangfirst/p/15996063.html |
| NodeJS | 16.0.0 | https://www.cnblogs.com/liuyangfirst/p/15998172.html |
| JDK | 1.8 | https://www.cnblogs.com/liuyangfirst/p/14334385.html |
| Maven | 3.6.0 | https://www.cnblogs.com/liuyangfirst/p/15981202.html |
| MySQL | 5.6.10 | https://www.cnblogs.com/liuyangfirst/p/15997667.html |
| Redis | 5.0.10 | https://www.cnblogs.com/liuyangfirst/p/15998117.html |
| DBeaver | 7.3.0 | https://www.cnblogs.com/liuyangfirst/p/15997753.html |
| IntelliJ IDEA | 盡量使用比較新的版本 | https://www.jetbrains.com/idea/ |
| RedisDesktopManager | 0.9.3.817 | https://www.cnblogs.com/liuyangfirst/p/15998132.html |
官方文檔
-
在項目的路徑下有一個eclipse的項目部署文檔可以參閱
二、git 導入編譯器
-
如圖: git ->clone
三、模塊描述淺析
- 文件路徑:RuoYi-Vue/pom.ml
| 模塊名稱 | 描述 | |
|---|---|---|
| ruoyi-admin | 啟動模塊,啟動配置在resource的yml下 | |
| ruoyi-framework | 主題框架模塊,框架怎么運行的仔細看看,這個是核心重點 | |
| ruoyi-system | 業務模塊,幾乎所有業務都在這里 | |
| ruoyi-quartz | 定時任務模塊,跑的定時任務基本都在這里 | |
| ruoyi-generator | 基礎公共表的操作,相當於基礎表和基礎業務存放位置 | |
| ruoyi-common | 公共代碼模塊,list轉set什么的一般放這里,自己不要瞎寫方法,公共的都放這里 |
四、配置文檔
| 名稱 | 位置 | |
|---|---|---|
| 模塊 | ruoyi-admin | |
| 路徑 | src/main/resources | |
| 綜合配置 | application.yml |
application.yml修改
-
這里有一個文件路徑需要修改為本地的,服務器部署時再修改一次對應服務器的地址
-
修改redis賬戶密碼配置(redis一定要配置密碼,否則的話啟動的時候就會報錯)
application-druid.yml修改
- 修改MySQL賬戶密碼配置
logback.xml修改
- 修改logback.xml的日志存放路徑
五、在IDEA中執行MySQL的腳本
-
在本地DBeaver建立數據庫ry-vue,(不建立,以下步驟操作不了)
-
右側欄，找到DATABASE，選擇加號，找到MYSQL
- 填寫配置信息,測試連接,測試連接的時候可能要下載相關的jar包.
- 找到需要運行的腳本,然后選擇run
- 填寫數據庫信息,選擇右側加號,導入剛剛配置的數據庫.
- 然后點擊run,就會成功運行腳本.
- 打開DBeaver檢查數據執行成功.
六、啟動后台項目
-
保證IDE的maven配置為本地的maven,JDK為1.8以上的在項目對應上,還有編碼格式沒有問題(這些基礎問題沒有問題)
- File -> setting
- File -> Project Struct
- File->Settings->Editor ->File Encodings
- File->Settings->Build -> Compiler -> Java Compiler
- File -> setting
-
點擊maven這里的刷新
-
點擊ruoyi的這三項加載(三個同時選中,然后點擊run的綠色三角形).
-
啟動redis,這里寫了這樣的腳本,然后把腳本的快捷方式發送到了桌面
-
找到本地安裝redis的路徑
-
新建文件redis_start.bat,寫入如下腳本
-
cd D:\ProgramFiles\Redis
redis-server.exe redis.windows.conf
pause
-
選擇redis_start.bat右鍵,發送快捷方式到桌面,就生成了快捷啟動方式
-
雙擊redis_start.bat啟動redis
-
項目的啟動位置
-
右鍵選擇run執行
-
如圖所示為啟動成功
七、IDEA前端配置
1、修改代碼
- 打開前端代碼，找到文件vue.config.js訪問配置文件保證如圖位置和admin模塊的端口號一致。
2、手動加載vue配置，運行前端
- 打開編譯器下邊的Terminal，進入ruoyi-ui路徑執行如下命令
npm install或者 cnpm install 加載本地包
- 由於項目的package.json里設置了編譯項目的pro，所以執行如下命令
npm run build:prod 建立項目
- 構建成功，成功后會生成dist（相當於jar包）文件。
- 項目啟動命令,點擊紅色鏈接位置即可訪問
npm run dev 啟動項目
3、項目自帶腳本啟動(彩蛋)
-
項目下有這樣三個文件,就是前端啟動使用的腳本(注意啟動順序)
-
使用方式,右鍵,然后選擇open in terminal
4、IDEA配置，運行前端
- 找到IDE工具欄，就是啟動項目的run那里
- 點擊下拉框，找到Eidt Confiuration，選擇
- 選擇小加號
- 選取npm
- 設置npm頁，完成后，點擊apply
- run npm ，如圖選擇run或者debug。
- 運行成功（如果本地的npm安裝沒問題，就會產生如圖的樣子）。
注意:
問題：IDEA 2020 存在編譯問題:Error:(3, 32) java: 程序包org.springframework.boot不存在。
- 勾選:Delegate IDE build/run actions to Maven.
八、登陸
- 以上沒有問題,就會自動彈出登陸頁面
- 登陸賬戶問題在項目RuoYi-Vue\doc，賬戶／密碼 ：admin/admin123（文檔里有）
- 進入主頁
| 序號 | 文檔 |
|---|---|
| 1 | 若依環境使用手冊.docx |
- 接口文檔swagger訪問 :http://localhost:8080/swagger-ui/index.html
- 點開查看,不是所有的接口都有文檔,需要可以自己添加.
- 代碼位置(com.ruoyi.web.controller.tool.TestController),可以參考為其他接口加上這三個注釋
- 加上之后的效果.
- 在系統中查看swagger.
九、本地調試好使版
- 上傳到本博主gitee,僅供學習:https://gitee.com/mrliuNumberOne/local_ruoyi.git
修復bug
| 日期 | 文檔 |
|---|---|
| 2022-04-19 | 若依環境修復bug |
| 2022-05-15 | 登陸狀態已過期bug |
結語
嘔心瀝血,爆肝一個星期（需要寫配置環境的文檔，還要反復測試，以便為各位看官老爺提供最好的精品文章）,希望點贊,收藏,評論,轉發,您的支持就是本博主前進的動力.