# xiaofanshu

**Repository Path**: xdlove/xiaofanshu

## Basic Information

- **Project Name**: xiaofanshu
- **Description**: （仿小红书）小番薯后端代码，主要是SpringBoot为基础框架，SpringCloudAlibaba为微服务架构，移动端有uniapp和flutter两个版本（目前只适配了安卓端），推荐看flutter版本（主页仓库）
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 12
- **Created**: 2024-11-25
- **Last Updated**: 2025-06-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# xiaofanshu小番薯

#### 介绍

#### 软件架构

基础框架：Spring Boot

持久性框架：Mybatis-Plus

MVC框架：Spring MVC

缓存：Redis

搜索引擎：ElasticSearch

关系型数据库：Mysql

非关系型数据库：MongoDB

日志：Logback+Slf4j

依赖管理：Maven

消息中间件：RocketMQ

分布式调度中心：xxl-job

微服务架构：

- Spring Cloud+Spring Cloud Alibaba
- 服务中心+配置中心：nacos
- 网关：gateway
- 事务统一：RocketMQ的事务消息

#### 项目部分截图

<img alt="屏幕截图" src="./project-screenshot/Screenshot_20240910_165224.png" width="200"/>

<img alt="屏幕截图" src="./project-screenshot/微信图片_20240910165649.jpg" width="200"/>

<img alt="屏幕截图" src="./project-screenshot/微信图片_20240910165704.jpg" width="200"/>

<img alt="屏幕截图" src="./project-screenshot/微信图片_20240910165709.jpg" width="200"/>

<img alt="屏幕截图" src="./project-screenshot/微信图片_20240910165714.jpg" width="200"/>

<img alt="屏幕截图" src="./project-screenshot/微信图片_20240910165718.jpg" width="200"/>

<img alt="屏幕截图" src="./project-screenshot/微信图片_20240910165723.jpg" width="200"/>

<img alt="屏幕截图" src="./project-screenshot/微信图片_20240910165728.jpg" width="200"/>

<img alt="屏幕截图" src="./project-screenshot/微信图片_20240910165733.jpg" width="200"/>

<img alt="屏幕截图" src="./project-screenshot/微信图片_20240910165738.jpg" width="200"/>

<img alt="屏幕截图" src="./project-screenshot/微信图片_20240910165743.jpg" width="200"/>

<img alt="屏幕截图" src="./project-screenshot/微信图片_20240910165942.jpg" width="200"/>

## 项目文件目录说明

本项目包含以下目录和文件。请根据文件结构将文件存放到相应位置。

### 目录结构

```

dir
├── config
│   ├── broker.conf
│   ├── elasticsearch.yml
│   ├── init-message.js
│   ├── init.sql
│   ├── redis.conf
│   └── run.sh
├── jar
│   ├── ......
│   └── ......
├── docker-compose-amd-xfs.yaml
├── docker-compose-arm-xfs.yaml
├── xiaofanshu-amd.dockerfile
├── xiaofanshu-arm.dockerfile
└── docker-pre.sh

````

### 文件说明

- `config/`  
  配置文件目录，包含项目所需的各种配置文件：
    - `broker.conf`: Broker 配置文件
    - `elasticsearch.yml`: Elasticsearch 配置文件
    - `init-message.js`: 初始化消息脚本
    - `init.sql`: 初始化数据库 SQL 脚本
    - `redis.conf`: Redis 配置文件
    - `run.sh`: 启动脚本
- `jar/`
    存放项目的 JAR 包目录。
- `docker-compose-amd-xfs.yaml`: AMD 架构下的 Docker Compose 配置文件
- `docker-compose-arm-xfs.yaml`: ARM 架构下的 Docker Compose 配置文件
- `xiaofanshu-amd.dockerfile`: AMD 架构下的 Dockerfile 文件
- `xiaofanshu-arm.dockerfile`: ARM 架构下的 Dockerfile 文件
- `docker-pre.sh`: 用于执行预处理操作的 Shell 脚本，建议使用 `sudo` 权限运行。

### 使用说明

#### 1. 修改ip
注意修改yaml文件中的ip地址以及后续nacos中的配置文件中的ip地址

#### 2. 执行预处理脚本

在开始使用 Docker Compose 配置之前，首先需要执行 `docker-pre.sh` 文件进行必要的预处理操作。  
执行命令如下：

```bash
sudo bash docker-pre.sh
````

#### 3. 选择架构并执行 Docker Compose

根据你的硬件架构，选择执行相应的 Docker Compose 配置文件：

* 对于 **AMD 架构**，执行以下命令：

  ```bash
  docker-compose -f docker-compose-amd-xfs.yaml up
  ```

* 对于 **ARM 架构**，执行以下命令：

  ```bash
  docker-compose -f docker-compose-arm-xfs.yaml up
  ```
#### 4.修改配置
初始化elasticsearch密码
``` bash
docker exec -it elasticsearch bash
./bin/elasticsearch-setup-passwords interactive
```

### 注意事项

* 确保在执行 `docker` 时，已经安装了 Docker 和 Docker Compose。
* 选择合适的 Docker Compose 配置文件，确保它与你的硬件架构匹配。
* 如果执行过程中遇到权限问题，请检查 `docker-pre.sh` 文件的权限，并确保有正确的执行权限。
* 在构建 Docker 镜像时，请确保本地的 Docker 环境正常运行并且网络连接正常，以便从 Docker Hub 获取所需的基础镜像。
* 按照机器的架构选择对应的步骤，arm架构，适用于树莓派等arm架构的设备，amd架构，适用于普通的服务器

<p align="center">
  <img alt="软件著作权" src="./project-screenshot/default.png" width="50%" />
</p>

### 如有疑问，请使用邮箱联系我yahaoyang929@foxmail.com