Calabonga.Catalog icon indicating copy to clipboard operation
Calabonga.Catalog copied to clipboard

Published 20 hours ago • verified publisher icon Calabonga
→

Metadata

Каталог товаров и услуг на платформе ASP.NET Core

Каталог товаров 2023

  • Платформа: ASP.NET Core NET 7.0
  • Реализация: Апрель-Май 2023 год
  • Ссылки на видео материалы смотрите в самом низу данного документа

Краткое описание

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

Из чего состоит проект

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

  • База данных PostgreSQL
  • EntityFrameworkCore
  • Unit of Work
  • Mediatr
  • FluentValidation
  • PredicatesBuilder
  • OperationResult (as RFC7807)
  • Microsoft Identity
  • Vertical Slice Architecture
  • Minimal API
  • OpenIddict Auth2.0
  • Nimble Framework (Microservice Template)
  • Swagger
  • AppDefinitions
  • Domain Events
  • DDD

Требования, правила, бизнес-логика

Роли в системе

В проекте используется две роли, которые регламентируют доступ к функционалу. Administrator - (главная роль) пользователь, у которого есть эта роль, может выполнять все операции с любыми сущностями). User - пользоватеть, у которого есть эта роль может добавлять обзоры к товарам.

Незарегистрированные пользователи работают с системой в режиме "readonly".

Сущность "Category"

  • [x] Name должно быть не менее 5 и не более 50 символов.
  • [x] Description должно быть не более 1024 символов, но может быть пустым.
  • [x] Category можно создать без товаров.
  • [x] Category можно включить/выключить (скрыть/показать для всеобщего просмотра).
  • [x] При выключении каталога все товары в каталоге тоже должны выключиться. (Transaction)
  • [x] При включении каталога необходимо явно указать, включать или не включать товары.
  • [x] При получение всех товаров GetAll() администратор должен получать и скрытые категории тоже.
  • [x] Просмотр всех каталогов должно использоваться разбиение на страницы (paging)
  • [x] При создании нового каталога, он должен быть невидимый по умолчанию.
  • [x] API должна содержать методы CRUD для управления сущностью Category:
    • [x] GetPaged(int pageIndex, int pageSize)
    • [x] GetAll()
    • [x] Create(CategoryViewModel model)
    • [x] GetById(Guid id)
    • [x] Update(CategoryUpdateViewModel)
    • [x] Delete(Guid id)

Сущность "Product"

  • [x] Name должно быть не менее 5 и не более 128 символов.
  • [x] Description должно быть не более 2048 символов, но может быть пустым.
  • [x] Price может быть не задана (null).
  • [x] CategoryId обязательно при создании нового товара.
  • [x] Product можно выключить/выключить (скрыть/показать для всеобщего просмотра).
  • [x] Товар нельзя включить, если каталог товара выключен
  • [x] Просмотр всех товаров должно использоваться разбиение на страницы (paging)
  • [x] При создании товар он должен быть невидимый.
  • [x] API должна содержать методы CRUD для управления сущностью Product:
    • [x] GetPaged(int pageIndex, int pageSize)
    • [x] GetAll() (глупый метод)
    • [x] Create(ProductCreateViewModel model) Get
    • [x] Create(ProductCreateViewModel model) Post
    • [x] GetById(Guid id)
    • [x] Update(ProductUpdateViewModel)Get
    • [x] Update(ProductUpdateViewModel)Put
    • [x] Delete(Guid id)
    • [x] GetMostReviewed(int count = 10)
    • [x] GetMostRated(int count = 10)

Сущность "Review"

  • [x] UserName должно быть не менее 5 и не более 128 символов
  • [x] Content должно быть не более 2048 символов, но может быть пустым
  • [x] Rating должно быть от 1 до 5 единиц (очков, баллов, и т.д.)
  • [x] ProductId обязательно при создании нового обзора (комментария)
  • [x] Посмотреть все обзоры для товаров можно лишь только администратору.
  • [x] Просмотр всех обзоров должны использоваться разбиение на страницы (paging)
  • [ ] Review можно тоже выключить и включить в соответствии со статусом товара, для которого это review написано.
  • [x] API должна содержать методы CRUD для управления сущностью Review:
    • [x] Create(ReviewCreateViewModel model) Get
    • [x] Create(ReviewCreateViewModel model) Post
    • [x] GetById(Guid id)
    • [x] Delete(Guid id)
    • [x] Update(Guid id) Get
    • [x] Update(ReviewUpdateViewModel model) Post
    • [x] GetLastReviews(int count)
    • [x] GetPaged(int pageIndex, int pageSize)
    • [x] GetAll(Guid productId)

Сущность "Tag" ("Метка")

  • [x] Один продукт должен иметь одну и более меток (до 8 шт).
  • [x] При создании и при редактировании товара к нему можно добавить несколько меток. Если метка не существует в системе, то она создается. Если метка уже существует, то к товару привязывается ссылка нее.
  • [x] Если из описания товара удаляется метка, то надо проверить что эта метка не используется других товарах. Если метка больше нигде не используется, ее требуется удалить.
  • [x] Данные о продукте должны включать в себя метки товара (GetAll(), GetById и GetPaged)
  • [x] Просмотр всех меток, которые используются в каталоге можно осуществить на странице "Облако меток" (см. GetCloud()).
    • [x] GetCloud()

Общие требования для сущности Review

  • [x] Товар может иметь несколько отзывов или не иметь вообще.
  • [x] Отзыв может оставить только зарегистрированный пользователь ролью User
  • [x] Отзыв должен содержать следующие обязательные свойства: Id, Content, Rating, UserName
  • [x] Список последних 10 отзывов может быть также запрошен на UI (см. GetLastReview(int count)).
  • [ ] При сокрытии товара от всеобщего просмотра, отзывы о товаре тоже не должны нигде отображаться.

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

  • [x] Администратор должен иметь возможность удалить любой отзыв
  • [x] Администратор должен иметь возможность удалять товары
  • [x] Администратор должен иметь возможность удалять пользователей
  • [x] Администратор должен иметь возможность создавать категории

Требования для роли Пользователь

  • [x] Пользователь может добавить сколько угодно отзывов на любой товар
  • [x] Пользователь может удалить свой и только свой отзыв
  • [x] Пользователь может изменить рейтинг своего отзыва и текст содержания

Диаграмма классов

classDiagram
	direction RL
	Product "*" <-- "1" Category
	Tag "1..8" <-- "*" Product
	Review "*" <-- "1" Product
	Auditable <|-- Identity
	Category <|-- Identity
	EventItem <|-- Identity
	Tag <|-- Identity
	Product <|-- Auditable
	Review <|-- Auditable


---
title: Сущность Category
---
classDiagram
class Category {
	+string Name
	+string Description
	+List~Product~
	bool Visible
}

---
title: Сущность Product
---
classDiagram
class Product {
	+string Name
	+string Description
	Guid CategoryId
	+int Price
	+List~Review~
	+List~Tag~
	bool Visible
}

---
title: Сущность EventItem
---
classDiagram
class EventItem {
	DateTime CreatedAt
	string Logger
	string Level
	string Message
	string? ThreadId
	string? ExceptionMessage
}

---
title: Сущность Tag
---
classDiagram
class Tag {
	string Name
	List<Product>? Products
}

---
title: Сущность Review
---
classDiagram
class Review {
	string Content
	string User
	int Rating
	Guid Product
	virtual Product
	bool Visible
}

---
title: Сущность Identity
---
classDiagram
class Identity{
	<<Abstract>>
	+Guid Id
}

---
title: Сущность Auditable
---
classDiagram
class Auditable{
	<<Abstract>>
	DateTime CreatedAt
	string CreatedBy
	DateTime? UpdatedAt
	string? UpdatedBy
}

Видео материалы

Есть две версии реализации каталога товаров: 2019 года и 2023 года.

Видео 2023

Платформа: ASP.NET Core 7.0.

Исходные файлы версии 2023

Создание новой версии можно посмотреть на видео. Все ссылки на видео есть в моем блоге - Каталог товаров 2023. Все этапы от "создания проекта" до "решения всех требований".

Видео 2019

Платформа: ASP.NET Core 2.2.

Исходные файлы версии 2019

Создание приложение подробно запечатлено на видео. Проект создается самого начала. Используется шаблон, который описан в видео. В процессе разработки показывается как программировать, как создавать правильный функциональный код. Как использовать паттерны. Описываются принципы и правила.

Каталог товаров 2019

Статья в блоге 2019

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

Дополнительные материалы по теме

← Metadata

20
Stars
7
Forks
Watchers

Owner

verified publisher icon Calabonga

Metadata

Каталог товаров и услуг на платформе ASP.NET Core

Back