手把手教你从零开始开发上线一个生产级别的 Java 小说系统
项目简介
novel 是一套基于时下最新 Java 技术栈 Spring Boot 3 + Vue 3 开发的前后端分离的学习型小说项目，配备详细的项目开发文档手把手教你从零开始开发上线一个生产级别的 Java 系统，由小说门户系统、作家后台管理系统、平台后台管理系统等多个子系统构成。包括小说推荐、作品检索、小说排行榜、小说阅读、小说评论、会员中心、作家专区、充值订阅、新闻发布等功能。
#开发环境
-
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配置属性开启。
技术架构
运行环境
-
JDK 17
-
MySQL 8.0
-
Redis 7.0
-
Elasticsearch 8.2（默认关闭）
-
RabbitMQ 3.10.2 （默认关闭）
-
XXL-JOB 2.3.1（默认关闭）
-
Undertow 2.2
-
Nginx 1.21
#后端技术选型
| 技术 | 版本 | 说明 | 官网 | 学习 |
|---|---|---|---|---|
| Spring Boot | 3.0.0 | 容器 + MVC 框架 | 进入(opens new window) | 进入(opens new window) |
| MyBatis | 3.5.9 | ORM 框架 | 进入(opens new window) | 进入(opens new window) |
| MyBatis-Plus | 3.5.3 | MyBatis 增强工具 | 进入(opens new window) | 进入(opens new window) |
| JJWT | 0.11.5 | JWT 登录支持 | 进入(opens new window) | - |
| Lombok | 1.18.24 | 简化对象封装工具 | 进入(opens new window) | 进入(opens new window) |
| Caffeine | 3.1.0 | 本地缓存支持 | 进入(opens new window) | 进入(opens new window) |
| Redis | 7.0 | 分布式缓存支持 | 进入(opens new window) | 进入(opens new window) |
| Redisson | 3.17.4 | 分布式锁实现 | 进入(opens new window) | 进入(opens new window) |
| MySQL | 8.0 | 数据库服务 | 进入(opens new window) | 进入(opens new window) |
| ShardingSphere-JDBC | 5.1.1 | 数据库分库分表支持 | 进入(opens new window) | 进入(opens new window) |
| Elasticsearch | 8.2.0 | 搜索引擎服务 | 进入(opens new window) | 进入(opens new window) |
| RabbitMQ | 3.10.2 | 开源消息中间件 | 进入(opens new window) | 进入(opens new window) |
| XXL-JOB | 2.3.1 | 分布式任务调度平台 | 进入(opens new window) | 进入(opens new window) |
| Sentinel | 1.8.4 | 流量控制组件 | 进入(opens new window) | 进入(opens new window) |
| Springdoc-openapi | 2.0.0 | Swagger 3 接口文档自动生成 | 进入(opens new window) | 进入(opens new window) |
| Spring Boot Admin | 3.0.0-M1 | 应用管理和监控 | 进入(opens new window) | 进入(opens new window) |
| Undertow | 2.2.17.Final | Java 开发的高性能 Web 服务器 | 进入(opens new window) | 进入(opens new window) |
| Docker | - | 应用容器引擎 | 进入(opens new window) | - |
| Jenkins | - | 自动化部署工具 | 进入(opens new window) | - |
| Sonarqube | - | 代码质量控制 | 进入(opens new window) | - |
注：更多热门新技术待集成。
前端技术选型
| 技术 | 版本 | 说明 | 官网 | 学习 |
|---|---|---|---|---|
| Vue.js | 3.2.13 | 渐进式 JavaScript 框架 | 进入(opens new window) | 进入(opens new window) |
| Vue Router | 4.0.15 | Vue.js 的官方路由 | 进入(opens new window) | 进入(opens new window) |
| axios | 0.27.2 | 基于 promise 的网络请求库 | 进入(opens new window) | 进入(opens new window) |
| element-plus | 2.2.0 | 基于 Vue 3，面向设计师和开发者的组件库 | 进入(opens new window) | 进入(opens new window) |
编码规范
-
规范方式：严格遵守阿里编码规约。
-
命名统一：简介最大程度上达到了见名知意。
-
分包明确：层级分明可快速定位到代码位置。
-
注释完整：描述性高大量减少了开发人员的代码阅读工作量。
-
工具规范：使用统一jar包避免出现内容冲突。
-
代码整洁：可读性、维护性高。
-
依赖版本：所有依赖均使用当前最新可用版本以便新技术学习。
包结构
io
+- github
+- xxyopen
+- novel
+- NovelApplication.java -- 项目启动类
|
+- core -- 项目核心模块，包括各种工具、配置和常量等
| +- common -- 业务无关的通用模块
| | +- exception -- 通用异常处理
| | +- constant -- 通用常量
| | +- req -- 通用请求数据格式封装，例如分页请求数据
| | +- resp -- 接口响应工具及响应数据格式封装
| | +- util -- 通用工具
| |
| +- 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 -- 开放接口，供第三方调用版本说明
-
主版本号：产品方向改变， 或者大规模 API 不兼容， 或者架构不兼容升级。
-
次版本号：保持相对兼容性，增加主要功能特性，影响范围极小的 API 不兼容修改。
-
修订号：保持完全兼容性， 修复 BUG、 新增次要功能特性等。
数据库设计
数据库设计规约
-
表达是与否概念的字段，必须使用 is_xxx 的方式命名，数据类型是 unsigned tinyint（ 1 表示是， 0 表示否）。
说明：任何字段如果为非负数，必须是 unsigned，坚持 is_xxx 的命名方式是为了明确其取值含义与取值范围。
正例：表达逻辑删除的字段名 is_deleted， 1 表示删除， 0 表示未删除。
-
表名、字段名必须使用小写字母或数字， 禁止出现数字开头，禁止两个下划线中间只出现数字。数据库字段名的修改代价很大，字段名称需要慎重考虑。
说明：MySQL 在 Windows 下不区分大小写，但在 Linux 下默认是区分大小写。因此，数据库名、表名、字段名，都不允许出现任何大写字母，避免节外生枝。
-
表名不使用复数名词。
说明：表名应该仅仅表示表里面的实体内容，不应该表示实体数量，对应于 DO 类名也是单数形式，符合表达习惯。
-
禁用保留字，如 desc、 range、 match、 delayed 等， 请参考 MySQL 官方保留字。
-
主键索引名为 pk_字段名；唯一索引名为 uk_字段名；普通索引名则为 idx_字段名。
说明：pk_ 即 primary key；uk_ 即 unique key；idx_ 即 index 的简称。
-
小数类型为 decimal，禁止使用 float 和 double。
说明：在存储的时候， float 和 double 都存在精度损失的问题，很可能在比较值的时候，得到不正确的结果。如果存储的数据范围超过 decimal 的范围，建议将数据拆成整数和小数并分开存储。
-
如果存储的字符串长度几乎相等，使用 char 定长字符串类型。
-
varchar 是可变长字符串，不预先分配存储空间，长度不要超过 5000，如果存储长度大于此值，定义字段类型为 text，独立出来一张表，用主键来对应，避免影响其它字段索引效率。
-
表必备三字段：id, create_time, update_time。
说明：其中 id 必为主键，类型为 bigint unsigned、单表时自增、步长为 1。create_time, update_time的类型均为 datetime 类型，前者现在时表示主动式创建，后者过去分词表示被动式更新。
注意：更新数据表记录时，必须同时更新记录对应的 update_time 字段值为当前时间。
-
表的命名最好是遵循“业务名称_表的作用” 。
正例：book_info / book_chapter / user_bookshelf / user_comment / author_info
-
库名与应用名称尽量一致。
-
如果修改字段含义或对字段表示的状态追加时，需要及时更新字段注释。
-
字段允许适当冗余，以提高查询性能，但必须考虑数据一致。冗余字段应遵循：
-
不是频繁修改的字段。
-
不是唯一索引的字段。
-
不是 varchar 超长字段，更不能是 text 字段。
-
正例：各业务线经常冗余存储小说名称，避免查询时需要连表（单体应用）或跨服务（微服务应用）获取。
-
单表行数超过 500 万行或者单表容量超过 2GB，才推荐进行分库分表。
说明：如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。
-
合适的字符存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检索速度。
正例：无符号值可以避免误存负数， 且扩大了表示范围。
-
业务上具有唯一特性的字段，即使是组合字段，也必须建成唯一索引。
说明：不要以为唯一索引影响了 insert 速度，这个速度损耗可以忽略，但提高查找速度是明显的；另外，即使在应用层做了非常完善的校验控制，只要没有唯一索引，根据墨菲定律，必然有脏数据产生。
-
超过三个表禁止 join。需要 join 的字段，数据类型保持绝对一致；多表关联查询时，保证被关联的字段需要有索引。
说明：即使双表 join 也要注意表索引、 SQL 性能。
-
在 varchar 字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度。
说明：索引的长度与区分度是一对矛盾体，一般对字符串类型数据，长度为 20 的索引，区分度会高达 90%以上，可以使用 count(distinct left(列名, 索引长度))/count(*)的区分度来确定。
-
创建索引时避免有如下极端误解：
-
索引宁滥勿缺。认为一个查询就需要建一个索引。
-
吝啬索引的创建。认为索引会消耗空间、 严重拖慢记录的更新以及行的新增速度。
-
抵制惟一索引。认为惟一索引一律需要在应用层通过“先查后插” 方式解决。
-
数据库建模工具
本项目使用PDManer对数据库进行设计、版本管理等。