From d71e35893dae713987656a00786d759a7e73d5e2 Mon Sep 17 00:00:00 2001 From: 疯狂的狮子li <15040126243@163.com> Date: 星期三, 15 九月 2021 12:05:24 +0800 Subject: [PATCH] update 重写框架 README.md 格式更友好 通俗易懂 --- README.md | 140 +++++++++++++++++----------------------------- 1 files changed, 51 insertions(+), 89 deletions(-) diff --git a/README.md b/README.md index 7ad5020..a414f9d 100644 --- a/README.md +++ b/README.md @@ -9,34 +9,35 @@ []() []() -RuoYi-Vue-Plus 鏄熀浜� RuoYi-Vue 閽堝 `鍒嗗竷寮忛泦缇 鍦烘櫙鍗囩骇 瀹氭湡涓� RuoYi-Vue 鍚屾 +RuoYi-Vue-Plus 鏄熀浜� RuoYi-Vue 閽堝 `鍒嗗竷寮忛泦缇 鍦烘櫙鍗囩骇(涓嶅吋瀹瑰師妗嗘灦) -闆嗘垚 Lock4j dynamic-datasource OSS瀛樺偍 绛夊垎甯冨紡鍦烘櫙瑙ｅ喅鏂规 - -闆嗘垚 Mybatis-Plus Lombok Hutool 绛変究鎹峰紑鍙戝伐鍏� 閫傞厤閲嶅啓鐩稿叧涓氬姟 渚夸簬寮�鍙� - -* 鍓嶇寮�鍙戞鏋� Vue銆丒lement UI -* 鍚庣寮�鍙戞鏋� Spring Boot銆丷edis -* 瀹瑰櫒妗嗘灦 Undertow 鍩轰簬 Netty 鐨勯珮鎬ц兘瀹瑰櫒 -* 鏉冮檺璁よ瘉妗嗘灦 Spring Security銆丣wt锛屾敮鎸佸缁堢璁よ瘉绯荤粺 -* 鍏崇郴鏁版嵁搴� MySQL 閫傞厤 8.X 鏈�浣� 5.7 -* 缂撳瓨鏁版嵁搴� Redis 閫傞厤 6.X 鏈�浣� 4.X -* 鏁版嵁搴撴鏋� Mybatis-Plus 蹇�� CRUD 澧炲姞寮�鍙戞晥鐜� 鎻掍欢鍖栨敮鎸佸悇绫婚渶姹� -* 鏁版嵁搴撴鏋� 澶氭暟鎹簮妗嗘灦 dynamic-datasource 鏀寔涓讳粠涓庡绉嶇被鏁版嵁搴撳紓鏋� -* 鏁版嵁搴撴鏋� Redis瀹㈡埛绔� 閲囩敤 Redisson 鎬ц兘鏇村己 -* 鏁版嵁搴撴鏋� 鎬ц兘鍒嗘瀽鎻掍欢 p6spy 鏇村己鍔茬殑 SQL 鍒嗘瀽 -* 搴忓垪鍖栨鏋� 缁熶竴浣跨敤 jackson 楂樻晥鍙潬 -* 缃戠粶妗嗘灦 Feign銆丱kHttp3 鎺ュ彛鍖栫鐞� HTTP 璇锋眰 -* 鍒嗗竷寮忛攣 Lock4j 娉ㄨВ閿併�佸伐鍏烽攣 澶氱澶氭牱 -* 鏂囦欢瀛樺偍 OSS 瀵硅薄瀛樺偍妯″潡 鏀寔 鏈湴瀛樺偍(Minio)涓庝簯瀛樺偍(涓冪墰銆侀樋閲屻�佽吘璁�) -* 鐩戞帶妗嗘灦 spring-boot-admin 鍏ㄦ柟浣嶆湇鍔＄洃鎺� -* 鏍￠獙妗嗘灦 validation 澧炲己鎺ュ彛瀹夊叏鎬� 涓ヨ皑鎬� -* Excel妗嗘灦 Alibaba EasyExcel 鎬ц兘浼樺紓 鎵╁睍鎬у己 -* 鏂囨。妗嗘灦 knife4j 缇庡寲鎺ュ彛鏂囨。 -* 宸ュ叿绫绘鏋� Hutool銆丩ombok 鍑忓皯浠ｇ爜鍐椾綑 澧炲姞瀹夊叏鎬� -* 浠ｇ爜鐢熸垚鍣� 涓�閿敓鎴愬墠鍚庣浠ｇ爜 -* 閮ㄧ讲鏂瑰紡 Docker 瀹瑰櫒缂栨帓 涓�閿儴缃蹭笟鍔￠泦缇� -* 鍥介檯鍖� Spring 鏍囧噯鍥介檯鍖栨柟瑙ｅ喅鏂规 +| 鍔熻兘浠嬬粛 | 浣跨敤鎶�鏈� | 鏂囨。鍦板潃 | 鐗规�ф敞鎰忎簨椤� | +|---|---|---|---| +| 褰撳墠妗嗘灦 | RuoYi-Vue-Plus | [RuoYi-Vue-Plus鏂囨。](https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/pages) | 閲嶅啓RuoYi-Vue鍏ㄦ柟浣嶅崌绾�(涓嶅吋瀹瑰師妗嗘灦) | +| 鍘熸鏋� | RuoYi-Vue | [RuoYi-Vue瀹樼綉](http://ruoyi.vip/) | 瀹氭湡鍚屾闇�瑕佺殑鍔熻兘 | +| 鍓嶇寮�鍙戞鏋� | Vue銆丒lement UI | [Element UI瀹樼綉](https://element.eleme.cn/#/zh-CN) | | +| 鍚庣寮�鍙戞鏋� | SpringBoot | [SpringBoot瀹樼綉](https://spring.io/projects/spring-boot/#learn) | | +| 瀹瑰櫒妗嗘灦 | Undertow | [Undertow瀹樼綉](https://undertow.io/) | 鍩轰簬 Netty 鐨勯珮鎬ц兘瀹瑰櫒 | +| 鏉冮檺璁よ瘉妗嗘灦 | Spring Security銆丣wt | [SpringSecurity瀹樼綉](https://spring.io/projects/spring-security#learn) | 鏀寔澶氱粓绔璇佺郴缁� | +| 鍏崇郴鏁版嵁搴� | MySQL | [MySQL瀹樼綉](https://dev.mysql.com/) | 閫傞厤 8.X 鏈�浣� 5.7 | +| 缂撳瓨鏁版嵁搴� | Redis | [Redis瀹樼綉](https://redis.io/) | 閫傞厤 6.X 鏈�浣� 4.X | +| 鏁版嵁搴撴鏋� | Mybatis-Plus | [Mybatis-Plus鏂囨。](https://baomidou.com/guide/) | 蹇�� CRUD 澧炲姞寮�鍙戞晥鐜� | +| 鏁版嵁搴撴鏋� | p6spy | [p6spy瀹樼綉](https://p6spy.readthedocs.io/) | 鏇村己鍔茬殑 SQL 鍒嗘瀽 | +| 澶氭暟鎹簮妗嗘灦 | dynamic-datasource | [dynamic-ds鏂囨。](https://www.kancloud.cn/tracy5546/dynamic-datasource/content) | 鏀寔涓讳粠涓庡绉嶇被鏁版嵁搴撳紓鏋� | +| Redis瀹㈡埛绔� | Redisson | [Redisson鏂囨。](https://github.com/redisson/redisson/wiki/%E7%9B%AE%E5%BD%95) | 鎬ц兘寮哄姴銆丄PI涓板瘜 | +| 搴忓垪鍖栨鏋� | Jackson | [Jackson瀹樼綉](https://github.com/FasterXML/jackson) | 缁熶竴浣跨敤 jackson 楂樻晥鍙潬 | +| 缃戠粶妗嗘灦 | Feign銆丱kHttp3 | [Feign瀹樼綉](https://github.com/OpenFeign/feign) | 鎺ュ彛鍖栫鐞� HTTP 璇锋眰 | +| 鍒嗗竷寮忛攣 | Lock4j | [Lock4j瀹樼綉](https://gitee.com/baomidou/lock4j) | 娉ㄨВ閿併�佸伐鍏烽攣 澶氱澶氭牱 | +| 鏂囦欢瀛樺偍 | Minio | [Minio鏂囨。](https://docs.min.io/) | 鏈湴瀛樺偍 | +| 鏂囦欢瀛樺偍 | 涓冪墰銆侀樋閲屻�佽吘璁� | [OSS浣跨敤鏂囨。](https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/pages?sort_id=4359146&doc_id=1469725) | 浜戝瓨鍌� | +| 鐩戞帶妗嗘灦 | SpringBoot-Admin | [SpringBoot-Admin鏂囨。](https://codecentric.github.io/spring-boot-admin/current/) | 鍏ㄦ柟浣嶆湇鍔＄洃鎺� | +| 鏍￠獙妗嗘灦 | Validation | [Validation鏂囨。](https://docs.jboss.org/hibernate/stable/validator/reference/en-US/html_single/) | 澧炲己鎺ュ彛瀹夊叏鎬с�佷弗璋ㄦ�� | +| Excel妗嗘灦 | Alibaba EasyExcel | [EasyExcel鏂囨。](https://www.yuque.com/easyexcel/doc/easyexcel) | 鎬ц兘浼樺紓 鎵╁睍鎬у己 | +| 鏂囨。妗嗘灦 | Knife4j | [Knife4j鏂囨。](https://doc.xiaominfo.com/knife4j/documentation/) | 缇庡寲鎺ュ彛鏂囨。 | +| 宸ュ叿绫绘鏋� | Hutool銆丩ombok | [Hutool鏂囨。](https://www.hutool.cn/docs/) | 鍑忓皯浠ｇ爜鍐椾綑 澧炲姞瀹夊叏鎬� | +| 浠ｇ爜鐢熸垚鍣� | 閫傞厤MP銆並nife4j瑙勮寖鍖栦唬鐮� | [Hutool鏂囨。](https://www.hutool.cn/docs/) | 涓�閿敓鎴愬墠鍚庣浠ｇ爜 | +| 閮ㄧ讲鏂瑰紡 | Docker | [Docker鏂囨。](https://docs.docker.com/) | 瀹瑰櫒缂栨帓 涓�閿儴缃蹭笟鍔￠泦缇� | +| 鍥介檯鍖� | SpringMessage | [SpringMVC鏂囨。](https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc) | Spring鏍囧噯鍥介檯鍖栨柟妗� | ## 鍙傝�冩枃妗� @@ -59,41 +60,7 @@ 娆㈣繋鍚勮矾鑻遍泟璞澃 `PR` 浠ｇ爜 璇锋彁浜ゅ埌 `dev` 寮�鍙戝垎鏀� 缁熶竴娴嬭瘯鍙戠増 -妗嗘灦瀹氫綅涓� `閫氱敤鍚庡彴绠＄悊绯荤粺(鍒嗗竷寮忛泦缇ゅ己鍖�)` 鍘熷垯涓婁笉鎺ュ彈涓氬姟 `PR` - -## 淇敼RuoYi鍔熻兘 -### 渚濊禆鏀瑰姩 - -* ORM妗嗘灦 浣跨敤 Mybatis-Plus 绠�鍖朇RUD (涓嶆敮鎸佷富瀛愯〃) -* Bean绠�鍖� 浣跨敤 Lombok 绠�鍖� get set toString 绛夌瓑 -* 瀹瑰櫒鏀瑰姩 Tomcat 鏀逛负 骞跺彂鎬ц兘鏇村ソ鐨� undertow -* 绉婚櫎 pagehelper 鏀逛负 Mybatis-Plus 鍒嗛〉 -* 闆嗘垚 p6spy 鏇村己鍔茬殑 SQL 鍒嗘瀽 -* 鍗囩骇 swagger 涓� knife4j -* 闆嗘垚 Hutool 5.X 骞堕噸鍐橰uoYi閮ㄥ垎鍔熻兘 -* 闆嗘垚 Feign 鎺ュ彛鍖栫鐞� Http 璇锋眰(濡備笁鏂硅姹� 鏀粯,鐭俊,鎺ㄩ�佺瓑) -* 绉婚櫎 鑷甫鏈嶅姟鐩戞帶 鏀逛负 spring-boot-admin 鍏ㄦ柟浣嶇洃鎺� -* 澧炲姞 demo 妯″潡绀轰緥(缁欎笉浼氬鍔犳ā鍧楃殑灏忎紮浼村仛鍙傝��) -* 澧炲姞 redisson 楂樻�ц兘 Redis 瀹㈡埛绔� -* 绉婚櫎 fastjson 缁熶竴浣跨敤 jackson 搴忓垪鍖� -* 闆嗘垚 dynamic-datasource 澶氭暟鎹簮(榛樿鏀寔MySQL,鍏朵粬绉嶇被闇�鑷閫傞厤) -* 闆嗘垚 Lock4j 瀹炵幇鍒嗗竷寮� 娉ㄨВ閿併�佸伐鍏烽攣 澶氱澶氭牱 -* 澧炲姞 Docker 瀹瑰櫒缂栨帓 鎵撳寘鎻掍欢涓庨儴缃茶剼鏈� -* 绉婚櫎 閫氱敤涓婁紶涓嬭浇 鏀逛负 OSS瀵硅薄瀛樺偍 鏀寔(Minio銆佷竷鐗涖�侀樋閲屻�佽吘璁�) -* 绉婚櫎 RuoYi鑷甫 Excel 宸ュ叿 鏀逛负 EasyExcel 宸ュ叿 - -### 浠ｇ爜鏀瑰姩 - -* 鎵�鏈夊師鐢熷姛鑳戒娇鐢� Mybatis-Plus 涓� Lombok 閲嶅啓 -* 澧炲姞 IServicePlus 涓� BaseMapperPlus 鍙嚜瀹氫箟閫氱敤鏂规硶 -* 浠ｇ爜鐢熸垚妯℃澘 鏀逛负閫傞厤 Mybatis-Plus 鐨勪唬鐮� -* 浠ｇ爜鐢熸垚妯℃澘 鏍规嵁 Alibaba 浠ｇ爜瑙勭害 鎷嗗垎鍑� VO銆丅O 绛夐鍩熷璞� -* 浠ｇ爜鐢熸垚妯℃澘 澧炲姞 鏂囨。娉ㄨВ 涓� 鏍￠獙娉ㄨВ 绠�鍖栭�氱敤鎿嶄綔 -* 椤圭洰淇敼涓� maven澶氱幆澧冮厤缃� -* 椤圭洰閰嶇疆淇敼涓� application.yml 缁熶竴绠＄悊 -* 鏁版嵁鏉冮檺淇敼涓� 閫傞厤鏀寔鍗曡〃銆佸琛� -* 浣跨敤 redisson 瀹炵幇 spring-cache 鏁村悎 -* 澧炲姞 mybatis-plus 浜岀骇缂撳瓨 redis 瀛樺偍 +妗嗘灦瀹氫綅涓� `閫氱敤鍚庡彴绠＄悊绯荤粺(鍒嗗竷寮忛泦缇ゅ己鍖�)` 鍘熷垯涓婁笉鎺ュ彈涓氬姟 `PR` ### 鍏朵粬 @@ -111,26 +78,29 @@ <img src="https://images.gitee.com/uploads/images/2021/0525/101654_451e4523_1766278.jpeg" width="300px" height="450px" /> <img src="https://images.gitee.com/uploads/images/2021/0525/101713_3d18b119_1766278.jpeg" width="300px" height="450px" /> -## 鍐呯疆鍔熻兘 +## 涓氬姟鍔熻兘 -1. 鐢ㄦ埛绠＄悊锛氱敤鎴锋槸绯荤粺鎿嶄綔鑰咃紝璇ュ姛鑳戒富瑕佸畬鎴愮郴缁熺敤鎴烽厤缃�� -2. 閮ㄩ棬绠＄悊锛氶厤缃郴缁熺粍缁囨満鏋勶紙鍏徃銆侀儴闂ㄣ�佸皬缁勶級锛屾爲缁撴瀯灞曠幇鏀寔鏁版嵁鏉冮檺銆� -3. 宀椾綅绠＄悊锛氶厤缃郴缁熺敤鎴锋墍灞炴媴浠昏亴鍔°�� -4. 鑿滃崟绠＄悊锛氶厤缃郴缁熻彍鍗曪紝鎿嶄綔鏉冮檺锛屾寜閽潈闄愭爣璇嗙瓑銆� -5. 瑙掕壊绠＄悊锛氳鑹茶彍鍗曟潈闄愬垎閰嶃�佽缃鑹叉寜鏈烘瀯杩涜鏁版嵁鑼冨洿鏉冮檺鍒掑垎銆� -6. 瀛楀吀绠＄悊锛氬绯荤粺涓粡甯镐娇鐢ㄧ殑涓�浜涜緝涓哄浐瀹氱殑鏁版嵁杩涜缁存姢銆� -7. 鍙傛暟绠＄悊锛氬绯荤粺鍔ㄦ�侀厤缃父鐢ㄥ弬鏁般�� -8. 閫氱煡鍏憡锛氱郴缁熼�氱煡鍏憡淇℃伅鍙戝竷缁存姢銆� -9. 鎿嶄綔鏃ュ織锛氱郴缁熸甯告搷浣滄棩蹇楄褰曞拰鏌ヨ锛涚郴缁熷紓甯镐俊鎭棩蹇楄褰曞拰鏌ヨ銆� -10. 鐧诲綍鏃ュ織锛氱郴缁熺櫥褰曟棩蹇楄褰曟煡璇㈠寘鍚櫥褰曞紓甯搞�� -11. 鍦ㄧ嚎鐢ㄦ埛锛氬綋鍓嶇郴缁熶腑娲昏穬鐢ㄦ埛鐘舵�佺洃鎺с�� -12. 瀹氭椂浠诲姟锛氬湪绾匡紙娣诲姞銆佷慨鏀广�佸垹闄�)浠诲姟璋冨害鍖呭惈鎵ц缁撴灉鏃ュ織銆� -13. 浠ｇ爜鐢熸垚锛氬墠鍚庣浠ｇ爜鐨勭敓鎴愶紙java銆乭tml銆亁ml銆乻ql锛夋敮鎸丆RUD涓嬭浇 銆� -14. 绯荤粺鎺ュ彛锛氭牴鎹笟鍔′唬鐮佽嚜鍔ㄧ敓鎴愮浉鍏崇殑api鎺ュ彛鏂囨。銆� -15. 鏈嶅姟鐩戞帶锛氱洃瑙嗗綋鍓嶇郴缁烠PU銆佸唴瀛樸�佺鐩樸�佸爢鏍堢瓑鐩稿叧淇℃伅銆� -16. 缂撳瓨鐩戞帶锛氬绯荤粺鐨勭紦瀛樹俊鎭煡璇紝鍛戒护缁熻绛夈�� -17. 鍦ㄧ嚎鏋勫缓鍣細鎷栧姩琛ㄥ崟鍏冪礌鐢熸垚鐩稿簲鐨凥TML浠ｇ爜銆� -18. 杩炴帴姹犵洃瑙嗭細鐩戣褰撳墠绯荤粺鏁版嵁搴撹繛鎺ユ睜鐘舵�侊紝鍙繘琛屽垎鏋怱QL鎵惧嚭绯荤粺鎬ц兘鐡堕銆� +| 鍔熻兘 | 浠嬬粛 | +|---|---| +| 鐢ㄦ埛绠＄悊 | 鐢ㄦ埛鏄郴缁熸搷浣滆�咃紝璇ュ姛鑳戒富瑕佸畬鎴愮郴缁熺敤鎴烽厤缃�� | +| 閮ㄩ棬绠＄悊 | 閰嶇疆绯荤粺缁勭粐鏈烘瀯锛堝叕鍙搞�侀儴闂ㄣ�佸皬缁勶級锛屾爲缁撴瀯灞曠幇鏀寔鏁版嵁鏉冮檺銆� | +| 宀椾綅绠＄悊 | 閰嶇疆绯荤粺鐢ㄦ埛鎵�灞炴媴浠昏亴鍔°�� | +| 鑿滃崟绠＄悊 | 閰嶇疆绯荤粺鑿滃崟锛屾搷浣滄潈闄愶紝鎸夐挳鏉冮檺鏍囪瘑绛夈�� | +| 瑙掕壊绠＄悊 | 瑙掕壊鑿滃崟鏉冮檺鍒嗛厤銆佽缃鑹叉寜鏈烘瀯杩涜鏁版嵁鑼冨洿鏉冮檺鍒掑垎銆� | +| 瀛楀吀绠＄悊 | 瀵圭郴缁熶腑缁忓父浣跨敤鐨勪竴浜涜緝涓哄浐瀹氱殑鏁版嵁杩涜缁存姢銆� | +| 鍙傛暟绠＄悊 | 瀵圭郴缁熷姩鎬侀厤缃父鐢ㄥ弬鏁般�� | +| 閫氱煡鍏憡 | 绯荤粺閫氱煡鍏憡淇℃伅鍙戝竷缁存姢銆� | +| 鎿嶄綔鏃ュ織 | 绯荤粺姝ｅ父鎿嶄綔鏃ュ織璁板綍鍜屾煡璇紱绯荤粺寮傚父淇℃伅鏃ュ織璁板綍鍜屾煡璇€�� | +| 鐧诲綍鏃ュ織 | 绯荤粺鐧诲綍鏃ュ織璁板綍鏌ヨ鍖呭惈鐧诲綍寮傚父銆� | +| 鏂囦欢绠＄悊 | 绯荤粺鏂囦欢涓婁紶銆佷笅杞界瓑绠＄悊銆� | +| 瀹氭椂浠诲姟 | 鍦ㄧ嚎锛堟坊鍔犮�佷慨鏀广�佸垹闄�)浠诲姟璋冨害鍖呭惈鎵ц缁撴灉鏃ュ織銆� | +| 浠ｇ爜鐢熸垚 | 鍓嶅悗绔唬鐮佺殑鐢熸垚锛坖ava銆乭tml銆亁ml銆乻ql锛夋敮鎸丆RUD涓嬭浇 銆� | +| 绯荤粺鎺ュ彛 | 鏍规嵁涓氬姟浠ｇ爜鑷姩鐢熸垚鐩稿叧鐨刟pi鎺ュ彛鏂囨。銆� | +| 鏈嶅姟鐩戞帶 | 鐩戣闆嗙兢绯荤粺CPU銆佸唴瀛樸�佺鐩樸�佸爢鏍堛�佸湪绾挎棩蹇椼�丼pring鐩稿叧閰嶇疆绛夈�� | +| 缂撳瓨鐩戞帶 | 瀵圭郴缁熺殑缂撳瓨淇℃伅鏌ヨ锛屽懡浠ょ粺璁＄瓑銆� | +| 鍦ㄧ嚎鏋勫缓鍣� | 鎷栧姩琛ㄥ崟鍏冪礌鐢熸垚鐩稿簲鐨凥TML浠ｇ爜銆� | +| 杩炴帴姹犵洃瑙� | 鐩戣褰撳墠绯荤粺鏁版嵁搴撹繛鎺ユ睜鐘舵�侊紝鍙繘琛屽垎鏋怱QL鎵惧嚭绯荤粺鎬ц兘鐡堕銆� | +| 浣跨敤妗堜緥 | 绯荤粺鐨勪竴浜涘姛鑳芥渚� | ## 婕旂ず鍥句緥 @@ -172,11 +142,3 @@ </tr> </tbody> </table> - -## 鍦ㄧ嚎浣撻獙 - -- admin/admin123 -- 闄嗛檰缁画鏀跺埌涓�浜涙墦璧忥紝涓轰簡鏇村ソ鐨勪綋楠屽凡鐢ㄤ簬婕旂ず鏈嶅姟鍣ㄥ崌绾с�傝阿璋㈠悇浣嶅皬浼欎即銆� - -婕旂ず鍦板潃锛歨ttp://vue.ruoyi.vip -鏂囨。鍦板潃锛歨ttp://doc.ruoyi.vip -- Gitblit v1.9.3