diff --git a/GenerationService/Models/Course.cs b/GenerationService/Models/Course.cs new file mode 100644 index 0000000..9d9e780 --- /dev/null +++ b/GenerationService/Models/Course.cs @@ -0,0 +1,57 @@ +namespace GenerationService.Models; + +/// +/// Модель, описывающая учебный курс и его основные метаданные +/// +public class Course +{ + /// + /// Уникальный идентификатор курса + /// + public int Id { get; init; } + + /// + /// Название курса + /// + public string Name { get; init; } = string.Empty; + + /// + /// Полное имя преподавателя курса + /// + public string TeacherFullName { get; init; } = string.Empty; + + /// + /// Дата начала курса + /// + public DateOnly StartDate { get; init; } + + /// + /// Дата окончания курса + /// + public DateOnly EndDate { get; init; } + + /// + /// Максимально допустимое количество студентов, которые могут быть зачислены на курс + /// + public int MaxStudents { get; init; } + + /// + /// Текущее количество записанных студентов + /// + public int CurrentStudents { get; init; } + + /// + /// Выдаётся ли по окончании курса сертификат + /// + public bool HasCertificate { get; init; } + + /// + /// Стоимость курса + /// + public decimal Cost { get; init; } + + /// + /// Рейтинг курса + /// + public int Rating { get; init; } +} diff --git a/GenerationService/Program.cs b/GenerationService/Program.cs new file mode 100644 index 0000000..3fd46b7 --- /dev/null +++ b/GenerationService/Program.cs @@ -0,0 +1,58 @@ +using GenerationService.Models; +using GenerationService.Services; +using Microsoft.Extensions.Caching.Distributed; +using System.Text.Json; +using ServiceDefaults; + +var builder = WebApplication.CreateBuilder(args); + +builder.AddServiceDefaults(); + +builder.AddRedisDistributedCache("cache"); + +builder.Services.AddCors(options => + options.AddDefaultPolicy(policy => + policy.AllowAnyOrigin().AllowAnyHeader().AllowAnyMethod())); + +var app = builder.Build(); + +app.UseCors(); +app.MapDefaultEndpoints(); + +app.MapGet("/course", async (int id, IDistributedCache cache, ILogger logger) => +{ + if (id <= 0) + return Results.BadRequest("Received invalid ID. ID must be a positive number"); + + var cacheKey = $"course:{id}"; + + var cached = await cache.GetStringAsync(cacheKey); + if (cached is not null) + { + var cachedCourse = JsonSerializer.Deserialize(cached); + if (cachedCourse is not null) + { + logger.LogInformation("Cache hit for course with id {CourseId}", id); + return Results.Ok(cachedCourse); + } + } + + logger.LogInformation("Cache miss for course with id {CourseId}, generating new data", id); + var course = CourseGenerator.Generate(id); + + await cache.SetStringAsync( + cacheKey, + JsonSerializer.Serialize(course), + new DistributedCacheEntryOptions + { + AbsoluteExpirationRelativeToNow = TimeSpan.FromMinutes(10) + }); + + logger.LogInformation( + "Generated and cached course {CourseName} with id {CourseId}", + course.Name, id); + + return Results.Ok(course); +}); + +app.Run(); diff --git a/README.md b/README.md index dcaa5eb..0807a53 100644 --- a/README.md +++ b/README.md @@ -1,128 +1,28 @@ -# Современные технологии разработки программного обеспечения -[Таблица с успеваемостью](https://docs.google.com/spreadsheets/d/1an43o-iqlq4V_kDtkr_y7DC221hY9qdhGPrpII27sH8/edit?usp=sharing) +## Цель лабораторной работы +Реализация минимального микросервисного бэкенда с кэшированием -## Задание -### Цель -Реализация проекта микросервисного бекенда. +## Технологии и требования -### Задачи -* Реализация межсервисной коммуникации, -* Изучение работы с брокерами сообщений, -* Изучение архитектурных паттернов, -* Изучение работы со средствами оркестрации на примере .NET Aspire, -* Повторение основ работы с системами контроля версий, -* Интеграционное тестирование. +- .NET 8 +- Redis +- Bogus -### Лабораторные работы -
-1. «Кэширование» - Реализация сервиса генерации контрактов, кэширование его ответов -
- -В рамках первой лабораторной работы необходимо: -* Реализовать сервис генерации контрактов на основе Bogus, -* Реализовать кеширование при помощи IDistributedCache и Redis, -* Реализовать структурное логирование сервиса генерации, -* Настроить оркестрацию Aspire. - -
-
-2. «Балансировка нагрузки» - Реализация апи гейтвея, настройка его работы -
- -В рамках второй лабораторной работы необходимо: -* Настроить оркестрацию на запуск нескольких реплик сервиса генерации, -* Реализовать апи гейтвей на основе Ocelot, -* Имплементировать алгоритм балансировки нагрузки согласно варианту. +## Что я сделал в проекте -
-
-
-3. «Интеграционное тестирование» - Реализация файлового сервиса и объектного хранилища, интеграционное тестирование бекенда -
+В рамках этой лабораторной работы реализовано и настроено следующее: -В рамках третьей лабораторной работы необходимо: -* Добавить в оркестрацию объектное хранилище, -* Реализовать файловый сервис, сериализующий сгенерированные данные в файлы и сохраняющий их в объектном хранилище, -* Реализовать отправку генерируемых данных в файловый сервис посредством брокера, -* Реализовать интеграционные тесты, проверяющие корректность работы всех сервисов бекенда вместе. +- HTTP-эндпоинт `GET /course?id={id}` в сервисе `GenerationService`, возвращающий DTO `Course`. +- Механизм генерации данных курсов (используется Bogus)., +- Кэширование ответов через `IDistributedCache` с провайдером Redis: ключи `course:{id}`, TTL 10 минут. +- Набор расширений `ServiceDefaults` для единообразной конфигурации сервисов: OpenTelemetry (метрики/трейсы), health checks и настройки `HttpClient`. -
-
-
-4. (Опционально) «Переход на облачную инфраструктуру» - Перенос бекенда в Yandex Cloud -
- -В рамках четвертой лабораторной работы необходимо перенестиервисы на облако все ранее разработанные сервисы: -* Клиент - в хостинг через отдельный бакет Object Storage, -* Сервис генерации - в Cloud Function, -* Апи гейтвей - в Serverless Integration как API Gateway, -* Брокер сообщений - в Message Queue, -* Файловый сервис - в Cloud Function, -* Объектное хранилище - в отдельный бакет Object Storage, +Снимок экрана 2026-02-19 162728 +Снимок экрана 2026-02-19 162815 +Снимок экрана 2026-02-19 162752 +Снимок экрана 2026-02-19 162917 -
-
-## Задание. Общая часть -**Обязательно**: -* Реализация серверной части на [.NET 8](https://learn.microsoft.com/ru-ru/dotnet/core/whats-new/dotnet-8/overview). -* Оркестрация проектов при помощи [.NET Aspire](https://learn.microsoft.com/ru-ru/dotnet/aspire/get-started/aspire-overview). -* Реализация сервиса генерации данных при помощи [Bogus](https://github.com/bchavez/Bogus). -* Реализация тестов с использованием [xUnit](https://xunit.net/?tabs=cs). -* Создание минимальной документации к проекту: страница на GitHub с информацией о задании, скриншоты приложения и прочая информация. -**Факультативно**: -* Перенос бекенда на облачную инфраструктуру Yandex Cloud -Внимательно прочитайте [дискуссии](https://github.com/itsecd/cloud-development/discussions/1) о том, как работает автоматическое распределение на ревью. -Сразу корректно называйте свои pr, чтобы они попали на ревью нужному преподавателю. -По итогу работы в семестре должна получиться следующая информационная система: -
-C4 диаграмма -Современные_технологии_разработки_ПО_drawio -
- -## Варианты заданий -Номер варианта задания присваивается в начале семестра. Изменить его нельзя. Каждый вариант имеет уникальную комбинацию из предметной области, базы данных и технологии для общения сервиса генерации данных и сервера апи. - -[Список вариантов](https://docs.google.com/document/d/1WGmLYwffTTaAj4TgFCk5bUyW3XKbFMiBm-DHZrfFWr4/edit?usp=sharing) -[Список предметных областей и алгоритмов балансировки](https://docs.google.com/document/d/1PLn2lKe4swIdJDZhwBYzxqFSu0AbY2MFY1SUPkIKOM4/edit?usp=sharing) - -## Схема сдачи - -На каждую из лабораторных работ необходимо сделать отдельный [Pull Request (PR)](https://docs.github.com/en/pull-requests). - -Общая схема: -1. Сделать форк данного репозитория -2. Выполнить задание -3. Сделать PR в данный репозиторий -4. Исправить замечания после code review -5. Получить approve - -## Критерии оценивания - -Конкурентный принцип. -Так как задания в первой лабораторной будут повторяться между студентами, то выделяются следующие показатели для оценки: -1. Скорость разработки -2. Качество разработки -3. Полнота выполнения задания - -Быстрее делаете PR - у вас преимущество. -Быстрее получаете Approve - у вас преимущество. -Выполните нечто немного выходящее за рамки проекта - у вас преимущество. -Не укладываетесь в дедлайн - получаете минимально возможный балл. - -### Шкала оценивания - -- **3 балла** за качество кода, из них: - - 2 балла - базовая оценка - - 1 балл (но не более) можно получить за выполнение любого из следующих пунктов: - - Реализация факультативного функционала - - Выполнение работы раньше других: первые 5 человек из каждой группы, которые сделали PR и получили approve, получают дополнительный балл - -## Вопросы и обратная связь по курсу - -Чтобы задать вопрос по лабораторной, воспользуйтесь [соответствующим разделом дискуссий](https://github.com/itsecd/cloud-development/discussions/categories/questions) или заведите [ишью](https://github.com/itsecd/cloud-development/issues/new). -Если у вас появились идеи/пожелания/прочие полезные мысли по преподаваемой дисциплине, их можно оставить [здесь](https://github.com/itsecd/cloud-development/discussions/categories/ideas). diff --git a/ServiceDefaults/Extensions.cs b/ServiceDefaults/Extensions.cs new file mode 100644 index 0000000..4027740 --- /dev/null +++ b/ServiceDefaults/Extensions.cs @@ -0,0 +1,84 @@ +using Microsoft.AspNetCore.Builder; +using Microsoft.AspNetCore.Diagnostics.HealthChecks; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Diagnostics.HealthChecks; +using Microsoft.Extensions.Hosting; +using Microsoft.Extensions.Logging; +using OpenTelemetry; +using OpenTelemetry.Metrics; +using OpenTelemetry.Trace; + +namespace ServiceDefaults; + +public static class ServiceDefaultsExtensions +{ + public static IHostApplicationBuilder AddServiceDefaults(this IHostApplicationBuilder builder) + { + builder.ConfigureOpenTelemetry(); + builder.AddDefaultHealthChecks(); + + builder.Services.AddServiceDiscovery(); + builder.Services.ConfigureHttpClientDefaults(http => + { + http.AddStandardResilienceHandler(); + http.AddServiceDiscovery(); + }); + + return builder; + } + + public static IHostApplicationBuilder ConfigureOpenTelemetry(this IHostApplicationBuilder builder) + { + builder.Logging.AddOpenTelemetry(logging => + { + logging.IncludeFormattedMessage = true; + logging.IncludeScopes = true; + }); + + builder.Services.AddOpenTelemetry() + .WithMetrics(metrics => + { + metrics.AddAspNetCoreInstrumentation() + .AddHttpClientInstrumentation() + .AddRuntimeInstrumentation(); + }) + .WithTracing(tracing => + { + tracing.AddAspNetCoreInstrumentation() + .AddHttpClientInstrumentation(); + }); + + builder.AddOpenTelemetryExporters(); + return builder; + } + + private static IHostApplicationBuilder AddOpenTelemetryExporters(this IHostApplicationBuilder builder) + { + var useOtlpExporter = !string.IsNullOrWhiteSpace(builder.Configuration["OTEL_EXPORTER_OTLP_ENDPOINT"]); + if (useOtlpExporter) + { + builder.Services.AddOpenTelemetry().UseOtlpExporter(); + } + return builder; + } + + public static IHostApplicationBuilder AddDefaultHealthChecks(this IHostApplicationBuilder builder) + { + builder.Services.AddHealthChecks() + .AddCheck("self", () => HealthCheckResult.Healthy(), ["live"]); + return builder; + } + + public static WebApplication MapDefaultEndpoints(this WebApplication app) + { + if (app.Environment.IsDevelopment()) + { + app.MapHealthChecks("/health"); + app.MapHealthChecks("/alive", new HealthCheckOptions + { + Predicate = r => r.Tags.Contains("live") + }); + } + return app; + } +}