项目简介

novel 是一套基于时下最新 Java 技术栈 Spring Boot 3 + Vue 3 开发的前后端分离的学习型小说项目，配备详细的项目教程手把手教你从零开始开发上线一个生产级别的 Java 系统，由小说门户系统、作家后台管理系统、平台后台管理系统、爬虫管理系统等多个子系统构成。包括小说推荐、作品检索、小说排行榜、小说阅读、小说评论、充值订阅、新闻发布等功能。

项目地址

• 后端项目（更新中）：GitHub ｜ 码云
• 前端项目（更新中）：GitHub ｜ 码云
• 线上应用版：GitHub ｜ 码云 ｜演示地址
• 微服务版：GitHub ｜ 码云

开发环境

• 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配置属性开启。

后端技术选型

注：更多热门新技术待集成。

前端技术选型

编码规范

• 规范方式：严格遵守阿里编码规约。
• 命名统一：简介最大程度上达到了见名知意。
• 分包明确：层级分明可快速定位到代码位置。
• 注释完整：描述性高大量减少了开发人员的代码阅读工作量。
• 工具规范：使用统一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 -- 开放接口，供第三方调用 

截图

1. 首页

2. 分类索引页

3. 搜索页

4. 排行榜

5. 详情页

6. 阅读页

7. 用户中心

8. 充值

9. 作家专区

10. 购买

11. 接口文档

安装步骤

此安装步骤的前提是需要保证上一节的开发环境可用。

• 下载后端源码

git clone https://gitee.com/novel_dev_team/novel.git

• 数据库文件导入

  1. 新建数据库（建议 novel）

  2. 解压后端源码doc/sql/novel.sql.zip压缩包，得到数据库结构文件novel_struc.sql和数据库小说数据文件novel_data.sql

  3. 导入novel_struct.sql数据库结构文件

  4. 导入novel_data.sql数据库小说数据文件

• novel 后端服务安装

  1. 修改src/resources/application.yml配置文件中的数据源配置

  spring:
      datasource:
          url: jdbc:mysql://localhost:3306/novel_test?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai
          username: root
          password: test123456
  2. 修改src/resources/application.yml 和 src/resources/redisson.yml 配置文件中的redis连接配置

  spring:
      redis:
          host: 127.0.0.1
          port: 6379
          password: 123456

  singleServerConfig:
     address: "redis://127.0.0.1:6379"
     password: 123456

  3. 根据前后端的实际部署情况，修改application.yml中的跨域配置（默认情况可忽略此步骤）

  4. 项目根目录下运行如下命令来启动后端服务（有安装 IDE 的可以导入源码到 IDE 中运行）

  mvn spring-boot:run
  5. 接口文档访问地址：http://server:port/swagger-ui/index.html

• 下载前端前台门户系统源码

git clone https://gitee.com/novel_dev_team/novel-front-web.git

• novel-front-web 前端前台门户系统安装

  1. 根据前后端的实际部署情况，修改.env.development中的VUE_APP_BASE_API_URL属性（默认情况可忽略此步骤）

  2. yarn安装

  npm install -g yarn
  3. 项目根目录下运行如下命令来安装项目依赖

  yarn install
  4. 项目根目录下运行如下命令启动

  yarn serve
  5. 浏览器通过http://localhost:1024来访问

项目教程

手把手教你从零开始开发上线一个生产级别的小说系统

公众号

• 关注公众号接收项目和文档的更新动态

• 加微信群学习交流，公众号后台回复「微信群」即可

• 回复「资料」获取Java 学习面试资料

• 回复「笔记」获取Spring Boot 3 学习笔记

赞赏支持

开源项目不易，若此项目能得到你的青睐，那么你可以赞赏支持作者持续开发与维护。

• 更完善的文档教程
• 服务器的费用也是一笔开销
• 为用户提供更好的开发环境
• 一杯咖啡