# 技术架构
# 运行环境
- 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
# 后端技术选型
注：更多热门新技术待集成。
# 前端技术选型
| 技术 | 版本 | 说明 | 官网 | 学习 |
|---|---|---|---|---|
| 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、 新增次要功能特性等。