From 25645dfb35595bc1f9a005f30c9a315a2d8101aa Mon Sep 17 00:00:00 2001 From: xxy <1179705413@qq.com> Date: Fri, 12 Aug 2022 10:49:22 +0800 Subject: [PATCH] Update README.md --- README.md | 63 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 62 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 544d8ee..f2fa4fa 100644 --- a/README.md +++ b/README.md @@ -16,10 +16,71 @@ https://novel.xxyopen.com [基于 Sprint Boot 3 + Vue 3 开发的前后端分离学习型小说项目](https://github.com/201206030/novel) -#### 快速开始 +#### 项目文档 [➡️ 快速开始](https://docs.xxyopen.com/course/novelcloud/) +#### 项目背景 + +小说网站业务难度适中，没有商城系统那种复杂的业务。但是作为互联网项目，一样需要面对大规模用户和海量数据的处理，所以高并发、高可用、高性能、高容错、可扩展性、可维护性也是小说网站设计需要考虑的问题，商城系统中所用到的技术同样适用于小说网站。 + +综上所述，使用微服务架构来构建一个小说门户平台是非常有必要的，利用微服务技术栈构建的小说门户平台学习时下流行技术相较于业务比较复杂的商城系统来说也是比较容易的，非常适合没有实际微服务项目经验的同学用来学习和入门微服务技术栈。 + +#### 项目简介 + +novel-cloud 是基于 [novel-plus](/course/novelplus/) 构建的 Spring Cloud 微服务架构小说门户平台，致力于原创文学阅读与写作，提供了爬虫工具用于开发过程中测试数据的采集（爬虫项目和 novel-plus 通用）。采用了 Spring Boot 2.2.5.RELEASE 、Spring Cloud Hoxton.SR4、 MyBatis3 Dynamic SQL、Sharding-JDBC、Redis、RabbitMQ、Elasticsearch、Docker 等流行技术，集成了 Nacos 注册中心/配置中心、Spring Cloud Gateway 网关、Spring Boot Admin 监控中心、ELK 分布式日志分析等基础服务。 + +#### 项目结构 + +``` +novel-cloud +├── novel-common -- 通用模块，供其他业务微服务模块依赖 +├── novel-gen -- 持久层代码生成器，集成 Swagger +├── novel-gateway -- 基于 Spring Cloud Gateway 构建的网关服务 +├── novel-monitor -- 基于 Spring Boot Admin 构建的监控中心 +├── novel-search -- 基于 Elasticsearch 构建的搜索微服务 +├── novel-file -- 基于 Aliyun OSS 构建的文件微服务 +├── novel-home -- 门户首页微服务 +├── novel-news -- 新闻中心微服务 +├── novel-user -- 用户中心微服务 +├── novel-author -- 作家中心微服务 +├── novel-book -- 小说微服务 +└── novel-pay -- 支付微服务 +``` + +#### 技术选型 + +| 技术 | 说明 +|----------------------| --------------------------- +| Spring Boot | Spring 应用快速开发脚手架 +| Spring Cloud | 微服务架构解决方案 +| Nacos | 注册中心和配置中心 +| Sentinel | 限流/熔断/降级 +| Spring Cloud Gateway | 微服务网关 +| Spring Boot Admin | 微服务监控 +| MyBatis | 持久层 ORM 框架 +| MyBatis Dynamic SQL | MyBatis 动态 SQL +| PageHelper | MyBatis 分页插件 +| MyBatis Generator | 持久层代码生成插件 +| Seata | 分布式事务中间件（待应用） +| Sharding-JDBC | 代码层分库分表中间件 +| JJWT | JWT 登录支持 +| Redis | 分布式缓存 +| Elasticsearch | 搜索引擎 +| RabbitMQ | 消息队列 +| Aliyun OSS | 阿里云对象存储服务 +| MySQL | 数据库服务 +| Redisson | 实现分布式锁 +| Lombok | 简化对象封装工具 +| Swagger | API 文档生成工具 +| Docker | 应用容器引擎 +| Logstash | 分布式日志采集 +| Vue.js | 前端开发框架 + +#### 项目架构 + +![QQ20200520-215756](https://s3.ax1x.com/2020/12/09/r92rrT.png) + #### 代码仓库 Gitee 仓库地址： https://gitee.com/novel_dev_team/novel-cloud