From e09c0638df4a92e9c5f1e6ffbe4947d66c5634d1 Mon Sep 17 00:00:00 2001 From: macro Date: Thu, 14 Nov 2019 10:06:16 +0800 Subject: [PATCH] =?UTF-8?q?=E8=AF=B4=E6=98=8E=E6=96=87=E6=A1=A3=E4=BF=AE?= =?UTF-8?q?=E6=94=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 199 ++++++------------ .../reference/dev_flow.md | 0 2 files changed, 65 insertions(+), 134 deletions(-) rename README-DEV.md => document/reference/dev_flow.md (100%) diff --git a/README.md b/README.md index 042c403..c442bd9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# mall +# mall-swarm

公众号 @@ -9,134 +9,80 @@ 码云

-## 前言 - -`mall`项目致力于打造一个完整的电商系统，采用现阶段流行技术实现。 - -## 项目文档 - -- 文档地址：[https://macrozheng.github.io/mall-learning](https://macrozheng.github.io/mall-learning) -- 备用地址：[https://macrozheng.gitee.io/mall-learning](https://macrozheng.gitee.io/mall-learning) - ## 项目介绍 -`mall`项目是一套电商系统，包括前台商城系统及后台管理系统，基于SpringBoot+MyBatis实现。前台商城系统包含首页门户、商品推荐、商品搜索、商品展示、购物车、订单流程、会员中心、客户服务、帮助中心等模块。后台管理系统包含商品管理、订单管理、会员管理、促销管理、运营管理、内容管理、统计报表、财务管理、权限管理、设置等模块。 +`mall-swarm`是一套微服务商城系统，采用了 Spring Cloud Greenwich、Spring Boot 2、MyBatis、Docker、Elasticsearch等核心技术，同时提供了基于Vue的管理后台方便快速搭建系统。`mall-swarm`在电商业务的基础集成了注册中心、配置中心、监控中心、网关等系统功能。 -### 项目演示 - -#### 后台管理系统 - -前端项目`mall-admin-web`地址：https://github.com/macrozheng/mall-admin-web - -项目演示地址： [http://39.98.190.128/index.html](http://39.98.190.128/index.html) - -![后台管理系统功能演示.gif](/document/resource/mall-admin.gif) - -#### 前台商城系统 - -前端项目`mall-app-web`地址：敬请期待...... - -项目演示地址：[http://39.98.190.128/mall-app/mainpage.html](http://39.98.190.128/mall-app/mainpage.html) - -![前台商城系统功能演示.gif](/document/resource/mall-app.gif) - -### 组织结构 - -``` lua -mall -├── mall-common -- 工具类及通用代码 -├── mall-mbg -- MyBatisGenerator生成的数据库操作代码 -├── mall-admin -- 后台商城管理系统接口 -├── mall-search -- 基于Elasticsearch的商品搜索系统 -├── mall-portal -- 前台商城系统接口 -└── mall-demo -- 框架搭建时的测试代码 -``` - -### 技术选型 - -#### 后端技术 - -技术 | 说明 | 官网 -----|----|---- -Spring Boot | 容器+MVC框架 | [https://spring.io/projects/spring-boot](https://spring.io/projects/spring-boot) -Spring Security | 认证和授权框架 | [https://spring.io/projects/spring-security](https://spring.io/projects/spring-security) -MyBatis | ORM框架 | [http://www.mybatis.org/mybatis-3/zh/index.html](http://www.mybatis.org/mybatis-3/zh/index.html) -MyBatisGenerator | 数据层代码生成 | [http://www.mybatis.org/generator/index.html](http://www.mybatis.org/generator/index.html) -PageHelper | MyBatis物理分页插件 | [http://git.oschina.net/free/Mybatis_PageHelper](http://git.oschina.net/free/Mybatis_PageHelper) -Swagger-UI | 文档生产工具 | [https://github.com/swagger-api/swagger-ui](https://github.com/swagger-api/swagger-ui) -Hibernator-Validator | 验证框架 | [http://hibernate.org/validator/](http://hibernate.org/validator/) -Elasticsearch | 搜索引擎 | [https://github.com/elastic/elasticsearch](https://github.com/elastic/elasticsearch) -RabbitMq | 消息队列 | [https://www.rabbitmq.com/](https://www.rabbitmq.com/) -Redis | 分布式缓存 | [https://redis.io/](https://redis.io/) -MongoDb | NoSql数据库 | [https://www.mongodb.com/](https://www.mongodb.com/) -Docker | 应用容器引擎 | [https://www.docker.com/](https://www.docker.com/) -Druid | 数据库连接池 | [https://github.com/alibaba/druid](https://github.com/alibaba/druid) -OSS | 对象存储 | [https://github.com/aliyun/aliyun-oss-java-sdk](https://github.com/aliyun/aliyun-oss-java-sdk) -JWT | JWT登录支持 | [https://github.com/jwtk/jjwt](https://github.com/jwtk/jjwt) -LogStash | 日志收集 | [https://github.com/logstash/logstash-logback-encoder](https://github.com/logstash/logstash-logback-encoder) -Lombok | 简化对象封装工具 | [https://github.com/rzwitserloot/lombok](https://github.com/rzwitserloot/lombok) - -#### 前端技术 - -技术 | 说明 | 官网 -----|----|---- -Vue | 前端框架 | [https://vuejs.org/](https://vuejs.org/) -Vue-router | 路由框架 | [https://router.vuejs.org/](https://router.vuejs.org/) -Vuex | 全局状态管理框架 | [https://vuex.vuejs.org/](https://vuex.vuejs.org/) -Element | 前端UI框架 | [https://element.eleme.io/](https://element.eleme.io/) -Axios | 前端HTTP框架 | [https://github.com/axios/axios](https://github.com/axios/axios) -v-charts | 基于Echarts的图表框架 | [https://v-charts.js.org/](https://v-charts.js.org/) -Js-cookie | cookie管理工具 | [https://github.com/js-cookie/js-cookie](https://github.com/js-cookie/js-cookie) -nprogress | 进度条控件 | [https://github.com/rstacruz/nprogress](https://github.com/rstacruz/nprogress) - -#### 架构图 - -##### 系统架构图 +## 系统架构图 ![系统架构图](document/resource/mall_micro_service_arch.jpg) -##### 业务架构图 +## 组织结构 -![系统架构图](document/resource/mall_business_arch.png) +``` lua +mall +├── mall-common -- 工具类及通用代码模块 +├── mall-mbg -- MyBatisGenerator生成的数据库操作代码模块 +├── mall-security -- 封装SpringSecurity+JWT的安全认证的模块 +├── mall-registery -- 基于Eureka的微服务注册中心 +├── mall-config -- 基于Spring Cloud Config的微服务配置中心 +├── mall-gateway -- 基于Spring Cloud Gateway的微服务API网关服务 +├── mall-monitor -- 基于Spring Boot Admin的微服务监控中心 +├── mall-admin -- 后台管理系统服务 +├── mall-search -- 基于Elasticsearch的商品搜索系统服务 +├── mall-portal -- 移动端商城系统服务 +└── mall-demo -- 微服务远程调用测试服务 +``` -#### 模块介绍 +## 项目文档 -##### 后台管理系统 `mall-admin` +- 配套`Spring Cloud`系列教程：[https://github.com/macrozheng/springcloud-learning](https://github.com/macrozheng/springcloud-learning) +- 项目相关`mall`系列教程：[https://macrozheng.github.io/mall-learning](https://macrozheng.github.io/mall-learning) -- 商品管理：[功能结构图-商品.jpg](document/resource/mind_product.jpg) -- 订单管理：[功能结构图-订单.jpg](document/resource/mind_order.jpg) -- 促销管理：[功能结构图-促销.jpg](document/resource/mind_sale.jpg) -- 内容管理：[功能结构图-内容.jpg](document/resource/mind_content.jpg) -- 用户管理：[功能结构图-用户.jpg](document/resource/mind_member.jpg) +## 项目演示 -##### 前台商城系统 `mall-portal` +- 后台管理系统： [http://39.98.190.128/index.html](http://39.98.190.128/index.html) +- 移动端商城系统：[http://39.98.190.128/mall-app/mainpage.html](http://39.98.190.128/mall-app/mainpage.html) -[功能结构图-前台.jpg](document/resource/mind_portal.jpg) +## 技术选型 -#### 开发进度 +### 后端技术 + +| 技术 | 说明 | 官网 | +| -------------------- | ------------------- | ------------------------------------------------------------ | +| Spring Cloud | 微服务框架 | [https://spring.io/projects/spring-cloud](https://spring.io/projects/spring-cloud) | +| Spring Boot | 容器+MVC框架 | [https://spring.io/projects/spring-boot](https://spring.io/projects/spring-boot) | +| Spring Security | 认证和授权框架 | [https://spring.io/projects/spring-security](https://spring.io/projects/spring-security) | +| MyBatis | ORM框架 | [http://www.mybatis.org/mybatis-3/zh/index.html](http://www.mybatis.org/mybatis-3/zh/index.html) | +| MyBatisGenerator | 数据层代码生成 | [http://www.mybatis.org/generator/index.html](http://www.mybatis.org/generator/index.html) | +| PageHelper | MyBatis物理分页插件 | [http://git.oschina.net/free/Mybatis_PageHelper](http://git.oschina.net/free/Mybatis_PageHelper) | +| Swagger-UI | 文档生产工具 | [https://github.com/swagger-api/swagger-ui](https://github.com/swagger-api/swagger-ui) | +| Elasticsearch | 搜索引擎 | [https://github.com/elastic/elasticsearch](https://github.com/elastic/elasticsearch) | +| RabbitMq | 消息队列 | [https://www.rabbitmq.com/](https://www.rabbitmq.com/) | +| Redis | 分布式缓存 | [https://redis.io/](https://redis.io/) | +| MongoDb | NoSql数据库 | [https://www.mongodb.com/](https://www.mongodb.com/) | +| Docker | 应用容器引擎 | [https://www.docker.com/](https://www.docker.com/) | +| Druid | 数据库连接池 | [https://github.com/alibaba/druid](https://github.com/alibaba/druid) | +| OSS | 对象存储 | [https://github.com/aliyun/aliyun-oss-java-sdk](https://github.com/aliyun/aliyun-oss-java-sdk) | +| JWT | JWT登录支持 | [https://github.com/jwtk/jjwt](https://github.com/jwtk/jjwt) | +| LogStash | 日志收集 | [https://github.com/logstash/logstash-logback-encoder](https://github.com/logstash/logstash-logback-encoder) | +| Lombok | 简化对象封装工具 | [https://github.com/rzwitserloot/lombok](https://github.com/rzwitserloot/lombok) | +| Seata | 全局事务管理框架 | [https://github.com/seata/seata](https://github.com/seata/seata) | + +### 前端技术 + +| 技术 | 说明 | 官网 | +| ---------- | --------------------- | ------------------------------------------------------------ | +| Vue | 前端框架 | [https://vuejs.org/](https://vuejs.org/) | +| Vue-router | 路由框架 | [https://router.vuejs.org/](https://router.vuejs.org/) | +| Vuex | 全局状态管理框架 | [https://vuex.vuejs.org/](https://vuex.vuejs.org/) | +| Element | 前端UI框架 | [https://element.eleme.io/](https://element.eleme.io/) | +| Axios | 前端HTTP框架 | [https://github.com/axios/axios](https://github.com/axios/axios) | +| v-charts | 基于Echarts的图表框架 | [https://v-charts.js.org/](https://v-charts.js.org/) | -![项目开发进度图](document/resource/mall_dev_flow.png) ## 环境搭建 -### 开发工具 - -工具 | 说明 | 官网 -----|----|---- -IDEA | 开发IDE | https://www.jetbrains.com/idea/download -RedisDesktop | redis客户端连接工具 | https://redisdesktop.com/download -Robomongo | mongo客户端连接工具 | https://robomongo.org/download -SwitchHosts| 本地host管理 | https://oldj.github.io/SwitchHosts/ -X-shell | Linux远程连接工具 | http://www.netsarang.com/download/software.html -Navicat | 数据库连接工具 | http://www.formysql.com/xiazai.html -PowerDesigner | 数据库设计工具 | http://powerdesigner.de/ -Axure | 原型设计工具 | https://www.axure.com/ -MindMaster | 思维导图设计工具 | http://www.edrawsoft.cn/mindmaster -ScreenToGif | gif录制工具 | https://www.screentogif.com/ -ProcessOn | 流程图绘制工具 | https://www.processon.com/ -PicPick | 图片处理工具 | https://picpick.app/zh/ -Snipaste | 屏幕截图工具 | https://www.snipaste.com/ - ### 开发环境 工具 | 版本号 | 下载 @@ -153,11 +99,12 @@ nginx | 1.10 | http://nginx.org/en/download.html > Windows环境部署 -- Windows环境搭建请参考：[mall在Windows环境下的部署](https://github.com/macrozheng/mall-learning/blob/master/docs/deploy/mall_deploy_windows.md); -- 注意：只启动mall-admin,仅需安装mysql即可; -- 克隆`mall-admin-web`项目，并导入到IDEA中完成编译[传送门](https://github.com/macrozheng/mall-admin-web); -- `mall-admin-web`项目的安装及部署请参考：[mall前端项目的安装与部署](https://github.com/macrozheng/mall-learning/blob/master/docs/deploy/mall_deploy_web.md); -- ELK日志收集系统的搭建请参考：[SpringBoot应用整合ELK实现日志收集](https://github.com/macrozheng/mall-learning/blob/master/docs/technology/mall_tiny_elk.md)。 +- Windows环境搭建请参考：[mall在Windows环境下的部署](https://github.com/macrozheng/mall-learning/blob/master/docs/deploy/mall_deploy_windows.md)； +- `mall-admin-web`项目的安装及部署请参考：[mall前端项目的安装与部署](https://github.com/macrozheng/mall-learning/blob/master/docs/deploy/mall_deploy_web.md)； +- 如果想使用`Consul`注册及配置中心的话请参考：[Spring Cloud Consul：服务治理与配置中心](https://juejin.im/post/5db05582f265da4d4c20180f) +- 如果想使用`Nacos`配置中心的话请参考：[Spring Cloud Alibaba：Nacos 作为注册中心和配置中心使用](https://juejin.im/post/5dcbf7bc5188250d1f5a78ea) +- `分布式事务`解决方案请参考：[]() +- `ELK`日志收集系统的搭建请参考：[SpringBoot应用整合ELK实现日志收集](https://github.com/macrozheng/mall-learning/blob/master/docs/technology/mall_tiny_elk.md)； > Docker环境部署 @@ -167,22 +114,6 @@ nginx | 1.10 | http://nginx.org/en/download.html - 本项目在Docker容器下的部署请参考：[mall在Linux环境下的部署（基于Docker容器）](https://github.com/macrozheng/mall-learning/blob/master/docs/deploy/mall_deploy_docker.md)； - 本项目使用Docker Compose请参考： [mall在Linux环境下的部署（基于Docker Compose）](https://github.com/macrozheng/mall-learning/blob/master/docs/deploy/mall_deploy_docker_compose.md)。 -## 参考资料 - -- [Spring实战（第4版）](https://book.douban.com/subject/26767354/) -- [Spring Boot实战](https://book.douban.com/subject/26857423/) -- [Spring Cloud微服务实战](https://book.douban.com/subject/27025912/) -- [Spring Cloud与Docker微服务架构实战](https://book.douban.com/subject/27028228/) -- [Spring Data实战](https://book.douban.com/subject/25975186/) -- [MyBatis从入门到精通](https://book.douban.com/subject/27074809/) -- [深入浅出MySQL](https://book.douban.com/subject/25817684/) -- [循序渐进Linux（第2版）](https://book.douban.com/subject/26758194/) -- [Elasticsearch 权威指南](https://www.elastic.co/guide/cn/elasticsearch/guide/current/index.html) -- [Elasticsearch 技术解析与实战](https://book.douban.com/subject/26967826/) -- [MongoDB实战(第二版)](https://book.douban.com/subject/27061123/) -- [Kubernetes权威指南](https://book.douban.com/subject/26902153/) -- [Pro Git](https://git-scm.com/book/zh/v2) - ## 公众号 mall项目全套学习教程连载中，**关注公众号**第一时间获取。 @@ -191,6 +122,6 @@ mall项目全套学习教程连载中，**关注公众号**第一时间获取。 ## 许可证 -[Apache License 2.0](https://github.com/macrozheng/mall/blob/master/LICENSE) +[Apache License 2.0](https://github.com/macrozheng/mall-swarm/blob/master/LICENSE) Copyright (c) 2018-2019 macrozheng diff --git a/README-DEV.md b/document/reference/dev_flow.md similarity index 100% rename from README-DEV.md rename to document/reference/dev_flow.md