一、开源项目简介
novel 是一套基于时下 最新 Java 技术栈 Spring Boot 3 + Vue 3 开发的前后端分离的 学习型 小说项目，配备详细的项目教程手把手教你 从零开始 开发上线一个生产级别的 Java 系统，由小说门户系统、作家 后台管理系统 、平台后台管理系统、爬虫管理系统等多个子系统构成。包括小说推荐、作品检索、小说排行榜、小说阅读、小说评论、充值订阅、新闻发布等功能。
二、开源协议
使用Apache-2.0开源协议
三、界面展示
截图
1、首页
2、分类索引页
3、搜索页
4、排行榜
5、详情页
6、阅读页
7、用户中心
8、充值
9、作家专区
10、购买
11、接口文档
四、功能概述
novel 是一套基于时下最新 Java 技术栈 Spring Boot 3 + Vue 3 开发的前后端分离学习型小说项目，配备详细项目开发文档，由小说门户系统、作家后台管理系统、平台后台管理系统等多个子系统构成。包括小说推荐、作品检索、小说排行榜、小说阅读、小说评论、会员中心、作家专区、充值订阅、新闻发布等功能。
novel 由前台门户系统、作家后台管理系统、平台后台管理系统和爬虫管理系统以及后面可能会扩展的漫画系统和视频系统等多个子系统构成，是一个复杂的多系统环境。平台端的后台管理系统和爬虫管理系统账号是独立的，用户端其它子系统要求统一账号登录。
提供平台管理后台、爬虫管理后台和单点登录三个登录入口，前端在每个登录入口登录成功之后都会获得后端返回的 token，这个时候需要分别保存起来， 在请求相应系统的后端接口时，通过请求头携带上相应的 token。
五、技术选型
开发环境
- 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-SNAPSHOT |
容器 + MVC 框架 |
|
MyBatis |
3.5.9 |
ORM 框架 |
|
MyBatis-Plus |
3.5.1 |
MyBatis 增强工具 |
|
JJWT |
0.11.5 |
JWT 登录支持 |
|
Lombok |
1.18.24 |
简化对象封装工具 |
|
Caffeine |
3.1.0 |
本地缓存支持 |
|
Redis |
7.0 |
分布式缓存 支持 |
|
Redisson |
3.17.4 |
分布式锁实现 |
|
MySQL |
8.0 |
数据库服务 |
|
Sharding Sphere-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-M4-SNAPSHOT |
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 -- 开放接口，供第三方调用
六、源码地址
访问一飞开源：
