首款Java开源小说系统
本系统是业界首个完全开源、模块化设计、高可扩展的Java小说站解决方案,基于Spring Boot 3.x + MyBatis Plus + Vue 3构建,支持单机、集群、分布式部署模式,适配PC、H5、小程序、APP等多端访问场景,具备完善的用户体系、内容管理、支付接入、SEO优化、性能监控与安全防护能力,已广泛应用于中小型网文平台、自媒体小说站、知识付费站点等场景。
系统核心特性
- ⚡ 高并发架构:支持单机10万+ QPS,通过Redis集群+本地缓存+CDN三级缓存机制,响应时间<50ms(P99)
- ⚙️ 分布式扩展:支持分库分表(ShardingSphere)、服务熔断(Sentinel)、异步任务(XXL-JOB)
- 〔小说引擎〕:支持TXT/EPUB/MOBI格式解析导入,自动生成目录、章节、封面、摘要、标签
- 〈多端适配〕:响应式前端+原生APP接口,适配微信小程序、支付宝小程序、抖音小程序
- 《支付体系》:集成微信/支付宝/银联/云闪付/虚拟币,支持打赏、订阅、包月、限免等全模式
- 「SEO优化」:自动生成静态HTML+动态预渲染+结构化数据(JSON-LD)+sitemap.xml
- 『内容安全』:集成阿里云内容安全API+本地关键词过滤+人工审核工作流
- 【插件生态】:支持模块热插拔,已开放广告、统计、弹幕、书评、作者中心等32+插件
核心技术架构解析
分层架构设计
系统采用经典六层架构:表现层(Web API)、控制层(Controller)、服务层(Service)、数据访问层(Mapper)、基础设施层(Infrastructure)与工具层(Util),严格遵循DDD(领域驱动设计)思想,各层职责清晰、低耦合、高内聚。
核心依赖栈如下:
| 层级 | 技术选型 | 说明 |
|---|---|---|
| 后端框架 | Spring Boot 3.2.x | 基于 Jakarta EE 规范,支持 Java 17+,内置Tomcat/Nginx嵌入式支持 |
| 持久层 | MyBatis Plus 3.5.x | CRUD零SQL开发,支持Lambda表达式、条件构造器、分页插件 |
| 缓存 | Redis 7.x + Caffeine 3.x | 双级缓存:本地热数据+分布式缓存,避免缓存击穿/穿透/雪崩 |
| 消息队列 | Kafka 3.6.x / RocketMQ 5.x | 异步解耦:订单处理、通知推送、日志采集、内容同步 |
| 任务调度 | XXL-JOB 2.4.x | 可视化任务管理,支持分布式任务分片与失败重试 |
| 前端框架 | Vue 3 + Pinia + Vite | Composition API + 组合式函数,SSR可选,SEO友好 |
| 安全框架 | Spring Security + JWT + OAuth2 | RBAC权限模型,支持Token刷新、多端登录控制 |
数据库设计范式
核心表结构遵循第三范式(3NF),关键表包括:
- 〈novel_info〉:小说主信息表,字段含 novel_id、title、author、category_id、status、word_count、cover_url、create_time
- 『chapter_meta』:章节元信息表,含 chapter_id、novel_id、title、word_count、is_vip、price、update_time
- 【chapter_content】:章节正文表,采用大字段分片存储(TEXT/BLOB),避免锁竞争
- 『user_account』:用户主表,集成第三方登录(微信/QQ/微博/抖音)
- 〈order_log〉:订单记录表,支持状态机流转:待支付→已支付→已完成→已退款
针对高并发读场景,系统采用读写分离架构,主库写入,2台从库读取,通过ShardingSphere实现自动路由。写操作走主库,读操作走从库,并配置读写延迟阈值(<100ms),保障数据一致性。
缓存策略详解
系统采用三级缓存策略,最大限度降低数据库压力:
- ① 一级缓存(本地):使用Caffeine,缓存高频访问数据如小说基础信息、章节标题列表,TTL=5分钟,最大容量5000条
- ② 二级缓存(分布式):Redis集群(3主3从),缓存用户会话、配置项、广告位、热门小说榜单,Key设计为:novel:info:{id}、user:session:{token}
- ③ 三级缓存(CDN):静态资源(JS/CSS/图片)通过阿里云CDN加速,设置Cache-Control:max-age=31536000
缓存更新策略采用Cache-Aside模式:读时先查缓存,未命中则查DB并回填;写时先更新DB,再删除缓存,由下次读触发重建。同时引入缓存预热机制,在每日凌晨低峰期批量加载首页热门小说、新书榜单至Redis。
异步处理与消息队列
系统将耗时操作异步化,提升用户体验与系统吞吐量:
- ⑴ 新书上架:小说发布后,异步触发SEO静态页生成、Redis缓存更新、消息推送(用户订阅通知)
- ⑵ 订单完成:支付回调后,异步发放VIP权益、更新用户等级、记录财务报表
- ⑶ 内容安全:小说章节提交后,异步调用内容安全API检测,结果入库并通知作者
- ⑷ 数据统计:每日凌晨2点执行离线统计任务(UV/PV/付费转化率),生成可视化报表
消息队列采用延迟队列实现“超时未支付订单自动取消”,延迟2小时触发;使用死信队列(DLQ)处理失败消息,支持人工重试与告警通知。
部署方案全景
单机部署(快速入门)
适用于个人开发者、小规模测试环境,部署步骤如下:
git clone https://github.com/xservx/novel-java.git cd novel-java mvn clean package -DskipTests java -jar target/novel-3.2.0.jar --spring.profiles.active=prod
配置文件位于src/main/resources/application-prod.yml,关键参数示例:
| 参数 | 示例值 | 说明 |
|---|---|---|
| spring.datasource.url | jdbc:mysql://localhost:3306/novel?useSSL=false | 数据库地址 |
| spring.redis.host | 127.0.0.1 | Redis服务地址 |
| server.port | 8080 | 服务端口 |
| novel.static.domain | https://static.xservx.com | 静态资源域名(CDN地址) |
首次启动后访问http://localhost:8080/admin,使用默认账号admin / 密码xservx123登录后台,执行数据库初始化脚本sql/init.sql。
集群部署(生产环境)
为保障高可用,推荐采用Nginx+Tomcat集群+MySQL主从+Redis集群方案:
- ㈠ 网关层:Nginx反向代理,负载均衡算法采用加权轮询(weight=3:2),健康检查间隔5s
- ㈡ 应用层:部署2台Tomcat节点,共享Session(Redis Session存储)
- ㈢ 数据层:MySQL主从复制(半同步模式),从库只读,避免主从延迟导致读脏数据
- ㈣ 缓存层:Redis集群(3主3从),Key分片算法采用CRC16(key)%10000
- ㈤ 文件层:小说封面、章节图片存储于MinIO分布式对象存储,避免本地磁盘瓶颈
使用Docker Compose一键部署脚本:
version: '3.8'
services:
mysql:
image: mysql:8.0
environment:
MYSQL_ROOT_PASSWORD: xservx123
MYSQL_DATABASE: novel
volumes:
- ./mysql/data:/var/lib/mysql
redis:
image: redis:7-alpine
command: redis-server --appendonly yes
volumes:
- ./redis/data:/data
app:
build: .
ports:
- "8080:8080"
depends_on:
- mysql
- redis
Kubernetes部署(云原生)
支持Helm Chart快速部署至K8s集群,核心配置项:
- ● replicas: 3(应用副本数)
- ● resources.requests.cpu: 500m(请求CPU)
- ● resources.limits.memory: 1Gi(内存上限)
- ● ingress.enabled: true(启用Ingress)
- ● redis.cluster.enabled: true(启用Redis集群)
部署命令:
helm repo add xservx https://charts.xservx.com helm install novel xservx/novel --namespace novel-system --create-namespace
系统自动创建Service、Ingress、ConfigMap、Secret等资源,支持滚动更新、回滚、弹性伸缩(HPA)。
二次开发指南
模块化插件体系
系统采用“核心+插件”架构,核心模块(novel-core)提供基础能力(用户/小说/章节/订单),插件模块(如novel-plugin-ad、novel-plugin-danmaku)独立打包,通过SPI机制动态加载。
插件开发流程:
- ① 创建Maven模块,继承
com.xservx.novel.plugin.NovelPlugin - ② 实现
init()(初始化)、destroy()(销毁)、getInfo()(插件元信息) - ③ 通过
PluginRegistry注册事件监听器(如章节发布后触发广告填充) - ④ 配置
resources/META-INF/services/com.xservx.novel.plugin.NovelPlugin文件,内容为插件全限定类名 - ⑤ 打包为JAR,放入
plugins/目录,系统启动时自动加载
示例:开发“新书提醒”插件
public class NewBookNotifyPlugin implements NovelPlugin {
@Autowired
private UserService userService;
@Autowired
private MailService mailService;
@Override
public void init() {
PluginRegistry.register(ChapterEvent.NEW_PUBLISH, event -> {
Chapter chapter = event.getData();
List subscribers = userService.findBySubscribe(chapter.getNovelId());
for (User user : subscribers) {
mailService.send(user.getEmail(), "新书上架", chapter.getTitle() + "已发布!");
}
});
}
}
API扩展规范
系统RESTful API遵循OpenAPI 3.0规范,示例:
GET /api/v1/novels/{id}
Response: {
"code": 200,
"data": {
"id": 123,
"title": "《星尘纪元》",
"author": "星辰大海",
"status": 1,
"wordCount": 1250000
},
"message": "success"
}
统一响应码规范:
| Code | 说明 | 示例 |
|---|---|---|
| 200 | 请求成功 | 获取小说详情 |
| 400 | 参数错误 | 章节ID为空 |
| 401 | 未授权 | Token失效 |
| 403 | 无权限 | 未购买VIP章节 |
| 404 | 资源不存在 | 小说ID不存在 |
| 500 | 服务异常 | 数据库连接失败 |
前端组件化开发
前端基于Vue 3 + Vite,采用 Composition API 风格,核心组件:
- 〈NovelList.vue〉:小说列表组件,支持分页、排序、筛选
- 『ChapterReader.vue』:阅读器组件,支持目录跳转、夜间模式、字体调整
- 【SearchBar.vue】:搜索框组件,集成联想词、热词推荐
- 「Bookshelf.vue」:书架组件,支持拖拽排序、批量管理
示例:阅读器组件核心逻辑
const ChapterReader = defineComponent({
setup() {
const { novelId, chapterId } = useRouteParams();
const chapter = ref(null);
onMounted(async () => {
chapter.value = await fetchChapter(novelId, chapterId);
updateHistory(novelId, chapterId);
});
return {
chapter,
setFontSize: (size) => {
document.body.style.fontSize = size + 'px';
}
};
}
});
数据库迁移方案
使用Flyway管理数据库版本,迁移脚本位于src/main/resources/db/migration:
V1__init_database.sql V2__add_user_phone.sql V3__add_novel_cover.sql
脚本命名规范:V{version}__{description}.sql,支持自动检测、顺序执行、回滚(可选)。生产环境升级时,先执行flyway baseline标记基线版本,再增量升级。
SEO优化实战
结构化数据标注
系统在小说详情页自动注入JSON-LD结构化数据,符合Google News和Bing规范:
通过schema.org标记,搜索引擎可识别小说标题、作者、分类、字数、评分等关键信息,提升搜索结果丰富度(Rich Snippet)。
静态化策略
系统支持两种静态化方案:
- ㈠ 服务端静态化:通过Thymeleaf模板渲染HTML,缓存至Nginx本地目录,访问时直接返回文件(无需经过Java应用)
- ② 客户端静态化:Next.js SSR生成静态页,部署至Vercel/Cloudflare Pages
静态化触发条件:
- 小说上架时生成首页+分类页
- 章节发布时生成小说详情页+章节页
- 用户评论后刷新相关页面(延迟30秒)
静态文件命名规则:/novel/{novelId}.html,通过Nginx配置:
location /novel/ {
try_files $uri $uri/ /index.html;
}
动态预渲染方案
针对SPA应用,采用Prerender SPA Plugin生成静态快照:
new PrerenderSPAPlugin({
staticDir: path.join(__dirname, 'dist'),
routes: ['/novel/123', '/chapter/456'],
renderer: new PuppeteerRenderer({
headless: false,
renderAfterDocumentEvent: 'render-ready'
})
})
当用户访问时,服务器返回预渲染HTML,浏览器加载后接管路由,兼顾SEO与交互体验。
关键词优化策略
系统内置关键词分析模块,自动提取小说核心词:
- ⑴ 提取标题关键词:《星尘纪元》→ 星尘、纪元、科幻小说
- ⑵ 分析正文TF-IDF:高频词自动标注为标签
- ⑶ 关联用户搜索词:从日志提取Top100搜索词,生成长尾词库
生成页面Meta标签:
<meta name="keywords" content="星尘纪元,星辰大海,科幻小说,长篇小说,网络文学"> <meta name="description" content="《星尘纪元》是星辰大海创作的科幻小说,讲述人类文明在星尘纪元的崛起与抗争...">
同时,系统自动向百度站长平台、Google Search Console提交sitemap.xml,每日更新小说与章节链接。
安全防护体系
输入校验与过滤
系统采用多层输入校验机制:
- ① 前端校验:使用VeeValidate校验表单格式(邮箱、手机号、密码强度)
- ② 后端校验:@Valid + @NotNull/@Size/@Pattern注解
- ③ SQL注入防护:MyBatis Plus预编译参数,禁止拼接SQL
- ④ XSS防护:Spring Security默认开启XSS过滤,Content-Security-Policy头设置
敏感词过滤采用DFA算法实现,关键词库每日从阿里云更新,支持自定义词库热加载:
public class SensitiveWordFilter {
private static final TrieNode ROOT = new TrieNode();
static {
// 初始化敏感词树
List words = loadFromDatabase();
for (String word : words) {
insertWord(word);
}
}
public static String filter(String text) {
// DFA过滤逻辑
...
}
}
权限控制模型
系统采用RBAC(基于角色的访问控制)+ ABAC(基于属性的访问控制)混合模型:
- ● 角色:管理员、编辑、作者、VIP读者、普通用户
- ● 权限:小说发布、章节审核、用户管理、支付查询
- ● 属性:用户等级、会员状态、IP白名单
权限校验注解:
@PreAuthorize("hasRole('ADMIN') or hasPermission(#novelId, 'publish')")
public void publishNovel(Novel novel) {
// ...
}
通过Spring Security Method Security实现细粒度权限控制。
支付安全规范
支付环节严格遵循PCI-DSS标准:
- ⑴ 敏感信息加密:银行卡号、身份证号使用AES-256加密存储
- ⑵ 支付签名验证:所有支付请求带MD5签名,服务端校验签名一致性
- ⑶ 防重放攻击:订单号全局唯一(Snowflake算法),同一订单号重复请求拒绝处理
- ⑷ 交易风控:实时监控异常订单(如单笔超5000元、高频小额支付)
支付回调流程:
- ① 支付平台推送异步通知(HTTPS POST)
- ② 校验签名与订单状态
- ③ 更新订单为“已支付”
- ④ 触发异步任务(发放权益、记录日志)
- ⑤ 返回“SUCCESS”给支付平台
系统支持支付平台沙箱环境测试,确保上线前流程正确性。
插件生态全景
广告系统
内置5大广告位:首页Banner、小说页顶部通栏、章节页内嵌、 sidebar推荐位、底部通栏,支持CPC(点击付费)、CPM(千次曝光)、CPT(时段投放)三种模式。
广告加载策略:
- ① 广告位缓存:Redis缓存广告内容,TTL=10分钟
- ② A/B测试:随机分配广告版本,统计点击率
- ③ 防刷机制:同一IP 1小时内点击超10次触发风控
广告API示例:
GET /api/v1/ads?position=home_banner
Response: {
"position": "home_banner",
"ads": [
{
"id": 101,
"title": "XX小说APP",
"image": "https://cdn.xservx.com/ad/101.jpg",
"clickUrl": "https://app.example.com/download"
}
]
}
弹幕系统
弹幕功能基于WebSocket实现实时通信,支持弹幕发送、接收、屏蔽、举报。
弹幕流程:
- ① 用户在阅读页输入弹幕内容
- ② 前端通过WebSocket发送至服务端
- ③ 服务端校验内容安全后广播至当前章节所有用户
- ④ 弹幕持久化至MySQL,用于后续分析
弹幕频率控制:单用户每分钟最多发送3条,超限返回429错误。
弹幕样式支持自定义:颜色、大小、滚动速度、停留时长,前端通过CSS变量动态设置:
.danmaku[data-color="#ff5500"] {
color: #ff5500;
animation: scroll 10s linear infinite;
}
数据分析
系统内置数据看板,支持以下指标:
| 指标 | 定义 | 计算方式 |
|---|---|---|
| UV/PV | 独立访客/页面浏览量 | Redis HyperLogLog统计 |
| 留存率 | 次日/7日/30日活跃用户占比 | 用户行为日志分析 |
| 付费转化率 | 付费用户/总用户数 | 订单表统计 |
| 章节完读率 | 读完章节数/总章节数 | 章节阅读时长聚合 |
数据导出支持CSV/Excel,可对接BI工具(如Superset)进行深度分析。
社区支持体系
文档与教程
系统提供完整文档体系:
- 《快速入门》:5分钟部署本地环境
- 《架构设计》:核心模块源码解析
- 《部署手册》:生产环境高可用方案
- 《插件开发》:插件编写与调试指南
- 《API参考》:所有接口详细参数
文档托管于GitBook,支持在线搜索与版本切换,地址:docs.xservx.com
问题反馈渠道
用户可通过以下方式反馈问题:
- ① GitHub Issues:https://github.com/xservx/novel-java/issues
- ② Gitee 问题跟踪:https://gitee.com/xservx/novel-java/issues
- ③ 微信交流群:扫描官网二维码加入
- ④ 邮件支持:support@xservx.com(24小时内响应)
社区贡献者可提交PR(Pull Request),经代码审查后合并至主干,优秀贡献者将进入贡献者荣誉榜。
开源协议与商业授权
系统采用Apache License 2.0开源协议,允许:
- ● 商用:可免费用于商业项目,无需付费
- ● 修改:可修改源码,但需保留原始版权声明
- ● 分发:可分发修改后的版本,但需注明修改内容
禁止行为:
- × 禁止移除或修改原始版权声明
- × 禁止将本软件用于非法或违反公序良俗的场景
- × 禁止利用本软件从事网络攻击、数据窃取等行为
对于需要闭源商用的企业,可购买商业授权(contact@xservx.com),享受专属技术支持、定制开发、优先Bug修复等服务。
实战案例精选
案例一:墨语小说网
墨语小说网(moyu.xservx.com)采用本系统部署,日活用户15万+,日均章节发布量2000+,峰值QPS 8500。
优化措施:
- ① 将小说封面存储迁移至OSS,CDN加速后加载速度提升300%
- ② 启用Redis集群,缓存命中率从78%提升至95%
- ③ 静态化首页+分类页,页面加载时间从2.1s降至0.6s
效果:付费转化率提升12%,用户平均停留时长增加45秒。
案例二:星尘文学
星尘文学(xingchen.xservx.com)专注科幻小说,采用微服务架构,支持10万+并发用户。
关键改造:
- ① 使用ShardingSphere分库分表,订单表拆分为64库128表
- ② 章节内容表采用分页查询(每页2000字),避免大字段查询
- ③ 引入Elasticsearch实现全文检索,搜索响应时间<200ms
上线3个月,注册用户突破50万,付费用户达8万+。
案例三:轻语书屋
轻语书屋(qingyu.xservx.com)采用H5+小程序双端部署,聚焦短篇小说市场。
特色功能:
- ① 支持“听书”功能,章节内容转语音(TTS)
- ② “碎片阅读”模式,按段落分页,适合移动端碎片时间阅读
- ③ 用户打卡奖励机制,连续阅读7天送VIP时长
小程序日活2万+,分享率18%,成为区域热门小说平台。