novel 是一套基于时下最新 Java 技术栈 Spring Boot 3 + Vue 3 开发的前后端分离学习型 小说项目，由小说门户系统、作家后台管理系统、平台后台管理系统等多个子系统构成。包括小说推荐、作品检索、小说排行榜、小说阅读、小说评论、会员中心、作家专区、充值订阅、新闻发布等功能。
- MySQL 8.0
- Redis 7.0
- Elasticsearch 8.2.0（可选）
- RabbitMQ 3.10.2（可选）
- XXL-JOB 2.3.1（可选）
- JDK 17
- Maven 3.8
- IntelliJ IDEA 2021.3（可选）
- Node 16.14
注：Elasticsearch、RabbitMQ 和 XXL-JOB 默认关闭，可通过 application.yml 配置文件中相应的enable配置属性开启。
| 技术 | 版本 | 说明 | 官网 | 学习 |
|---|---|---|---|---|
| Spring Boot | 3.0.0 | 容器 + MVC 框架 | 进入 | 进入 |
| MyBatis | 3.5.9 | ORM 框架 | 进入 | 进入 |
| MyBatis-Plus | 3.5.3 | MyBatis 增强工具 | 进入 | 进入 |
| JJWT | 0.11.5 | JWT 登录支持 | 进入 | - |
| Lombok | 1.18.24 | 简化对象封装工具 | 进入 | 进入 |
| Caffeine | 3.1.0 | 本地缓存支持 | 进入 | 进入 |
| Redis | 7.0 | 分布式缓存支持 | 进入 | 进入 |
| Redisson | 3.17.4 | 分布式锁实现 | 进入 | 进入 |
| MySQL | 8.0 | 数据库服务 | 进入 | 进入 |
| ShardingSphere-JDBC | 5.1.1 | 数据库分库分表支持 | 进入 | 进入 |
| Elasticsearch | 8.2.0 | 搜索引擎服务 | 进入 | 进入 |
| RabbitMQ | 3.10.2 | 开源消息中间件 | 进入 | 进入 |
| XXL-JOB | 2.3.1 | 分布式任务调度平台 | 进入 | 进入 |
| Sentinel | 1.8.4 | 流量控制组件 | 进入 | 进入 |
| Springdoc-openapi | 2.0.0 | Swagger 3 接口文档自动生成 | 进入 | 进入 |
| Spring Boot Admin | 3.0.0-M1 | 应用管理和监控 | 进入 | 进入 |
| Undertow | 2.2.17.Final | Java 开发的高性能 Web 服务器 | 进入 | 进入 |
| Docker | - | 应用容器引擎 | 进入 | - |
| Jenkins | - | 自动化部署工具 | 进入 | - |
| Sonarqube | - | 代码质量控制 | 进入 | - |
注：更多热门新技术待集成。
| 技术 | 版本 | 说明 | 官网 | 学习 |
|---|---|---|---|---|
| Vue.js | 3.2.13 | 渐进式 JavaScript 框架 | 进入 | 进入 |
| Vue Router | 4.0.15 | Vue.js 的官方路由 | 进入 | 进入 |
| axios | 0.27.2 | 基于 promise 的网络请求库 | 进入 | 进入 |
| element-plus | 2.2.0 | 基于 Vue 3，面向设计师和开发者的组件库 | 进入 | 进入 |
- 规范方式：严格遵守阿里编码规约。
- 命名统一：简介最大程度上达到了见名知意。
- 分包明确：层级分明可快速定位到代码位置。
- 注释完整：描述性高大量减少了开发人员的代码阅读工作量。
- 工具规范：使用统一jar包避免出现内容冲突。
- 代码整洁：可读性、维护性高。
- 依赖版本：所有依赖均使用当前最新可用版本以便新技术学习。
io
+- github
+- xxyopen
+- novel
+- NovelApplication.java -- 项目启动类
|
+- core -- 项目核心模块，包括各种工具、配置和常量等
| +- common -- 业务无关的通用模块
| | +- exception -- 通用异常处理
| | +- constant -- 通用常量
| | +- req -- 通用请求数据格式封装，例如分页请求数据
| | +- resp -- 接口响应工具及响应数据格式封装
| | +- util -- 通用工具
| |
| +- annotation -- 自定义注解类
| +- aspect -- Spring AOP 切面
| +- auth -- 用户认证授权相关
| +- config -- 业务相关配置
| +- constant -- 业务相关常量
| +- filter -- 过滤器
| +- interceptor -- 拦截器
| +- json -- JSON 相关的包，包括序列化器和反序列化器
| +- task -- 定时任务
| +- util -- 业务相关工具
| +- wrapper -- 装饰器
|
+- dto -- 数据传输对象，包括对各种 Http 请求和响应数据的封装
| +- req -- Http 请求数据封装
| +- resp -- Http 响应数据封装
|
+- dao -- 数据访问层，与底层 MySQL 进行数据交互
+- manager -- 通用业务处理层，对第三方平台封装、对 Service 层通用能力的下沉以及对多个 DAO 的组合复用
+- service -- 相对具体的业务逻辑服务层
+- controller -- 主要是处理各种 Http 请求，各类基本参数校验，或者不复用的业务简单处理，返回 JSON 数据等
| +- front -- 小说门户相关接口
| +- author -- 作家管理后台相关接口
| +- admin -- 平台管理后台相关接口
| +- app -- app 接口
| +- applet -- 小程序接口
| +- open -- 开放接口，供第三方调用
- 接口文档
最开始是没有学习版的，只有一个爬虫/原创小说项目（最终发展成为 novel-plus 项目），用户群体大部分是对小说有兴趣，想自建一个干净无广告的小说网站的个人和站长。
后面随着使用人数逐渐增加，想通过这个项目来学习 Java 技术的人数也多了起来，对这部分用户来说，之前的项目用来学习很困难，具体原因如下：
- novel-plus 功能模块比较多，重复性的增删改查占了大部分，而用户时间是有限的，很难在有限的时间内筛选出对自己有帮助的功能模块来学习。
- novel-plus 追求的是系统稳定，用户很难在其中学习到最新的技术。
- novel-plus 代码规范性不够，受限于开发时间限制，代码开发时没有选择一个标准化的规范去参考。
- novel-plus 文档缺失，由于功能比较多，整个系统的教程编写需要花费大量时间，即使教程最终上线成功，用户也不可能有那么多时间也没有意义去学习所有的功能。
最终，novel（单体架构） 和 novel-cloud（微服务架构）诞生了，这两个项目在保证核心流程完整的同时，从 novel-plus 中选用了一些有代表性的功能，使用最新技术栈（不间断地更新和集成新技术），在保姆级教程的帮助下，尽量保证每一个功能都能让你学到不重复的技术。
所以这两个项目我的重点是去堆技术而不是去堆功能，功能只是其中的辅助，堆太多的重复性增删改查功能没有意义，对学习的帮助也不大。