ludu-cloud/README.md

209 lines
7.7 KiB
Markdown
Raw Normal View History

2019-04-28 19:40:27 +08:00
[toc]
2019-03-14 23:12:38 +08:00
# 前言
2019-04-28 19:40:27 +08:00
基于微服务的思想,构建在 B2C 电商场景下的项目实战。
* 「Talk is cheap. Show me the code」屁话少说放码过来
> 我们看过很多技术文章,却依然不知道微服务该咋整。
2019-06-05 08:07:19 +08:00
* 这会是一个认真做的业务开源项目,目前 Java 代码 2w+ 行,不包括注释的情况下。
2019-04-28 19:40:27 +08:00
* 整体的功能如下图:![功能图](http://static.iocoder.cn/mall%20%E5%8A%9F%E8%83%BD%E5%9B%BE-min.png)
> 功能图,和实际后端模块拆分,并不是绝对对应。
* [功能列表 - H5 商城](https://gitee.com/zhijiantianya/onemall/blob/master/docs/guides/%E5%8A%9F%E8%83%BD%E5%88%97%E8%A1%A8/%E5%8A%9F%E8%83%BD%E5%88%97%E8%A1%A8-H5%20%E5%95%86%E5%9F%8E.md)
* [功能列表 - 管理后台](https://gitee.com/zhijiantianya/onemall/blob/master/docs/guides/%E5%8A%9F%E8%83%BD%E5%88%97%E8%A1%A8/%E5%8A%9F%E8%83%BD%E5%88%97%E8%A1%A8-%E7%AE%A1%E7%90%86%E5%90%8E%E5%8F%B0.md)
2019-04-28 19:40:27 +08:00
* 交流群:[传送门](http://www.iocoder.cn/mall-user-group/?vip&gitee)
> 一起交流Get 知识。
* 我们迫切希望更多的参与进来,可以加入「交流群」,一起骚聊。
2019-05-14 23:26:16 +08:00
* [《Onemall 电商开源项目 —— 应用分层》](http://www.iocoder.cn/Onemall/Application-layer/?vip&onemall)
# 近期计划
近期准备开发如下功能:
1. 微信 H5 网页登陆
2. 订单评价
3. 商品品牌
4. 短信接入
5. 访问日志、错误日志接入
2019-04-28 19:40:27 +08:00
# 演示
> 艿艿:目前的开发者,都是后端出身。所以,一帮没有审美自觉的人,撸出来的前端界面,可能是东半球倒数第二难看。
>
> 迫切希望,有前端能力不错的小伙伴,加入我们,一起来完善「一个商城」。
>
> 啊啊啊!我好像做店铺装修功能。
2019-04-28 19:40:27 +08:00
## H5 商城
[体验传送门](http://h5.shop.iocoder.cn:18099)
![GIF 图-耐心等待](https://raw.githubusercontent.com/YunaiV/Blog/master/Mall/onemall-h5-min.gif)
2019-04-28 19:40:27 +08:00
## 管理后台
[体验传送门](http://admin.shop.iocoder.cn:18099)
* 账号yudaoyuanma
* 密码yudaoyuanma
2019-04-28 19:40:27 +08:00
![GIF 图-耐心等待](https://raw.githubusercontent.com/YunaiV/Blog/master/Mall/onemall-admin-min.gif)
2019-04-28 19:40:27 +08:00
## 其它演示
2019-04-28 19:40:27 +08:00
下面,我们会提供目前用到的中间件的管理平台。
> 艿艿:考虑到大家可以看到更全的功能,所以一般提供 admin 账号。所以,大家素质使用哟。
2019-05-09 20:10:09 +08:00
**SkyWalking UI**
* 地址http://skywalking-ui.shop.iocoder.cn:18099
* 管理员账号admin / admin
**Grafana UI**
* 地址http://grafana.shop.iocoder.cn:18099
* 演示账号yudaoyuanma / yudaoyuanma
* 用于展示 Prometheus 收集的 Metrics 指标数据。
2019-05-09 20:10:09 +08:00
**Dubbo Admin**
* 地址http://dubbo-admin.shop.iocoder.cn:18099
* 管理员账号:无需登陆
2019-05-09 20:10:09 +08:00
**RocketMQ Console**
* 地址http://rocketmq-console.shop.iocoder.cn:18099
* 管理员账号admin / RPsa2GHjTNs8pxEU
2019-05-09 20:10:09 +08:00
**Sentinel Console**
* 地址http://sentinel.shop.iocoder.cn:18099
* 账号sentinel / sentinel
2019-05-09 20:10:09 +08:00
**XXL-Job Console**
* 地址http://job-console.shop.iocoder.cn:18099
* 管理员账号admin / 233666
2019-04-28 19:40:27 +08:00
# 技术
## 搭建环境
2019-03-14 23:12:38 +08:00
2019-04-28 22:15:06 +08:00
[搭建调试环境](https://gitee.com/zhijiantianya/onemall/blob/master/docs/setup/quick-start.md)
2019-03-14 23:12:38 +08:00
2019-04-28 19:40:27 +08:00
## 架构图
2019-03-14 23:12:38 +08:00
2019-04-28 19:40:27 +08:00
TODO 此处应有一个架构图的装逼 JPG 图。
2019-03-14 23:12:38 +08:00
2019-04-28 19:40:27 +08:00
## 项目结构
| 模块 | 名称 | 端口 | |
| --- | --- | --- | --- |
| `admin-web` | 【前端】管理后台 | HTTP 8080 | |
| `mobile-web` | 【前端】商城 H5 | HTTP 8000 | |
| `system-application` | 管理员 HTTP 服务 | HTTP 18083 | [接口文档](http://api.shop.iocoder.cn:18099/admin-api/doc.html) |
| `user-application` | 用户 HTTP 服务 | HTTP 18082 | [接口文档](http://api.shop.iocoder.cn:18099/user-api/doc.html) |
| `product-application` | 商品 HTTP 服务 | HTTP 18081 | [接口文档](http://api.shop.iocoder.cn:18099/product-api/doc.html) |
| `pay-application` | 支付 HTTP 服务 | HTTP 18084 | [接口文档](http://api.shop.iocoder.cn:18099/pay-api/doc.html) |
| `promotion-application` | 促销 HTTP 服务 | HTTP 18085 | [接口文档](http://api.shop.iocoder.cn:18099/promotion-api/doc.html) |
| `search-application` | 搜索 HTTP 服务 | HTTP 18086 | [接口文档](http://api.shop.iocoder.cn:18099/search-api/doc.html) |
| `order-application` | 订单 HTTP 服务 | HTTP 18088 | [接口文档](http://api.shop.iocoder.cn:18099/order-api/doc.html) |
2019-04-28 19:40:27 +08:00
-------
后端项目,目前的项目结构如下:
```Java
[-] xxx
├──[-] xxx-application // 提供对外 HTTP API 。
├──[-] xxx-service-api // 提供 Dubbo 服务 API 。
├──[-] xxx-service-impl // 提供 Dubbo 服务 Service 实现。
```
考虑到大多数公司,无需拆分的特别细,并且过多 JVM 带来的服务器成本。所以目前的设定是:
* `xxx-service-impl` 内嵌在 `xxx-application` 中运行。
* MQ 消费者、定时器执行器,内嵌在 `xxx-service-impl` 中运行。
也就是说,一个 `xxx-application` 启动后,该模块就完整启动了。
## 技术栈
### 后端
| 框架 | 说明 | 版本 |
| --- | --- | --- |
| [Spring Boot](https://spring.io/projects/spring-boot) | 应用开发框架 | 2.1.4 |
| [MySQL](https://www.mysql.com/cn/) | 数据库服务器 | 5.6 |
| [Druid](https://github.com/alibaba/druid) | JDBC 连接池、监控组件 | 1.1.16 |
| [MyBatis](http://www.mybatis.org/mybatis-3/zh/index.html) | 数据持久层框架 | 3.5.1 |
| [MyBatis-Plus](https://mp.baomidou.com/) | Mybatis 增强工具包 | 3.1.1 |
2019-04-28 19:40:27 +08:00
| [Redis](https://redis.io/) | key-value 数据库 | 暂未引入,等压测后,部分模块 |
| [Redisson](https://github.com/redisson/redisson) | Redis 客户端 | 暂未引入,等压测后,部分模块 |
| [Elasticsearch](https://www.elastic.co/cn/) | 分布式搜索引擎 | 6.7.1 |
| [Dubbo](http://dubbo.apache.org/) | 分布式 RPC 服务框架 | 2.7.1 |
2019-04-28 19:40:27 +08:00
| [RocketMQ](http://dubbo.apache.org/) | 消息中间件 | 4.3.2 |
| [Seata](https://github.com/seata/seata) | 分布式事务中间件 | 0.5.1 |
2019-04-28 19:40:27 +08:00
| [Zookeeper](http://zookeeper.apache.org/) | 分布式系统协调 | 3.4.9 作为注册中心 |
| [XXL-Job](http://www.xuxueli.com/xxl-job/) | 分布式任务调度平台 | 2.0.1 |
| [springfox-swagger2](https://github.com/springfox/springfox/tree/master/springfox-swagger2) | API 文档 | 2.9.2 |
2019-05-14 23:26:16 +08:00
| [swagger-bootstrap-ui](https://gitee.com/xiaoym/swagger-bootstrap-ui) | Swagger 增强 UI 实现 | 1.9.3 |
2019-04-28 19:40:27 +08:00
未来考虑引入
2019-03-14 23:12:38 +08:00
* [ ] 配置中心 Nacos
* [ ] 服务保障 Sentinel
2019-04-28 19:40:27 +08:00
* [ ] 网关 Soul
2019-03-14 23:12:38 +08:00
2019-04-28 19:40:27 +08:00
### 前端
2019-03-14 23:12:38 +08:00
2019-04-28 19:40:27 +08:00
商城 H5 和管理后台,分别采用了 Vue 和 React ,基于其适合的场景考虑。具体的,可以看看 [《为什么 React 比 Vue 更适合大型应用?》](https://www.zhihu.com/question/314761485/answer/615318460) 的讨论。
2019-03-14 23:12:38 +08:00
2019-04-28 19:40:27 +08:00
**商城 H5**
2019-03-14 23:12:38 +08:00
2019-04-28 19:40:27 +08:00
| 框架 | 说明 | 版本 |
| --- | --- | --- |
| [Vue](https://cn.vuejs.org/index.html) | JavaScript 框架 | 2.5.17 |
| [Vant](https://youzan.github.io/vant/#/zh-CN/intro) | Vue UI 组件库 | 3.13.0 |
2019-03-14 23:12:38 +08:00
2019-04-28 19:40:27 +08:00
**管理后台**
2019-03-14 23:12:38 +08:00
2019-04-28 19:40:27 +08:00
| 框架 | 说明 | 版本 |
| --- | --- | --- |
| [React](https://reactjs.org/) | JavaScript 框架 | 16.7.0 |
| [Ant Design](https://ant.design/docs/react/introduce-cn) | React UI 组件库 | 3.13.0 |
### 监控
一般来说,监控会有三种方式:
* 1、Tracing ,我们采用 Apache SkyWalking
* 2、Logging ,我们采用 ELK
* 3、Metrics ,我们采用 Prometheus
| 框架 | 说明 | 版本 |
| --- | --- | --- |
| [SkyWalking](http://skywalking.apache.org/) | 分布式应用追踪系统 | 6.0.0 |
| [Prometheus](https://prometheus.io/) | 服务监控体系 | 2.9.2 |
| [Alertmanager](https://prometheus.io/docs/alerting/alertmanager/) | 告警管理器 | 0.17.0 |
| [Grafana](https://grafana.com/) | 仪表盘和图形编辑器 | 0.17.0 |
2019-04-28 19:40:27 +08:00
### 其它
2019-03-14 23:12:38 +08:00
2019-04-28 19:40:27 +08:00
* Jenkins 持续集成
* Nginx 服务器
* [ ] Docker 容器
* [ ] Nginx
2019-03-14 23:12:38 +08:00
2019-04-28 19:40:27 +08:00
# 某种结尾
2019-03-14 23:12:38 +08:00
目前成员
* 小范
* 芋艿