Архитектурный документ проекта AZAZ

├── .idea
├── azaz-common # Общий пакет, включающий константы, общие утилиты, модели исключений и т.д.
├── azaz-feign-api # OpenFeign удаленные вызовы
├── azaz-gateway # SpringCloud Gateway
├── azaz-model # Модели, включающие dto, vo, pojo и т.д.
├── azaz-page # Фронтенд страницы
├── azaz-service # Пакеты реальных бизнес-услуг
│   ├── azaz-interact # Социальные услуги
│   ├── azaz-search # Услуги поиска
│   ├── azaz-user # Услуги пользователя
│   └── azaz-video # Услуги видео
├── pom.xml # Файл pom зависимостей
├── project-log # Логи logback
└── resource # Проектные ресурсы, включая sql для запуска и т.д.

```shell
 ├── pom.xml # файл зависимостей pom
 └── src # исходные файлы проекта
     └── main
         ├── java
         │   └── com
         │       └── azaz
         │           ├── UserApplication.java # класс запуска сервиса пользователей
         │           ├── config # пакет конфигураций
         │           │   ├── MybatisConfig.java # конфигурация MybatisPlus
         │           │   ├── RedissonConfig.java # конфигурация Redisson
         │           │   └── WebMvcConfiguration.java # конфигурация SpringMVC
         │           ├── controller # пакет контроллеров
         │           │   ├── UserInfoController.java # контроллер информации пользователя
         │           │   └── UserLoginController.java # контроллер входа и регистрации пользователя
         │           ├── interceptor # пакет интерцепторов
         │           │   └── TokenInterceptor.java # интерцептор токенов
         │           ├── mapper # пакет мапперов
         │           │   ├── UserLoginMapper.java
         │           │   └── UserMapper.java
         │           └── service # пакет сервисов
         │               ├── UserInfoService.java # интерфейс сервиса информации пользователя
         │               ├── UserLoginService.java # интерфейс сервиса входа и регистрации пользователя
         │               └── impl
         │                   ├── UserInfoServiceImpl.java
```java # реализация интерфейса сервиса информации пользователя
         │                   └── UserLoginServiceImpl. java # реализация интерфейса сервиса входа и регистрации пользователя
         └── resources
             ├── application. yml # конфигурация middleware и логов
             ├── bootstrap. yaml # конфигурация nacos
             ├── logback. xml # конфигурация логов
             └── mapper # xml файлы Mybatis

```#### 2. Сущностное проектирование```Проектирование сущности пользователя представлено ниже:

```java
@TableName("tb_user")
public class User {
    /**
     * Идентификатор пользователя, использует автоматическое увеличение базы данных
     */
    @TableId(type = IdType.AUTO)
    private Long id;
    /**
     * Номер телефона, уникальный
     */
    @TableField("phone")
    private String phone;
    /**
     * Имя пользователя
     */
    @TableField("username")
    private String username;

    /**
     * Пароль
     */
    @TableField("password")
    private String password;
    /**
     * Соль
     */
    @TableField("salt")
    private String salt;

    /**
     * URL аватара пользователя
     */
    @TableField("image")
    private String image;

    /**
     * Персональная подпись пользователя
     */
    @TableField("signature")
    private String signature;

    /**
     * Статус пользователя, 0 - нормальный, 1 - заблокированный
     */
    @TableField("status")
    private Integer status;

    /**
     * Количество подписок пользователя
     */
    @TableField("attention")
    private Integer attention;

    /**
     * Количество подписчиков пользователя
     */
    @TableField("followers")
    private Integer followers;

    /**
     * Количество работ пользователя
     */
    @TableField("works")
    private Integer works;

    /**
     * Количество лайков пользователя
     */
    @TableField("likes")
    private Integer likes;

    /**
     * Время создания
     */
    @TableField("create_time")
    private LocalDateTime createTime;

    /**
     * Время обновления
     */
    @TableField("update_time")
    private LocalDateTime updateTime;
}

├── pom.xml # файл зависимостей pom
└── src # исходные файлы проекта
    └── main
        ├── java
        │   └── com
        │       └── azaz
        │           ├── VideoApplication.java # класс запуска видео-сервиса
        │           ├── config # пакет конфигураций
        │           │   ├── MybatisConfig.java # конфигурация Mybatis
        │           │   ├── RedissonConfig.java # конфигурация Redisson
        │           │   └── WebMvcConfiguration.java # конфигурация Web MVC
        │           ├── controller # пакет контроллеров
        │           │   └── VideoController.java # контроллер видео
        │           ├── interceptor # пакет интерцепторов
        │           │   └── TokenInterceptor.java # интерцептор токена
        │           ├── mapper # пакет мапперов
        │           │   ├── CommentMapper.java # маппер комментариев
        │           │   └── VideoMapper.java # маппер видео
        │           └── service # пакет сервисов
        │               ├── DbOpsService.java # сервис операций с MongoDB
        │               ├── VideoDoLikeService.java # сервис лайков и закреплений
        │               ├── VideoUploadService.java # сервис загрузки видео
        │               └── impl
        │                   ├── DbOpsServiceImpl.java # реализация сервиса операций с MongoDB
        │                   ├── VideoDoLikeServiceImpl.java # реализация сервиса лайков и закреплений
        │                   └── VideoUploadServiceImpl.java # реализация сервиса загрузки видео
        └── resources
            ├── application.yml # конфигурации middleware и логов
            ├── bootstrap.yaml # конфигурации Nacos
            ├── logback.xml # конфигурация логов
            └── mapper # xml-файлы Mybatis

public class Video {
    /**
     * Идентификатор видео
     */
    @TableId(type = IdType.AUTO)
    private Long id;

    /**
     * Идентификатор автора видео
     */
    @TableField("author_id")
    private Long authorId;

    /**
     * Название видео
     */
    @TableField("title")
    private String title;

    /**
     * Раздел, 0 - популярное, остальное - неопределено
     */
    @TableField("section")
    private Integer section;

    /**
     * URL обложки видео
     */
    @TableField("cover_url")
    private String coverUrl;

    /**
     * URL видео
     */
    @TableField("video_url")
    private String videoUrl;

    /**
     * Статус видео. 0 - нормальный, 1 - удалено
     */
    @TableField("status")
    private Integer status;

    /**
     * Время создания
     */
    @TableField("create_time")
    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime createTime;

    /**
     * Время обновления
     */
    @TableField("update_time")
    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime updateTime;

    /**
     * Количество лайков
     */
    @TableField("likes")
    private Long likes;

    /**
     * Количество добавлений в избранное
     */
    @TableField("collects")
    private Long collects;

    /**
     * Количество комментариев
     */
    @TableField("comments")
    private Long comments;
}

public class Comment {
    /**
     * Идентификатор комментария
     */
    @TableId(type = IdType.AUTO)
    private Long id;

    /**
     * Идентификатор видео
     */
    @TableField("video_id")
    private Long videoId;

    /**
     * Идентификатор пользователя
     */
    @TableField("user_id")
    private Long userId;

    /**
     * Имя пользователя
     */
    @TableField("user_name")
    private String userName;
}
``````java
    /**
     * URL аватара пользователя
     */
    @TableField("image")
    private String image;

    /**
     * Идентификатор родительского комментария
     */
    @TableField("parent_id")
    private Long parentId;

    /**
     * Содержимое комментария
     */
    @TableField("content")
    private String content;

    /**
     * Статус комментария
     */
    @TableField("status")
    private Integer status;

    /**
     * Время создания
     */
    @TableField("create_time")
    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime createTime;
}
``````markdown
#### 3. Основные функции дизайна

Видео-модуль отвечает за функциональные части, связанные с видео, включая загрузку, публикацию видео, лайки, комментарии, добавление в избранное и отображение видео, добавленных в избранное пользователем.

**Дизайн функции лайков**

Эта функция учитывает требования к высокой конкуренции и высокой нагрузке на хранение данных при одновременных лайках и множественных лайках.

Учитывая потребности данного проекта:

1. Получение общей суммы лайков текущего видео для отображения на странице.
2. Получение списка лайков пользователя для определения, поставлен ли лайк.

Для реализации этих функций используется следующий дизайн:

+ Хранение данных о лайках в базе данных для быстрого доступа и обработки запросов.
+ Использование кэширования для ускорения отклика на запросы о лайках.
+ Реализация механизма обработки множественных лайков для предотвращения конкуренции и обеспечения стабильной работы системы.
```> 1. При получении запроса на лайк, фронтенд передает videoId, а userId текущего пользователя получается с помощью threadlocal.
> 2. Сет лайков видео сохраняется в Redis, где ключ имеет префикс + videoId, а значение представляет собой сет userId (уникальность элементов сета предотвращает повторные лайки).
> 3. Данные сета передаются асинхронно в MongoDB для долгосрочного хранения.
> 4. Общее количество лайков видео сохраняется в Redis в виде ключ-значение, где ключ имеет префикс + videoId, а значение представляет собой общее количество лайков + 1 (для этой операции используется Redisson для добавления распределенного блокировочного механизма).
> 5. Данные о количестве лайков передаются асинхронно через RocketMQ в MySQL для долгосрочного хранения.
> 6. Сохранение связи между пользователем и лайкнутым видео в таблице MySQL для удобства поиска списка лайков пользователя.+ Запросы

      1. Получение общей суммы лайков видео, извлечение данных из Redis (если ключ истек, данные извлекаются из MySQL).
    
      2. Получение списка лайков пользователя, извлечение данных из таблицы MySQL.
    
      3. Проверка, поставлен ли лайк текущим пользователем (проверка наличия userId в Redis), сначала извлечение сета лайкнутых пользователей из Redis, затем проверка наличия текущего userId в этом сете. Если Redis не работает, данные извлекаются из MongoDB и обновляются в Redis.

> 1. Получение общей суммы лайков видео, извлечение данных из Redis (если ключ истек, данные извлекаются из MySQL).
> 2. Получение списка лайков пользователя, извлечение данных из таблицы MySQL.
> 3. Проверка, поставлен ли лайк текущим пользователем (проверка наличия userId в Redis), сначала извлечение сета лайкнутых пользователей из Redis, затем проверка наличия текущего userId в этом сете. Если Redis не работает, данные извлекаются из MongoDB и обновляются в Redis.
```![](../resource/imgs/video1.png)

+ **Почему выбран MongoDB**

В ходе хранения ID пользователей, которые поставили лайк каждому видео, было выбрано использование MongoDB вместо традиционного MySQL по следующим причинам:> 1. Хранение данных в формате, удобном для хранения объектных типов данных. При хранении коллекции ID лайков пользователей, традиционный MySQL имеет ограниченную структуру данных, что затрудняет выполнение задачи, в то время как MongoDB с его свободной формой хранения предоставляет идеальное решение.
>
> 2. Врожденная высокая доступность и способность к горизонтальному масштабированию делают его идеальным для работы с большими объемами данных и высокой пропускной способностью. Для популярных видео количество лайков может достигать сотен тысяч или даже миллионов, что идеально соответствует высокой производительности MongoDB.
>
> 3. Структура JSON и объектные модели близки, что позволяет сократить объем кода. Динамическая модель JSON означает, что она легче адаптируется к новым бизнес-требованиям.
>
> 4. Данные лайков не требуют строгой согласованности и безопасности, поэтому допускается некоторая степень несогласованности.+ **Дизайн комментариев к видео**

Функция комментариев к видео должна учитывать возможность наличия вложенных комментариев.

1. Основные поля в таблице хранения

    > ID родительского комментария: отслеживает, к какому комментарию относится этот комментарий; если это прямой комментарий к видео, то значение этого поля равно 0.
    >
    > ID видео: отслеживает, к какому видео относится этот комментарий.
    >
    > Объединенный индекс ID родительского комментария и ID видео для удобства поиска.

2. Операции поиска

    При поиске комментариев можно быстро найти комментарии к данному комментарию, используя ID этого комментария и ID соответствующего видео.

**Дизайн получения потока видео**

При получении видео используется самый простой модель: видео отправляются в хронологическом порядке.> 1. Если значение lastId, переданное фронтендом в первый раз, равно 0, то начинается поиск с самого нового видео. В противном случае используется переданный фронтендом идентификатор.
>
> 2. При публикации видео оно сериализуется в JSON-строку и сохраняется в Redis.
>
> 3. По ID последнего видео, переданного фронтендом, из Redis извлекаются 10 видео, которые затем десериализуются в объекты видео и проходят фильтрацию по разделам.
>
> 4. По ID видео и ID пользователя в Redis проверяется наличие лайков или добавлений в избранное.
>
> 5. Используя Feign, осуществляется удаленный вызов метода модуля пользователей для получения информации о пользователе и видео, которая затем упаковывается вместе.### Социальный модуль#### 1. Структура проекта по уровням```shell
 ├── pom.xml # файл зависимостей pom
 └── src # исходные файлы проекта
     └── main
         ├── java
         │   └── com
         │       └── azaz
         │           ├── InteractApplication.java # класс запуска социальной службы
         │           ├── config # пакет конфигураций
         │           │   ├── MybatisConfig.java # конфигурация MybatisPlus
         │           │   ├── RedissonConfig.java # конфигурация Redisson
         │           │   └── WebMvcConfiguration.java # конфигурация SpringMVC
         │           ├── controller # пакет контроллеров
         │           │   ├── PrivateMessageController.java # контроллер для личных сообщений
         │           │   └── UserFollowController.java # контроллер для подписок
         │           ├── interceptor # пакет интерцепторов
         │           │   └── TokenInterceptor.java # интерцептор для токенов
         │           ├── mapper # пакет мапперов
         │           │   ├── FollowMapper.java
         │           │   └── PrivateMessageMapper.java
         │           ├── mq # пакет для очередей сообщений RocketMQ
         │           │   └── PrivateMessageListener.java # слушатель для отправки личных сообщений
         │           └── service # пакет сервисов
         │               ├── PrivateMessageService.java # сервис для личных сообщений
         │               ├── UserFollowService.java # сервис для подписок
         │               └── impl 
         │                   ├── PrivateMessageServiceImpl.java # реализация сервиса для личных сообщений
         │                   └── UserFollowServiceImpl.java # реализация сервиса для подписок
         └── resources
             ├── application.yml # конфигурации middleware и логов
             ├── bootstrap.yml # конфигурации Nacos
             ├── logback.xml # конфигурация логов
             └── mapper # xml файлы для Mybatis

@TableName("tb_private_message")
public class PrivateMessage {
    /**
     * Идентификатор приватного сообщения
     */
    @TableId(type = IdType.AUTO)
    private Long id;

    /**
     * Идентификатор отправителя
     */
    @TableField("sender_id")
    private Long senderId;

    /**
     * Идентификатор получателя
     */
    @TableField("receiver_id")
    private Long receiverId;

    /**
     * Тип сообщения, 0 - по умолчанию, 1 - видео от друга, 2 - системное сообщение
     */
    @TableField("message_type")
    private Integer messageType;

    /**
     * Содержимое сообщения
     */
    @TableField("message_content")
    private String messageContent;

    /**
     * Статус сообщения, 0 - активно, 1 - удалено
     */
    @TableField("status")
    private Integer status;

    /**
     * Время создания
     */
    @TableField("create_time")
    private LocalDateTime createTime;
}

├── pom.xml # файл зависимостей pom
└── src # исходные файлы проекта
    └── main
        ├── java
        │   └── com
        │       └── azaz
        │           ├── SearchApplication.java # класс запуска сервиса поиска
        │           ├── config # пакет конфигураций
        │           │   ├── ElasticSearchConfig.java # конфигурация ElasticSearch
        │           │   ├── MybatisConfig.java # конфигурация MybatisPlus
        │           │   └── WebMvcConfiguration.java # конфигурация SpringMVC
        │           ├── controller # пакет контроллеров
        │           │   └── SearchController.java # контроллер поиска
        │           ├── interceptor # пакет фильтров
        │           │   └── TokenInterceptor.java # фильтр токенов
        │           ├── mq # пакет потребителей RocketMQ
        │           │   ├── UserInfoListener.java # слушатель изменений пользовательской информации
        │           │   └── VideoPublishListener.java # слушатель изменений информации о видео
        │           └── service # пакет сервисов
        │               ├── SearchService.java # интерфейс сервиса поиска
        │               └── impl
        │                   └── SearchServiceImpl.java # реализация интерфейса сервиса поиска
        └── resources
            ├── application.yml # конфигурации middleware и логов
            ├── bootstrap.yaml # конфигурации nacos
            ├── logback.xml # конфигурация логов
            └── mapper # xml файлы Mybatis