diff --git a/Client.Wasm/Components/StudentCard.razor b/Client.Wasm/Components/StudentCard.razor index 661f118..a493183 100644 --- a/Client.Wasm/Components/StudentCard.razor +++ b/Client.Wasm/Components/StudentCard.razor @@ -4,10 +4,10 @@ - Номер №X "Название лабораторной" - Вариант №Х "Название варианта" - Выполнена Фамилией Именем 65ХХ - Ссылка на форк + Номер №1 "Кэширование" + Вариант №2 "Кредитная заявка" + Выполнил Сукач Данил 6511 + Ссылка на форк diff --git a/Client.Wasm/wwwroot/appsettings.json b/Client.Wasm/wwwroot/appsettings.json index 4dda7c0..55c76b5 100644 --- a/Client.Wasm/wwwroot/appsettings.json +++ b/Client.Wasm/wwwroot/appsettings.json @@ -6,5 +6,5 @@ } }, "AllowedHosts": "*", - "BaseAddress": "https://localhost:7170/land-plot" + "BaseAddress": "https://localhost:7084/api/Credit" } \ No newline at end of file diff --git a/CloudDevelopment.sln b/CloudDevelopment.sln index cb48241..c35b184 100644 --- a/CloudDevelopment.sln +++ b/CloudDevelopment.sln @@ -1,10 +1,22 @@  Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio Version 17 -VisualStudioVersion = 17.14.36811.4 +# Visual Studio Version 18 +VisualStudioVersion = 18.3.11505.172 d18.3 MinimumVisualStudioVersion = 10.0.40219.1 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Client.Wasm", "Client.Wasm\Client.Wasm.csproj", "{AE7EEA74-2FE0-136F-D797-854FD87E022A}" EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CreditApp.AppHost", "CreditApp\CreditApp.AppHost\CreditApp.AppHost.csproj", "{595C6305-ACA3-4E87-8CBF-27A4C92BAE97}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CreditApp.ServiceDefaults", "CreditApp\CreditApp.ServiceDefaults\CreditApp.ServiceDefaults.csproj", "{A7B14B5D-B738-B77E-404F-CF5182E30A41}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CreditApp.Api", "CreditApp.Api\CreditApp.Api.csproj", "{E7D4CA8B-53EA-9676-D96D-BE2F0CB11054}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CreditApp.Domain", "CreditApp.Domain\CreditApp.Domain.csproj", "{2B736CD0-1260-4F6F-854F-5F35E0CBC260}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CreditApp.Application", "CreditApp.Application\CreditApp.Application.csproj", "{69FCFAEE-907C-4365-897A-EF120A644131}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CreditApp.Infrastructure", "CreditApp.Infrastructure\CreditApp.Infrastructure.csproj", "{C5A26B57-58ED-45E9-9371-AAF64F30C3A8}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -15,6 +27,30 @@ Global {AE7EEA74-2FE0-136F-D797-854FD87E022A}.Debug|Any CPU.Build.0 = Debug|Any CPU {AE7EEA74-2FE0-136F-D797-854FD87E022A}.Release|Any CPU.ActiveCfg = Release|Any CPU {AE7EEA74-2FE0-136F-D797-854FD87E022A}.Release|Any CPU.Build.0 = Release|Any CPU + {595C6305-ACA3-4E87-8CBF-27A4C92BAE97}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {595C6305-ACA3-4E87-8CBF-27A4C92BAE97}.Debug|Any CPU.Build.0 = Debug|Any CPU + {595C6305-ACA3-4E87-8CBF-27A4C92BAE97}.Release|Any CPU.ActiveCfg = Release|Any CPU + {595C6305-ACA3-4E87-8CBF-27A4C92BAE97}.Release|Any CPU.Build.0 = Release|Any CPU + {A7B14B5D-B738-B77E-404F-CF5182E30A41}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {A7B14B5D-B738-B77E-404F-CF5182E30A41}.Debug|Any CPU.Build.0 = Debug|Any CPU + {A7B14B5D-B738-B77E-404F-CF5182E30A41}.Release|Any CPU.ActiveCfg = Release|Any CPU + {A7B14B5D-B738-B77E-404F-CF5182E30A41}.Release|Any CPU.Build.0 = Release|Any CPU + {E7D4CA8B-53EA-9676-D96D-BE2F0CB11054}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {E7D4CA8B-53EA-9676-D96D-BE2F0CB11054}.Debug|Any CPU.Build.0 = Debug|Any CPU + {E7D4CA8B-53EA-9676-D96D-BE2F0CB11054}.Release|Any CPU.ActiveCfg = Release|Any CPU + {E7D4CA8B-53EA-9676-D96D-BE2F0CB11054}.Release|Any CPU.Build.0 = Release|Any CPU + {2B736CD0-1260-4F6F-854F-5F35E0CBC260}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {2B736CD0-1260-4F6F-854F-5F35E0CBC260}.Debug|Any CPU.Build.0 = Debug|Any CPU + {2B736CD0-1260-4F6F-854F-5F35E0CBC260}.Release|Any CPU.ActiveCfg = Release|Any CPU + {2B736CD0-1260-4F6F-854F-5F35E0CBC260}.Release|Any CPU.Build.0 = Release|Any CPU + {69FCFAEE-907C-4365-897A-EF120A644131}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {69FCFAEE-907C-4365-897A-EF120A644131}.Debug|Any CPU.Build.0 = Debug|Any CPU + {69FCFAEE-907C-4365-897A-EF120A644131}.Release|Any CPU.ActiveCfg = Release|Any CPU + {69FCFAEE-907C-4365-897A-EF120A644131}.Release|Any CPU.Build.0 = Release|Any CPU + {C5A26B57-58ED-45E9-9371-AAF64F30C3A8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {C5A26B57-58ED-45E9-9371-AAF64F30C3A8}.Debug|Any CPU.Build.0 = Debug|Any CPU + {C5A26B57-58ED-45E9-9371-AAF64F30C3A8}.Release|Any CPU.ActiveCfg = Release|Any CPU + {C5A26B57-58ED-45E9-9371-AAF64F30C3A8}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE diff --git a/CreditApp.Api/Controllers/CreditController.cs b/CreditApp.Api/Controllers/CreditController.cs new file mode 100644 index 0000000..b53031f --- /dev/null +++ b/CreditApp.Api/Controllers/CreditController.cs @@ -0,0 +1,36 @@ +using CreditApp.Application.Interfaces; +using Microsoft.AspNetCore.Mvc; + +namespace CreditApp.Api.Controllers; + +/// +/// Контроллер для работы с кредитными заявками через HTTP API. +/// Реализует конечную точку получения заявки по идентификатору. +/// Сервис для получения данных кредитных заявок. +/// Логгер для записи событий и ошибок. +/// +[Route("api/[controller]")] +[ApiController] +public class CreditController( + ICreditService creditService, + ILogger logger + ) : ControllerBase +{ + /// + /// Получает кредитную заявку по идентификатору. + /// + /// Идентификатор запрашиваемой заявки (передаётся в строке запроса). + /// Токен отмены для асинхронной операции. + /// HTTP 200 с объектом заявки при успешном получении. + [HttpGet] + public async Task Get([FromQuery] int id, CancellationToken ct) + { + logger.LogInformation("Request for credit {CreditId} started", id); + + var result = await creditService.GetAsync(id, ct); + + logger.LogInformation("Request for credit {CreditId} completed", id); + + return Ok(result); + } +} diff --git a/CreditApp.Api/CreditApp.Api.csproj b/CreditApp.Api/CreditApp.Api.csproj new file mode 100644 index 0000000..a98eea8 --- /dev/null +++ b/CreditApp.Api/CreditApp.Api.csproj @@ -0,0 +1,24 @@ + + + + net8.0 + enable + enable + true + $(NoWarn);1591 + + + + + + + + + + + + + + + + diff --git a/CreditApp.Api/Program.cs b/CreditApp.Api/Program.cs new file mode 100644 index 0000000..caf1309 --- /dev/null +++ b/CreditApp.Api/Program.cs @@ -0,0 +1,51 @@ +using CreditApp.Application.Interfaces; +using CreditApp.Application.Services; +using CreditApp.Infrastructure.Generators; +using Microsoft.OpenApi; +using System.Reflection; + +var builder = WebApplication.CreateBuilder(args); + +builder.AddRedisDistributedCache("credit-cache"); + +var centralBankRate = builder.Configuration.GetValue("CreditGenerator:CentralBankRate", 16.0); + +builder.Services.AddSingleton( + new CreditApplicationGenerator(centralBankRate)); + +builder.Services.AddScoped(); + +builder.Services.AddControllers(); +builder.Services.AddEndpointsApiExplorer(); +builder.Services.AddSwaggerGen(options => +{ + var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml"; + var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile); + options.IncludeXmlComments(xmlPath); +}); + +builder.Services.AddCors(options => +{ + options.AddPolicy("DefaultCors", + policy => policy.AllowAnyOrigin() + .AllowAnyHeader() + .AllowAnyMethod()); +}); + +var app = builder.Build(); + +if (app.Environment.IsDevelopment()) +{ + app.UseSwagger(); + app.UseSwaggerUI(c => + { + c.SwaggerEndpoint("/swagger/v1/swagger.json", "V1"); + c.RoutePrefix = string.Empty; + }); +} + +app.UseCors("DefaultCors"); + +app.MapControllers(); + +app.Run(); diff --git a/CreditApp.Api/Properties/launchSettings.json b/CreditApp.Api/Properties/launchSettings.json new file mode 100644 index 0000000..a9a106e --- /dev/null +++ b/CreditApp.Api/Properties/launchSettings.json @@ -0,0 +1,38 @@ +{ + "$schema": "http://json.schemastore.org/launchsettings.json", + "iisSettings": { + "windowsAuthentication": false, + "anonymousAuthentication": true, + "iisExpress": { + "applicationUrl": "http://localhost:53917", + "sslPort": 44347 + } + }, + "profiles": { + "http": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "http://localhost:5022", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + }, + "https": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "https://localhost:7084;http://localhost:5022", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + }, + "IIS Express": { + "commandName": "IISExpress", + "launchBrowser": true, + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + } + } +} diff --git a/CreditApp.Api/appsettings.Development.json b/CreditApp.Api/appsettings.Development.json new file mode 100644 index 0000000..0c208ae --- /dev/null +++ b/CreditApp.Api/appsettings.Development.json @@ -0,0 +1,8 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + } +} diff --git a/CreditApp.Api/appsettings.json b/CreditApp.Api/appsettings.json new file mode 100644 index 0000000..89cde0c --- /dev/null +++ b/CreditApp.Api/appsettings.json @@ -0,0 +1,16 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + }, + "AllowedHosts": "*", + "ConnectionStrings": { + "redis": "localhost:6379" + } + , + "CreditGenerator": { + "CentralBankRate": 16.0 + } +} diff --git a/CreditApp.Application/CreditApp.Application.csproj b/CreditApp.Application/CreditApp.Application.csproj new file mode 100644 index 0000000..9720842 --- /dev/null +++ b/CreditApp.Application/CreditApp.Application.csproj @@ -0,0 +1,18 @@ + + + + net8.0 + enable + enable + + + + + + + + + + + + diff --git a/CreditApp.Application/Interfaces/ICreditApplicationGenerator.cs b/CreditApp.Application/Interfaces/ICreditApplicationGenerator.cs new file mode 100644 index 0000000..eb1cd57 --- /dev/null +++ b/CreditApp.Application/Interfaces/ICreditApplicationGenerator.cs @@ -0,0 +1,18 @@ +using CreditApp.Domain.Entities; + +namespace CreditApp.Application.Interfaces; + +/// +/// Генерирует объекты заявок на кредит для тестирования, заполнения демонстрационных данных или инициализации. +/// Реализации должны создавать и возвращать готовый к использованию экземпляр . +/// +public interface ICreditApplicationGenerator +{ + /// + /// Асинхронно генерирует заявку на кредит с указанным идентификатором. + /// + /// Идентификатор создаваемой заявки. + /// Токен отмены для асинхронной операции. + /// Сгенерированный экземпляр . + public Task GenerateAsync(int id, CancellationToken ct); +} diff --git a/CreditApp.Application/Interfaces/ICreditService.cs b/CreditApp.Application/Interfaces/ICreditService.cs new file mode 100644 index 0000000..213bb4f --- /dev/null +++ b/CreditApp.Application/Interfaces/ICreditService.cs @@ -0,0 +1,19 @@ +using CreditApp.Domain.Entities; + +namespace CreditApp.Application.Interfaces; + +/// +/// Сервис для работы с объектами кредитных заявок. +/// Предоставляет операции получения и управления заявками в приложении. +/// +public interface ICreditService +{ + /// + /// Асинхронно получает заявку на кредит по её идентификатору. + /// + /// Идентификатор заявки. + /// Токен отмены для асинхронной операции. + /// Экземпляр , соответствующий запрошенному идентификатору. + public Task GetAsync(int id, CancellationToken ct); + +} diff --git a/CreditApp.Application/Services/CreditService.cs b/CreditApp.Application/Services/CreditService.cs new file mode 100644 index 0000000..b85a144 --- /dev/null +++ b/CreditApp.Application/Services/CreditService.cs @@ -0,0 +1,43 @@ +using System.Text.Json; +using CreditApp.Application.Interfaces; +using CreditApp.Domain.Entities; +using Microsoft.Extensions.Caching.Distributed; +using Microsoft.Extensions.Logging; + +namespace CreditApp.Application.Services; + +public class CreditService(IDistributedCache distributedCache, + ICreditApplicationGenerator generator, + ILogger logger) + : ICreditService +{ + public async Task GetAsync(int id, CancellationToken ct) + { + var cacheKey = $"Credit_{id}"; + + var cached = await distributedCache.GetStringAsync(cacheKey, ct); + + if (!string.IsNullOrEmpty(cached)) + { + logger.LogInformation("Cache HIT {CacheKey}", cacheKey); + return JsonSerializer.Deserialize(cached)!; + } + + logger.LogInformation("Cache MISS {CacheKey}", cacheKey); + + var credit = await generator.GenerateAsync(id, ct); + + var options = new DistributedCacheEntryOptions + { + AbsoluteExpirationRelativeToNow = TimeSpan.FromMinutes(10) + }; + + await distributedCache.SetStringAsync( + cacheKey, + JsonSerializer.Serialize(credit), + options, + ct); + + return credit; + } +} diff --git a/CreditApp.Domain/CreditApp.Domain.csproj b/CreditApp.Domain/CreditApp.Domain.csproj new file mode 100644 index 0000000..fa71b7a --- /dev/null +++ b/CreditApp.Domain/CreditApp.Domain.csproj @@ -0,0 +1,9 @@ + + + + net8.0 + enable + enable + + + diff --git a/CreditApp.Domain/Dictionaries/CreditDictionaries.cs b/CreditApp.Domain/Dictionaries/CreditDictionaries.cs new file mode 100644 index 0000000..4c11577 --- /dev/null +++ b/CreditApp.Domain/Dictionaries/CreditDictionaries.cs @@ -0,0 +1,39 @@ +namespace CreditApp.Domain.Dictionaries; + +/// +/// Статический справочник типов кредитов и статусов заявок. +/// Содержит массивы доступных типов кредитов и статусов, а также утилиту для проверки терминального статуса. +/// +public static class CreditDictionaries +{ + /// + /// Доступные типы кредитов. + /// Порядок и значения используются в пользовательском интерфейсе и бизнес-логике приложения. + /// + public static readonly string[] CreditTypes = + [ + "Потребительский", + "Ипотека", + "Автокредит" + ]; + + /// + /// Возможные статусы кредитной заявки. + /// Последние два статуса считаются терминальными (завершёнными). + /// + public static readonly string[] Statuses = + [ + "Новая", + "В обработке", + "Одобрена", + "Отклонена" + ]; + + /// + /// Определяет, является ли указанный статус терминальным (завершённым). + /// + /// Строковое представление статуса заявки. + /// True, если статус равен "Одобрена" или "Отклонена". + public static bool IsTerminal(string status) + => status is "Одобрена" or "Отклонена"; +} diff --git a/CreditApp.Domain/Entities/CreditApplication.cs b/CreditApp.Domain/Entities/CreditApplication.cs new file mode 100644 index 0000000..06d451a --- /dev/null +++ b/CreditApp.Domain/Entities/CreditApplication.cs @@ -0,0 +1,48 @@ +namespace CreditApp.Domain.Entities; + +/// +/// Кредитная заявка +/// +public class CreditApplication +{ + /// + /// Идентификатор в системе + /// + public int Id { get; init; } + /// + /// Тип кредита + /// + public required string CreditType { get; init; } + /// + /// Запрашиваемая сумма + /// + public decimal RequestedAmount { get; init; } + /// + /// Срок в месяцах + /// + public int TermMonths { get; init; } + /// + /// Процентная ставка + /// + public double InterestRate { get; init; } + /// + /// Дата подачи + /// + public DateOnly SubmissionDate { get; init; } + /// + /// Необходимость страховки + /// + public bool HasInsurance { get; init; } + /// + /// Статус заявки + /// + public required string Status { get; init; } + /// + /// Дата решения + /// + public DateOnly? DecisionDate { get; init; } + /// + /// Одобренная сумма + /// + public decimal? ApprovedAmount { get; init; } +} diff --git a/CreditApp.Infrastructure/CreditApp.Infrastructure.csproj b/CreditApp.Infrastructure/CreditApp.Infrastructure.csproj new file mode 100644 index 0000000..eed02d5 --- /dev/null +++ b/CreditApp.Infrastructure/CreditApp.Infrastructure.csproj @@ -0,0 +1,17 @@ + + + + net8.0 + enable + enable + + + + + + + + + + + diff --git a/CreditApp.Infrastructure/Generators/CreditApplicationGenerator.cs b/CreditApp.Infrastructure/Generators/CreditApplicationGenerator.cs new file mode 100644 index 0000000..5547937 --- /dev/null +++ b/CreditApp.Infrastructure/Generators/CreditApplicationGenerator.cs @@ -0,0 +1,53 @@ +using Bogus; +using CreditApp.Application.Interfaces; +using CreditApp.Domain.Dictionaries; +using CreditApp.Domain.Entities; + +namespace CreditApp.Infrastructure.Generators; + +public class CreditApplicationGenerator(double centralBankRate) + : ICreditApplicationGenerator +{ + public Task GenerateAsync(int id, CancellationToken ct) + { + var faker = new Faker(); + + var status = faker.PickRandom(CreditDictionaries.Statuses); + + var submissionDate = DateOnly.FromDateTime( + faker.Date.Between(DateTime.Now.AddYears(-2), DateTime.Now)); + + DateOnly? decisionDate = null; + decimal? approvedAmount = null; + + var requested = Math.Round(faker.Random.Decimal(100_000, 10_000_000), 2); + + if (CreditDictionaries.IsTerminal(status)) + { + decisionDate = submissionDate.AddDays(faker.Random.Int(1, 30)); + + if (status == "Одобрена") + { + approvedAmount = Math.Round( + faker.Random.Decimal(10_000, requested), 2); + } + } + + var interestRate = Math.Round( + faker.Random.Double(centralBankRate, centralBankRate + 10), 2); + + return Task.FromResult(new CreditApplication + { + Id = id, + CreditType = faker.PickRandom(CreditDictionaries.CreditTypes), + RequestedAmount = requested, + TermMonths = faker.Random.Int(6, 360), + InterestRate = interestRate, + SubmissionDate = submissionDate, + HasInsurance = faker.Random.Bool(), + Status = status, + DecisionDate = decisionDate, + ApprovedAmount = approvedAmount + }); + } +} diff --git a/CreditApp/CreditApp.AppHost/AppHost.cs b/CreditApp/CreditApp.AppHost/AppHost.cs new file mode 100644 index 0000000..224b545 --- /dev/null +++ b/CreditApp/CreditApp.AppHost/AppHost.cs @@ -0,0 +1,15 @@ +var builder = DistributedApplication.CreateBuilder(args); + +var redis = builder.AddRedis("credit-cache") + .WithRedisInsight(containerName: "credit-redis-insight"); + +var api = builder.AddProject("credit-api") + .WithReference(redis) + .WaitFor(redis); + +builder.AddProject("client") + .WithReference(api) + .WaitFor(api); + +builder.Build().Run(); + diff --git a/CreditApp/CreditApp.AppHost/CreditApp.AppHost.csproj b/CreditApp/CreditApp.AppHost/CreditApp.AppHost.csproj new file mode 100644 index 0000000..b6d2633 --- /dev/null +++ b/CreditApp/CreditApp.AppHost/CreditApp.AppHost.csproj @@ -0,0 +1,23 @@ + + + + + + Exe + net8.0 + enable + enable + 70c1c02b-8ca4-435d-8e0e-594485960c89 + + + + + + + + + + + + + diff --git a/CreditApp/CreditApp.AppHost/Properties/launchSettings.json b/CreditApp/CreditApp.AppHost/Properties/launchSettings.json new file mode 100644 index 0000000..171fa4f --- /dev/null +++ b/CreditApp/CreditApp.AppHost/Properties/launchSettings.json @@ -0,0 +1,29 @@ +{ + "$schema": "https://json.schemastore.org/launchsettings.json", + "profiles": { + "https": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "https://localhost:17005;http://localhost:15107", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development", + "DOTNET_ENVIRONMENT": "Development", + "ASPIRE_DASHBOARD_OTLP_ENDPOINT_URL": "https://localhost:21196", + "ASPIRE_RESOURCE_SERVICE_ENDPOINT_URL": "https://localhost:22132" + } + }, + "http": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "http://localhost:15107", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development", + "DOTNET_ENVIRONMENT": "Development", + "ASPIRE_DASHBOARD_OTLP_ENDPOINT_URL": "http://localhost:19106", + "ASPIRE_RESOURCE_SERVICE_ENDPOINT_URL": "http://localhost:20243" + } + } + } +} diff --git a/CreditApp/CreditApp.AppHost/appsettings.Development.json b/CreditApp/CreditApp.AppHost/appsettings.Development.json new file mode 100644 index 0000000..0c208ae --- /dev/null +++ b/CreditApp/CreditApp.AppHost/appsettings.Development.json @@ -0,0 +1,8 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + } +} diff --git a/CreditApp/CreditApp.AppHost/appsettings.json b/CreditApp/CreditApp.AppHost/appsettings.json new file mode 100644 index 0000000..31c092a --- /dev/null +++ b/CreditApp/CreditApp.AppHost/appsettings.json @@ -0,0 +1,9 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning", + "Aspire.Hosting.Dcp": "Warning" + } + } +} diff --git a/CreditApp/CreditApp.ServiceDefaults/CreditApp.ServiceDefaults.csproj b/CreditApp/CreditApp.ServiceDefaults/CreditApp.ServiceDefaults.csproj new file mode 100644 index 0000000..1b6e209 --- /dev/null +++ b/CreditApp/CreditApp.ServiceDefaults/CreditApp.ServiceDefaults.csproj @@ -0,0 +1,22 @@ + + + + net8.0 + enable + enable + true + + + + + + + + + + + + + + + diff --git a/CreditApp/CreditApp.ServiceDefaults/Extensions.cs b/CreditApp/CreditApp.ServiceDefaults/Extensions.cs new file mode 100644 index 0000000..c572403 --- /dev/null +++ b/CreditApp/CreditApp.ServiceDefaults/Extensions.cs @@ -0,0 +1,128 @@ +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 Microsoft.Extensions.ServiceDiscovery; +using OpenTelemetry; +using OpenTelemetry.Metrics; +using OpenTelemetry.Trace; + +namespace CreditApp.ServiceDefaults; + +// Adds common Aspire services: service discovery, resilience, health checks, and OpenTelemetry. +// This project should be referenced by each service project in your solution. +// To learn more about using this project, see https://aka.ms/dotnet/aspire/service-defaults +public static class Extensions +{ + private const string HealthEndpointPath = "/health"; + private const string AlivenessEndpointPath = "/alive"; + + public static TBuilder AddServiceDefaults(this TBuilder builder) where TBuilder : IHostApplicationBuilder + { + builder.ConfigureOpenTelemetry(); + + builder.AddDefaultHealthChecks(); + + builder.Services.AddServiceDiscovery(); + + builder.Services.ConfigureHttpClientDefaults(http => + { + // Turn on resilience by default + http.AddStandardResilienceHandler(); + + // Turn on service discovery by default + http.AddServiceDiscovery(); + }); + + // Uncomment the following to restrict the allowed schemes for service discovery. + // builder.Services.Configure(options => + // { + // options.AllowedSchemes = ["https"]; + // }); + + return builder; + } + + public static TBuilder ConfigureOpenTelemetry(this TBuilder builder) where TBuilder : IHostApplicationBuilder + { + builder.Logging.AddOpenTelemetry(logging => + { + logging.IncludeFormattedMessage = true; + logging.IncludeScopes = true; + }); + + builder.Services.AddOpenTelemetry() + .WithMetrics(metrics => + { + metrics.AddAspNetCoreInstrumentation() + .AddHttpClientInstrumentation() + .AddRuntimeInstrumentation(); + }) + .WithTracing(tracing => + { + tracing.AddSource(builder.Environment.ApplicationName) + .AddAspNetCoreInstrumentation(tracing => + // Exclude health check requests from tracing + tracing.Filter = context => + !context.Request.Path.StartsWithSegments(HealthEndpointPath) + && !context.Request.Path.StartsWithSegments(AlivenessEndpointPath) + ) + // Uncomment the following line to enable gRPC instrumentation (requires the OpenTelemetry.Instrumentation.GrpcNetClient package) + //.AddGrpcClientInstrumentation() + .AddHttpClientInstrumentation(); + }); + + builder.AddOpenTelemetryExporters(); + + return builder; + } + + private static TBuilder AddOpenTelemetryExporters(this TBuilder builder) where TBuilder : IHostApplicationBuilder + { + var useOtlpExporter = !string.IsNullOrWhiteSpace(builder.Configuration["OTEL_EXPORTER_OTLP_ENDPOINT"]); + + if (useOtlpExporter) + { + builder.Services.AddOpenTelemetry().UseOtlpExporter(); + } + + // Uncomment the following lines to enable the Azure Monitor exporter (requires the Azure.Monitor.OpenTelemetry.AspNetCore package) + //if (!string.IsNullOrEmpty(builder.Configuration["APPLICATIONINSIGHTS_CONNECTION_STRING"])) + //{ + // builder.Services.AddOpenTelemetry() + // .UseAzureMonitor(); + //} + + return builder; + } + + public static TBuilder AddDefaultHealthChecks(this TBuilder builder) where TBuilder : IHostApplicationBuilder + { + builder.Services.AddHealthChecks() + // Add a default liveness check to ensure app is responsive + .AddCheck("self", () => HealthCheckResult.Healthy(), ["live"]); + + return builder; + } + + public static WebApplication MapDefaultEndpoints(this WebApplication app) + { + // Adding health checks endpoints to applications in non-development environments has security implications. + // See https://aka.ms/dotnet/aspire/healthchecks for details before enabling these endpoints in non-development environments. + if (app.Environment.IsDevelopment()) + { + // All health checks must pass for app to be considered ready to accept traffic after starting + app.MapHealthChecks(HealthEndpointPath); + + // Only health checks tagged with the "live" tag must pass for app to be considered alive + app.MapHealthChecks(AlivenessEndpointPath, new HealthCheckOptions + { + Predicate = r => r.Tags.Contains("live") + }); + } + + return app; + } +} diff --git a/Directory.Packages.props b/Directory.Packages.props new file mode 100644 index 0000000..a3895d3 --- /dev/null +++ b/Directory.Packages.props @@ -0,0 +1,6 @@ + + + + 9.5.2 + + \ No newline at end of file diff --git a/README.md b/README.md index dcaa5eb..38f247f 100644 --- a/README.md +++ b/README.md @@ -1,128 +1,53 @@ -# Современные технологии разработки программного обеспечения -[Таблица с успеваемостью](https://docs.google.com/spreadsheets/d/1an43o-iqlq4V_kDtkr_y7DC221hY9qdhGPrpII27sH8/edit?usp=sharing) - -## Задание -### Цель -Реализация проекта микросервисного бекенда. - -### Задачи -* Реализация межсервисной коммуникации, -* Изучение работы с брокерами сообщений, -* Изучение архитектурных паттернов, -* Изучение работы со средствами оркестрации на примере .NET Aspire, -* Повторение основ работы с системами контроля версий, -* Интеграционное тестирование. - -### Лабораторные работы -
-1. «Кэширование» - Реализация сервиса генерации контрактов, кэширование его ответов -
- -В рамках первой лабораторной работы необходимо: -* Реализовать сервис генерации контрактов на основе Bogus, -* Реализовать кеширование при помощи IDistributedCache и Redis, -* Реализовать структурное логирование сервиса генерации, -* Настроить оркестрацию Aspire. - -
-
-2. «Балансировка нагрузки» - Реализация апи гейтвея, настройка его работы -
- -В рамках второй лабораторной работы необходимо: -* Настроить оркестрацию на запуск нескольких реплик сервиса генерации, -* Реализовать апи гейтвей на основе Ocelot, -* Имплементировать алгоритм балансировки нагрузки согласно варианту. - -
-
-
-3. «Интеграционное тестирование» - Реализация файлового сервиса и объектного хранилища, интеграционное тестирование бекенда -
- -В рамках третьей лабораторной работы необходимо: -* Добавить в оркестрацию объектное хранилище, -* Реализовать файловый сервис, сериализующий сгенерированные данные в файлы и сохраняющий их в объектном хранилище, -* Реализовать отправку генерируемых данных в файловый сервис посредством брокера, -* Реализовать интеграционные тесты, проверяющие корректность работы всех сервисов бекенда вместе. - -
-
-
-4. (Опционально) «Переход на облачную инфраструктуру» - Перенос бекенда в Yandex Cloud -
- -В рамках четвертой лабораторной работы необходимо перенестиервисы на облако все ранее разработанные сервисы: -* Клиент - в хостинг через отдельный бакет Object Storage, -* Сервис генерации - в Cloud Function, -* Апи гейтвей - в Serverless Integration как API Gateway, -* Брокер сообщений - в Message Queue, -* Файловый сервис - в Cloud Function, -* Объектное хранилище - в отдельный бакет Object Storage, - -
-
- -## Задание. Общая часть -**Обязательно**: -* Реализация серверной части на [.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). +# Лабораторная работа №1 +## «Кэширование» --- Реализация сервиса генерации контрактов + +## Что было сделано + +В рамках первой лабораторной работы реализован микросервис генерации +контрактов с использованием кэширования и оркестрации. + +### 1. Реализован сервис генерации контрактов + +- Создан ASP.NET Core Web API сервис. +- Реализована генерация контрактов с использованием библиотеки Bogus. +- Контракт содержит основные поля: Id, номер, имя клиента, дата, + сумма, статус. +- Добавлен endpoint для получения контракта по идентификатору. + +### 2. Реализовано кэширование через Redis + +- Подключён Redis. +- Настроен IDistributedCache. +- Реализована логика: + - При первом запросе контракт генерируется и сохраняется в Redis. + - При повторном запросе данные возвращаются из кэша. +- Настроено время жизни кэша (TTL). + +### 4. Настроена оркестрация через .NET Aspire + +- Создан проект AppHost. +- Подключён сервис генерации контрактов. +- Добавлен Redis как зависимость. +- Настроены связи между сервисами. +- Запуск всей инфраструктуры осуществляется через Aspire. + +## Используемые технологии + +- .NET 8 +- ASP.NET Core Web API +- Bogus +- Redis +- IDistributedCache +- .NET Aspire +- Docker + +## Скриншоты + +### Aspire Dashboard + +![Aspire Dashboard](images/1.png) + +### Web + +![Web](images/2.png) \ No newline at end of file diff --git a/images/1.png b/images/1.png new file mode 100644 index 0000000..7c85ec7 Binary files /dev/null and b/images/1.png differ diff --git a/images/2.png b/images/2.png new file mode 100644 index 0000000..10f45f3 Binary files /dev/null and b/images/2.png differ