Backend

XYBLOG

Модуль пользователя

xy-blog-user

Справочник свойств

По умолчанию
- Электронная почта
- Имя
- Подпись
- Номер телефона
- Кличка
- Личный логотип
- Число посещений
- Число лайков
- Общее число комментариев

Шаблоны пользователя

Шаблон посетителя
Шаблон блоггера
Шаблон администратора

Управление персональной информацией

Управление категориями статей и обслуживание

Администрирование блоггеров

Регистрация пользователя

Модуль статьи

xy-blog-article-platform

Управление статьями

Поиск
Публикация
- Оригинальная
- Перепост
- Перевод
Изменение
Удаление
Импорт
- Насыщенная текстовая информация
- Markdown
Экспорт
- PDF
- Word
- Markdown
Разрешение комментариев

Атрибуты статьи

Заголовок
Содержание
Тип

Категории статей

Компьютеры
...

Корзина

Ручное постоянное удаление
Восстановление
Расписание удаления через 30 дней

Подписка RSS

Пользователи могут подписываться на последние обновления этого блога через функцию подписки RSS браузера.

Модуль журналов

xy-blog-log

Журналы пользователей

Журнал системы

Модуль комментариев

Посты комментариев

Комментарии инструментов разработчика

Возможность голосования за и против

Модуль управления блогом (администратор)

TODO xy-blog-management

Управление конфигурацией

Конфигурация адреса OSS
Конфигурация RDS

Статистика онлайн-посетителей сайта

Модуль безопасности

xy-blog-security

Валидация входа пользователей

Управление правами доступа к интерфейсу

Модуль инструментов разработчика

xy-blog-developer-tools

Загрузка и скачивание ежедневных инструментов разработки

Поиск

=======================================

Спецификация RESTful API

GET: Операция запроса:

Пагинация: HTTP GET /devices?startIndex=0&size=20
HTTP GET /devices/{id}/configurations
HTTP GET /devices/{id}
GET /post/${post_id}/comment/${comment_index} Получение конкретного комментария из поста

POST: Новая операция: HTTP POST /device
PUT: Полное обновление (представляет собой обновление всех атрибутов сущности): HTTP PUT /devices/application/json
PATCH: Частичное обновление (представляет собой обновление некоторых атрибутов сущности): Из-за совместимости с некоторыми браузерами рекомендуется использовать put. HTTP PATCH /device/application/json
DELETE: Операция удаления: HTTP DELETE /devices/{id}- Используйте дефисы (-) вместо нижних подчеркиваний (_), чтобы улучшить читабельность URI
Используйте строчные буквы в URI
Не используйте расширения файлов# Статус-коды 200 - запрос выполнен успешно
301 - ресурс (страница и т.д.) был перемещён на постоянной основе на другой URL
404 - запрошенный ресурс (страница и т.д.) отсутствует
500 - внутренняя ошибка сервера
600 - 999 системные ошибочные коды
1000общие бизнес-ошибочные коды
2000статусы связанные с статьями
...

Возвращаемые параметры

Валидация

Используйте @Valid + BindingResult для валидации параметров контроллера

Как использовать @NotNull, @NotBlank, @NotEmpty

@NotBlank обычно используется для параметров типа String. Это означает, что пустая строка недопустима, значение должно присутствовать.
@NotNull обычно применяется к базовым типам данных (кроме String)
@NotEmpty обычно используется для проверки Collection, Map, Array

success boolean указывает, был ли запрос успешным  
msg string выводится как сообщение результата запроса, часто используется для передачи сообщений об ошибках  
code number указывает статус-код запроса, часто используется для передачи кодов ошибок  
data any используется для хранения основных данных запроса

Почему VO, BO, DO должны иметь чёткое разделение?

Если этого не сделать:

Ненужные поля будут передаваться на фронтенд
Некоторые поля требуют преобразования, но это невозможно
Некоторые поля должны отображаться, но не должны храниться в базе данных# Названия методов слоя Service/DAO (См. руководство разработки от Али巴巴)1. Методы получения одного объекта должны начинаться с префикса get.

Методы получения нескольких объектов должны иметь префикс list и окончание в форме множественного числа, например: listObjects.
Методы получения статистических значений должны иметь префикс count.
Методы вставки данных должны иметь префикс save или insert.
Методы удаления данных должны иметь префикс remove или delete.
Методы изменения данных должны иметь префикс update.

Нормы названий предметной области

Данные объекты: xxxDO, где xxx — это имя таблицы данных.
Объекты передачи данных: xxxDTO, где xxx — это название бизнес-области.
Объекты представления: xxxVO, где xxx обычно является названием веб-страницы.
POJO — это общее название для DO/DTO/BO/VO, запрещено использовать названия типа xxxPOJO.

Нормы логирования

Прямое использование API систем логирования (например Log4j, Logback) недопустимо. Вместо этого следует использовать API фреймворка SLF4J, который использует паттерн порта. Это способствует унификации подходов к работе с логами во всех классах и обеспечивает удобство обслуживания.

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

private static final Logger logger = LoggerFactory.getLogger(Test.class);
```# xy-blog-service
### Описание
{**Далее следует описание платформы Gitee. Вы можете заменить этот текст на свой.**
Gitee — это платформа управления версиями на основе Git, созданная компанией OSChina. Она предоставляет стабильную, эффективную и безопасную облачную среду для совместной работы над проектами программного обеспечения как для индивидуальных разработчиков, так и для команд и компаний. Для корпоративных проектов см. [https://gitee.com/enterprises](https://gitee.com/enterprises)}### Архитектура программы
Описание архитектуры программы

### Инструкция по установке
1. xxxx
2. xxxx
3. xxxx

### Инструкция по использованию
1. xxxx
2. xxxx
3. xxxx

### Участие в проекте
1. Создайте форк данного репозитория
2. Создайте новую ветку `Feat_xxx`
3. Подтвердите свои изменения
4. Отправьте новый pull request

# Frontend

https://gitee.com/firelife_it/xy-blog-web