# binyou_api

**Repository Path**: zhourubin/binyou_api

## Basic Information

- **Project Name**: binyou_api
- **Description**: 聚友园后端。使用了vite,vue3,typescript,pinia,websocket,vant等技术。该项目实现了用户登录，用户注册，创建队伍，加入队伍，更新队伍，删除队伍，加好友，验证好友，好友聊天，伙伴查找匹配，伙伴推荐等功能。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-02-28
- **Last Updated**: 2024-02-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: SpringBoot, Redis, minio, MyBatis, mybatis-plus

## README

# binyou_api

#### 介绍
聚友园后端。使用了vite,vue3,typescript,pinia,websocket,vant等技术。该项目实现了用户登录，用户注册，创建队伍，加入队伍，更新队伍，删除队伍，加好友，验证好友，好友聊天，伙伴查找匹配，伙伴推荐等功能。

## 界面展示

### 用户登录/注册

<img src="https://s2.loli.net/2024/02/29/cPaW4XRvJyNKCFD.png"/>
<img src="https://s2.loli.net/2024/02/29/c71NbnuRLXrfmxy.png"/>

### 好友列表/好友申请

<img src="https://s2.loli.net/2024/02/29/hdtiB3qD7jxTw4N.png"/>
<img src="https://s2.loli.net/2024/02/29/O5EVJsWScLPx7fj.png"/>

### 好友聊天

<img src="https://s2.loli.net/2024/02/29/efsy21UxMO9AoJv.png"/>

### 伙伴推荐

<img src="https://s2.loli.net/2024/02/29/q16KT3MkdlGJwCE.png"/>

### 根据标签搜索用户

<img src="https://s2.loli.net/2024/02/29/yBZDtSnLlOq4GwF.png"/>

### 队伍页

<img src="https://s2.loli.net/2024/02/29/uhzsLHndNG76pjT.png"/>

### 个人中心页/查看用户

<img src="https://s2.loli.net/2024/02/29/6xNyObD1YieknEU.png"/>
<img src="https://s2.loli.net/2024/02/29/TMQVyORq1XhIgJ5.png"/>


## 项目描述

- 一个帮助大家找到志同道合的伙伴的h5网站，主要有用户登录注册、更新个人信息、按标签搜索用户、关键词搜索用户、组队、加入队伍，更新队伍、退出队伍、好友聊天、好友申请等功能。

## 技术选型

### 前端

1. Vue 3

2. Vant UI 组件库（移动端）

3. Vite 脚手架

4. TypeScript

5. Axios 请求库
6. Pinia状态管理库

### 后端

1. Java SpringBoot 2.7.x 框架
2. MySQL 数据库
3. minio
4. MyBatis-Plus
5. MyBatis X 自动生成
6. Redis 缓存（Spring Data Redis 等多种实现方式）
7. Redisson 分布式锁
8. Swagger + Knife4j 接口文档
9. Gson：JSON 序列化库

### 前后端交互

## 项目亮点

1. 使用WebSocket实现好友聊天功能,实时进行交流
2. 用户登录：使用 Redis 实现分布式 Session，解决集群间登录态同步问题；并使用 Hash 代替 String 来存储用户信息，节约了 5%
   的内存并便于单字段的修改。
3. 使用minio实现头像的上传，并在服务器上进行备份
4. 使用 Easy Excel 读取收集来的基础用户信息，并通过自定义线程池 + CompletableFuture 并发编程提高批量导入数据库的性能。实测导入
5. 使用 Redis 缓存首页高频访问的用户信息列表，将接口响应时长从 800ms缩短至 120ms 。且通过自定义 Redis 序列化器来解决数据乱码、空间浪费的问题。
      100 万行的时间从 20秒缩短至 7秒。（需要自己实际测试对比数据）
6. 对于项目中复杂的集合处理（比如为队伍列表关联已加入队伍的用户），使用 Java 8 Stream API 和 Lambda 表达式来简化编码。
7. 为解决首次访问系统的用户主页加载过慢的问题，使用 Spring Scheduler 定时任务来实现缓存预热，并通过分布式锁保证多机部署时定时任务不会重复执行。
8. 为解决同一用户重复加入队伍、入队人数超限的问题，使用 Redisson 分布式锁来实现操作互斥，保证了接口幂等性。
9. 使用 Knife4j + Swagger 自动生成后端接口文档
10. 前端使用 Vant UI 组件库，并封装了全局通用的 Layout 组件，使主页、搜索页、组队页布局一致、并减少重复代码。



## 快速启动

### 后端

1. 运行 sql 目录下的 create_table.sql 建表
2. 修改 application.yml 中的数据库地址为自己的
3. 安装完 Maven 依赖后，直接运行即可

### 前端

安装依赖：

```bash
npm run install
```

运行：

```bash
npm run dev
```

打包：

```bash
npm run build
```