# 阅说

**Repository Path**: cjp_scut/yueshuo

## Basic Information

- **Project Name**: 阅说
- **Description**:  阅说-在线小说阅读平台
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-02-26
- **Last Updated**: 2024-03-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 阅说 - 在线小说创作与阅读平台（backend）

### 项目概述

阅说是一个在线小说创作与阅读平台，创作者可以在平台上发布小说内容，读者可以浏览热门小说，发表评论并进行在线阅读。项目采用前后端分离的方式，后端基于Java 技术栈 SpringBoot开发，缓存基于 Redis，数据库采用 MySQL，项目持久层框架为 MyBatis。
由小说门户子系统和作家管理子系统构成。功能包括小说推荐、作品检索、小说排行榜、小说阅读、小说评论、作家专区等功能。

### 项目部分截图
![project.png](./story/documents%2Fproject.png)

![project_2.png](./story/documents%2Fproject_2.png)

![project4.png](./story/documents%2Fproject4.png)

![project3.png](./story/documents%2Fproject3.png)

### 运行环境

- MySQL 8.0 
- Redis 7.0
- MyBatis 3.5.9
- JDK 17 
- Maven 3.8 
- IntelliJ IDEA 2023.1
- Node 16.14

### 包结构

```bash
.
├── documents
├── logs
├── src
│   ├── main
│   │   ├── java
│   │   │   └── com
│   │   │       └── example
│   │   │           └── amer
│   │   │               └── story
│   │   │                   ├── StoryApplication.java -- 项目启动类
│   │   │                   ├── controller -- 主要是处理各种 Http 请求，各类基本参数校验，或者不复用的业务简单处理，返回 JSON 数据等
│   │   │                   │   ├── author -- 作家管理后台相关接口
│   │   │                   │   ├── front -- 小说门户相关接口
│   │   │                   ├── core -- 项目核心模块，包括各种工具、配置和常量等
│   │   │                   │   ├── annotation -- 自定义注解
│   │   │                   │   ├── auth-- 用户认证授权相关
│   │   │                   │   ├── common -- 业务无关的通用模块
│   │   │                   │   │   ├── constant -- 通用常量
│   │   │                   │   │   ├── exception -- 通用异常处理
│   │   │                   │   │   ├── req -- 通用请求数据格式封装，例如分页请求数据
│   │   │                   │   │   ├── resp -- 接口响应工具及响应数据格式封装
│   │   │                   │   │   └── util -- 通用工具
│   │   │                   │   ├── config -- 业务相关配置
│   │   │                   │   ├── constant -- 业务相关常量
│   │   │                   │   ├── filter -- 过滤器
│   │   │                   │   ├── interceptor -- 拦截器
│   │   │                   │   ├── json -- JSON 相关的包，包括序列化器和反序列化器
│   │   │                   │   │   ├── deserializer
│   │   │                   │   │   └── serializer
│   │   │                   │   ├── util -- 业务相关工具
│   │   │                   ├── dao -- 数据访问层，与底层 MySQL 进行数据交互
│   │   │                   │   ├── entity
│   │   │                   │   └── mapper
│   │   │                   ├── dto -- 数据传输对象，包括对各种 Http 请求和响应数据的封装
│   │   │                   │   ├── req -- Http 请求数据封装
│   │   │                   │   └── resp -- Http 响应数据封装
│   │   │                   ├── manager -- 通用业务处理层，对第三方平台封装、对 Service 层通用能力的下沉以及对多个 DAO 的组合复用
│   │   │                   │   ├── cache
│   │   │                   │   ├── dao
│   │   │                   │   ├── mq
│   │   │                   │   └── redis
│   │   │                   └── service -- 相对具体的业务逻辑服务层  
│   │   │                       └── impl -- 服务层接口实现
│   │   └── resources
│   │       ├── mapper
│   │       ├── static
│   │       └── templates
│   └── test

123 directories
```


### 系统后端功能概要

核心模块及功能概要如下：

- 首页模块：首页小说推荐查询等；

- 小说模块：小说信息查询、小说榜单查询、小说相关查询、小说点击量增加、章节获取、小说评论获取等；

- 用户模块：用户信息增删改查、用户注册、用户登录、评论增删改查等；

- 作家管理模块：作家注册、小说发布、章节发布、小说删改查、章节删改查等；

- 资源模块：图片上传、获取图片验证码；

- 搜索模块：小说搜索；

……



后端接口详情文档在运行后端项目后访问：http://localhost:8888/swagger-ui/index.html#/