From b1ff178a9abfee3110bf9159ce48500fe13aa355 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Thu, 31 Jul 2025 09:56:16 +0000 Subject: [PATCH] Update README.md --- README.md | 171 ++++++++++++++++++++++++++---------------------------- 1 file changed, 82 insertions(+), 89 deletions(-) diff --git a/README.md b/README.md index 0c4b42a..9ac2fca 100644 --- a/README.md +++ b/README.md @@ -1,113 +1,106 @@ -[![index]( https://youdoc.github.io/img/tencent.jpg )]( https://cloud.tencent.com/act/cps/redirect?redirect=2446&cps_key=736e609d66e0ac4e57813316cec6fd0b&from=console ) -

- Java 17 - Spring Boot 3 - Vue 3
- Github stars - Github forks - Gitee stars - Gitee forks - visitors -

-## 项目背景 - -小说网站业务难度适中，没有商城系统那种复杂的业务。但是作为互联网项目，一样需要面对大规模用户和海量数据的处理，所以高并发、高可用、高性能、高容错、可扩展性、可维护性也是小说网站设计需要考虑的问题，商城系统中所用到的技术同样适用于小说网站。 +# novel-cloud -综上所述，使用微服务架构来构建一个小说门户平台是非常有必要的，利用微服务构建的小说门户平台来学习现下流行技术相较于业务比较复杂的商城系统来说也是比较容易的，非常适合于没有实际微服务项目经验的同学用来学习和入门微服务技术栈。 +## 项目背景 +随着网络文学的快速发展，小说阅读平台需要更高效、稳定、可扩展的解决方案。novel-cloud 是一个基于微服务架构的分布式小说阅读平台，提供从小说发布、搜索、阅读到用户反馈等完整功能。 ## 项目简介 - -novel 是一套基于时下最新 Java 技术栈 `Spring Boot 3` + `Vue 3` 开发的前后端分离学习型小说项目，配备 [保姆级教程](https://docs.xxyopen.com/course/novel) 手把手教你从零开始开发上线一套生产级别的 Java -系统，由小说门户系统、作家后台管理系统、平台后台管理系统等多个子系统构成。包括小说推荐、作品检索、小说排行榜、小说阅读、小说评论、会员中心、作家专区、充值订阅、新闻发布等功能。 - -novel-cloud 是 novel 项目的微服务版本，基于 `Spring Cloud 2022` & `Spring Cloud Alibaba 2022` 构建，数据结构、后端接口和 novel 项目保持完全一致，Vue 3 开发的前端能无缝对接这两个项目。 +novel-cloud 是一个模块化设计的小说云平台，采用 Spring Cloud Alibaba + Nacos + Redis + MySQL + Elasticsearch 的技术栈，包含小说管理、用户系统、评论系统、搜索服务、运营管理后台等多个模块，支持内容缓存、分布式锁、微服务通信等现代架构特性。 ## 项目地址 - -- 单体架构后端项目：[GitHub](https://github.com/201206030/novel) ｜ [码云](https://gitee.com/novel_dev_team/novel) ｜ [文档](https://docs.xxyopen.com/course/novel) -- 微服务架构后端项目：[GitHub](https://github.com/201206030/novel-cloud) ｜ [码云](https://gitee.com/novel_dev_team/novel-cloud) ｜ [文档](https://docs.xxyopen.com/course/novelcloud) -- 前端项目：[GitHub](https://github.com/201206030/novel-front-web) ｜ [码云](https://gitee.com/novel_dev_team/novel-front-web) -- 线上应用版：[GitHub](https://github.com/201206030/novel-plus) ｜ [码云](https://gitee.com/novel_dev_team/novel-plus) +- Gitee 仓库地址: [https://gitee.com/novel_dev_team/novel-cloud](https://gitee.com/novel_dev_team/novel-cloud) ## 开发环境 - -- MySQL 8.0 -- Redis 7.0 -- Elasticsearch 8.6.2 -- RabbitMQ 3.x -- XXL-JOB 2.3.1 -- Nacos 2.2.1 -- JDK 17 -- Maven 3.8 -- IntelliJ IDEA 2021.3（可选） -- Node 16.14 +- Java 17 +- Spring Boot 2.7.x +- Spring Cloud Alibaba 2021.0.4.0 +- Nacos 2.x +- Redis 6.x +- MySQL 8.x +- Elasticsearch 7.17.x +- MyBatis Plus +- Knife4j OpenAPI 3.x +- Lombok +- MapStruct +- Spring Security +- Spring Data Elasticsearch +- XXL-JOB ## 后端技术选型 - -| 技术 | 版本 | 说明 | 官网 | 学习 | -|----------------------|:--------------:|-----------------------------------| -------------------------------------- |:-----------------------------------------------------------------------------------------------------------------------------:| -| Spring Cloud | 2022.0.1 | 微服务开发的一站式解决方案 | [进入](https://spring.io/projects/spring-cloud) | [进入](https://docs.spring.io/spring-cloud/docs/current/reference/html/) | -| Spring Cloud Alibaba | 2022.0.0.0-RC1 | 阿里巴巴贡献的 Spring Cloud 微服务开发一站式解决方案 | [进入](https://github.com/alibaba/spring-cloud-alibaba) | [进入](https://spring-cloud-alibaba-group.github.io/github-pages/2021/zh-cn/2021.0.5.0/index.html) | -| Nacos | 2.2.1 | 服务发现和配置管理 | [进入](https://nacos.io) | [进入](https://nacos.io/zh-cn/docs/what-is-nacos.html) | -| Spring Boot Admin | 3.0.2 | 微服务管理和监控 | [进入](https://github.com/codecentric/spring-boot-admin) | [进入](https://codecentric.github.io/spring-boot-admin/3.0.0-M1) | -| Spring Boot | 3.0.5 | 容器 + MVC 框架 | [进入](https://spring.io/projects/spring-boot) | [进入](https://docs.spring.io/spring-boot/docs/3.0.0/reference/html) | -| MyBatis | 3.5.9 | ORM 框架 | [进入](http://www.mybatis.org) | [进入](https://mybatis.org/mybatis-3/zh/index.html) | -| MyBatis-Plus | 3.5.3 | MyBatis 增强工具 | [进入](https://baomidou.com/) | [进入](https://baomidou.com/pages/24112f/) | -| JJWT | 0.11.5 | JWT 登录支持 | [进入](https://github.com/jwtk/jjwt) | - | -| Lombok | 1.18.24 | 简化对象封装工具 | [进入](https://github.com/projectlombok/lombok) | [进入](https://projectlombok.org/features/all) | -| Caffeine | 3.1.0 | 本地缓存支持 | [进入](https://github.com/ben-manes/caffeine) | [进入](https://github.com/ben-manes/caffeine/wiki/Home-zh-CN) | -| Redis | 7.0 | 分布式缓存支持 | [进入](https://redis.io) | [进入](https://redis.io/docs) | -| Redisson | 3.17.4 | 分布式锁实现 | [进入](https://github.com/redisson/redisson) | [进入](https://github.com/redisson/redisson/wiki/%E7%9B%AE%E5%BD%95) | -| RabbitMQ | 3.x | 开源消息中间件 | [进入](https://www.rabbitmq.com) | [进入](https://www.rabbitmq.com/tutorials/tutorial-one-java.html) | -| MySQL | 8.0 | 数据库服务 | [进入](https://www.mysql.com) | [进入](https://docs.oracle.com/en-us/iaas/mysql-database/doc/getting-started.html) | -| ShardingSphere-JDBC | 5.1.1 | 数据库分库分表支持 | [进入](https://shardingsphere.apache.org) | [进入](https://shardingsphere.apache.org/document/5.1.1/cn/overview) | -| Elasticsearch | 8.6.2 | 搜索引擎服务 | [进入](https://www.elastic.co) | [进入](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html) | -| XXL-JOB | 2.3.1 | 分布式任务调度平台 | [进入](https://www.xuxueli.com/xxl-job) | [进入](https://www.xuxueli.com/xxl-job) | -| Springdoc-openapi | 2.0.0 | Swagger 3 接口文档自动生成 | [进入](https://github.com/springdoc/springdoc-openapi) | [进入](https://springdoc.org/) | -| Undertow | 2.2.17.Final | Java 开发的高性能 Web 服务器 | [进入](https://undertow.io) | [进入](https://undertow.io/documentation.html) | - -**注：更多热门新技术待集成。** +| 模块 | 技术 | +|------|------| +| 基础框架 | Spring Boot + Spring Cloud Alibaba | +| 注册中心 | Nacos | +| 配置中心 | Nacos | +| 缓存 | Redis + Caffeine | +| 数据库 | MySQL | +| 搜索服务 | Elasticsearch | +| 服务网关 | Spring Cloud Gateway | +| 接口文档 | Knife4j OpenAPI 3.x | +| 分布式锁 | Redisson | +| 日志框架 | Logback | +| 定时任务 | XXL-JOB | +| 安全框架 | Spring Security | +| 消息队列 | RabbitMQ | +| 远程调用 | Feign | +| ORM 框架 | MyBatis Plus | +| 数据验证 | Hibernate Validator | +| JSON 处理 | Jackson | +| 工具类 | Lombok, MapStruct, Hutool | ## 前端技术选型 - -| 技术 | 版本 | 说明 | 官网 | 学习 | -| :----------------- | :-----: | -------------------------- |--------------------------------| :-------------------------------------------------: | -| Vue.js | 3.2.13 | 渐进式 JavaScript 框架 | [进入](https://vuejs.org) | [进入](https://staging-cn.vuejs.org/guide/introduction.html) | -| Vue Router | 4.0.15 | Vue.js 的官方路由 | [进入](https://router.vuejs.org) | [进入](https://router.vuejs.org/zh/guide/) | -| axios | 0.27.2 | 基于 promise 的网络请求库 | [进入](https://axios-http.com) | [进入](https://axios-http.com/zh/docs/intro) | -| element-plus | 2.2.0 | 基于 Vue 3，面向设计师和开发者的组件库 | [进入](https://element-plus.org) | [进入](https://element-plus.org/zh-CN/guide/design.html) | +项目未提供前端相关代码，但根据接口设计可以使用以下技术： +- Vue.js / React / Angular +- Axios / Fetch API +- TypeScript +- Vite / Webpack +- Tailwind CSS / Bootstrap / Element Plus ## 软件架构 - -![QQ20200520-215756](https://s3.ax1x.com/2020/12/09/r92rrT.png) - -👉 [克隆架构图](https://www.processon.com/view/5fd028fbe0b34d425254e710) +novel-cloud 采用典型的微服务架构，包含以下核心模块： +- **novel-gateway**: API 网关，处理所有请求的入口 +- **novel-config**: 全局配置中心，提供分布式锁、缓存、XSS过滤等通用组件 +- **novel-user**: 用户中心，管理用户注册、登录、评论、反馈等 +- **novel-author**: 作者后台，小说创作与发布管理 +- **novel-book**: 小说核心服务，管理小说信息、章节、内容等 +- **novel-home**: 首页服务，管理推荐小说与友情链接 +- **novel-monitor**: 监控服务，提供服务状态监控 +- **novel-news**: 新闻服务，提供平台新闻信息 +- **novel-resource**: 资源服务，管理图片验证码与上传 +- **novel-search**: 搜索服务，基于 Elasticsearch 实现小说搜索 ## 项目结构 - ``` -novel-cloud -├── novel-core -- 项目核心模块，供其它各个业务微服务依赖 -├── novel-gateway -- 基于 Spring Cloud Gateway 构建的微服务网关 -├── novel-monitor -- 基于 Spring Boot Admin 构建的微服务监控中心 -├── novel-search -- 基于 Elasticsearch 构建的搜索服务 -├── novel-home -- 首页微服务 -├── novel-news -- 新闻微服务 -├── novel-book -- 小说微服务 -├── novel-user -- 会员微服务 -├── novel-author -- 作家微服务 -└── novel-resource -- 资源微服务 +novel-cloud/ +├── novel-author/ # 作者管理服务 +├── novel-book/ # 小说核心服务 +├── novel-core/ # 核心公共组件 +├── novel-gateway/ # API 网关 +├── novel-home/ # 首页服务 +├── novel-monitor/ # 服务监控 +├── novel-news/ # 新闻服务 +├── novel-resource/ # 资源服务（验证码、上传） +├── novel-search/ # 小说搜索服务 +├── novel-user/ # 用户中心服务 +├── doc/ # 文档资源 +│ ├── docker/ # Docker 部署相关 +│ └── sql/ # 数据库初始化脚本 +└── README.md # 项目说明文档 ``` ## 项目演示 - -[https://www.bilibili.com/video/BV1Xa4y1T7CF](https://www.bilibili.com/video/BV1Xa4y1T7CF/) +项目提供完整的接口文档，支持以下功能演示： +- 用户注册与登录 +- 小说分类浏览 +- 小说信息与章节阅读 +- 发表与管理评论 +- 作者注册与小说发布 +- 小说搜索 +- 新闻浏览 +- 首页推荐小说展示 ## 捐赠支持 +本项目为开源项目，如果您觉得本项目对您有帮助，欢迎进行捐赠支持。捐赠金额不限，也可以是您认为合适的金额。 -开源项目不易，若此项目能得到你的青睐，可以捐赠支持作者持续开发与维护。 - -![mini-code](https://s1.ax1x.com/2020/10/31/BUQJwq.png) - +> 您也可以通过 Star 和 Fork 本项目，以持续支持和参与开源社区建设。 \ No newline at end of file -- Gitee