ASP.NET(2)

Для выполнения переадресации у объекта HttpResponse определен метод

void Redirect(string location)
void Redirect(string location, bool permanent)

Перенаправить на определённую страницу:

context.Response.Redirect("/new");

Как отправить JSON

context.Response.WriteAsJsonAsync(tom);

Как отправить JSON через WriteAync

response.Headers.ContentType = "application/json; charset=utf-8";
await response.WriteAsync("{'name':'Tom', 'age':37}");

Для получения из запроса объект в формате JSON в классе HttpRequest определен метод

ReadFromJsonAsync(). Он позволяет сериализовать данные в объект определенного типа.

Преобразовать в объект из JSON асинхронно

var person = await request. ReadFormJsonAsync ();

Какое пространство имён нужно подключить для использования класса JsonConverter?

System.Text.Json .Serialization;

При наследовании класса JsonConverter необходимо реализовать его абстрактные методы:

Read() (выполняет десериализацию из JSON в Person) и Write() (выполняет сериализацию из Person в JSON).

Write() принимает три параметра:

Utf8JsonWriter - объект, который записывает данные в json

Person - объект, который надо сериализовать

JsonSerializerOptions - дополнительные параметры сериализации

Read() принимает три параметра:

Utf8JsonReader - объект, который читает данные из json

Type - тип, в который надо выполнить конвертацию

JsonSerializerOptions - дополнительные параметры сериализации

Токен (token)

токен (token) - это базовая единица данных, которая получается в результате разбора (парсинга) JSON-строки.

Что это: string expressionForGuid = @"^/api/users/\w{8}-\w{4}-\w{4}-\w{4}-\w{12}$";

Это строковая переменная, содержащая регулярное выражение для поиска GUID в формате, используемом API "/api/users". В данном случае это GUID с 8 шестнадцатеричными символами, затем через дефис 4 группы по 4 символа и 12 символов в последней группе. Символ "\w" означает любой буквенный символ или цифру. Символы "/", "^" и "$" используются для определения начала и конца выражения.

Все загружаемые файлы в ASP.NET Core представлены типом...

IFormFile из пространства имен Microsoft.AspNetCore.Http

Методы IFormFile:

ContentType: тип файла

FileName: название файла

Length: размер файла

CopyTo/CopyToAsync: копирует файл в поток

OpenReadStream: открывает поток файла для чтения

благодаря установке атрибута формы '...' браузер будет знать, что вместе с формой надо передать файлы.

enctype="multipart /form-data"

Как получить коллекцию файлов из запроса

IFormFileCollection files = request.Form.Files;

Метод расширения Use()

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

Use() имеет следующие версии

public static IApplicationBuilder Use(this IApplicationBuilder app, Func

Работа middleware разбивается на две части:

Middleware выполняет некоторую начальную обработку запроса до вызова await next.Invoke()

Затем вызывается метод next.Invoke(), который передает обработку запроса следующему компоненту в конвейере

Когда следующий в конвейере компонент закончил обработку запрос возвращается в обратно в текущий компонент, и выполняются действия, которые идут после вызова await next.Invoke(

Метод UseWhen()

на основании некоторого условия позволяет создать ответвление конвейера при обработке запроса:

public static IApplicationBuilder UseWhen (this IApplicationBuilder app, Func predicate, Action configuration);

Метод MapWhen()

как и метод UseWhen(), на основании некоторого условия позволяет создать ответвление конвейера:

public static IApplicationBuilder MapWhen (this IApplicationBuilder app, Func predicate, Action configuration);

Метод Map()

применяется для создания ветки конвейера, которая будет обрабатывать запрос по определенному пути. Этот метод реализован как метод расширения для типа IApplicationBuilder и имеет ряд перегруженных версий.

Объект `IApplicationBuilder` используется для ...

настройки конвейера запросов и формирования ответов в ASP.NET Core

Класс middleware должен иметь конструктор, который принимает параметр типа...

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

UseMiddleware()

Для добавления компонента middleware, который представляет класс, в конвейер обработки запроса применяется метод UseMiddleware().

Middleware

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

ASP.NET Routing

- это процесс перехвата URL-адресов запросов веб-приложения в ASP.NET и их преобразование в обработчики запросов. Это позволяет разработчикам ASP.NET создавать URL-адреса, которые более легко читаются людьми и которые имеют более интуитивную структуру, чем традиционные URL-адреса с параметрами. ASP.NET Routing также позволяет создавать более гибкие маршруты запросов, что может помочь улучшить SEO-оптимизацию вашего веб-приложения.

IWebHostEnvironment

Интерфейс для взаимодействия с окружением, в котором запущено приложение

Свойства IWebHostEnvironment

ApplicationName
EnvironmentName
ContentRootPath
WebRootPath
ContentRootFileProvider WebRootFileProvider

ApplicationName

Хранит имя приложения.

EnvironmentName

Хранит название среды, в которой хостируется приложение.

ContentRootPath

Хранит путь к корневой папке приложения.

WebRootPath

Хранит путь к папке, в которой хранится статический контент приложения. По умолчанию это папка wwwroot.

ContentRootFileProvider

Возвращает реализацию интерфейса Microsoft.AspNetCore.FileProviders.IFileProvider, которая может использоваться для чтения файлов из папки ContentRootPath.

WebRootFileProvider

возвращает реализацию интерфейса Microsoft.AspNetCore.FileProviders.IFileProvider, которая может использоваться для чтения файлов из папки WebRootPath

Для определения значения переменной "ASPNETCORE_ENVIRONMENT" для интерфейса IWebHostEnvironment определены специальные методы расширения:

IsEnvironment(string envName):
IsDevelopment():
IsStaging():
IsProduction():

IsEnvironment(string envName):

возвращает true, если имя среды равно значению параметра envName

IsDevelopment():

возвращает true, если имя среды - Development

IsStaging():

возвращает true, если имя среды - Staging

IsProduction():

возвращает true, если имя среды - Production

Что значит: if (context.HostingEnvironment .IsDevelopment())
{ app.UseDeveloperExceptionPage();
}

Здесь если имя среды имеет значение "Development" (то есть приложение находится в состоянии разработки), то при ошибке разработчик увидит детальное описание ошибки. Если же приложение развернуто на хостинге и соответственно имеет другое имя хостирующей среды, то простой пользователь при ошибке ничего не увидит. Таким образом, в зависимости от стадии, на которой находится проект, мы можем скрывать или задействовать часть функционала приложения.

Dependency injection (DI) или внедрение зависимостей

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

IoC-контейнеры

(Inversion of Control). Такие контейнеры служат своего рода фабриками, которые устанавливают зависимости между абстракциями и конкретными объектами и, как правило, управляют созданием этих объектов.

Каждый сервис в коллекции IServiceCollection представляет...

объект ServiceDescriptor, который несет некоторую информацию. Наиболее важные свойства этого объекта:

ServiceType: тип сервиса

ImplementationType: тип реализации сервиса

Lifetime: жизненный цикл сервиса

добавим в коллекцию сервисов сервис ITimeService

builder.Services.AddTransient ();

iServiceProvider

Это интерфейс, который определяет методы для получения сервиса в приложении .NET. Он содержит единственный метод GetService, который возвращает объект заданного типа, предоставленный контейнером внедрения зависимостей.

В ASP.NET Core мы можем получить добавленные в приложения сервисы различными способами:

Через свойство Services объекта WebApplication (service locator)

Через свойство RequestServices контекста запроса HttpContext в компонентах middleware (service locator)

Через конструктор класса

Через параметр метода Invoke компонента middleware

Через свойство Services объекта WebApplicationBuilder

GetRequiredService()

использует провайдер сервисов для создания объекта, который представляет тип service. В случае если в провайдере сервисов для данного сервиса не установлена зависимость, то генерирует исключение

HttpContext.RequestServices

Там, где нам доступен объект HttpContext, мы можем использовать для получения сервисов его свойство RequestServices. Это свойство предоставляет объект IServiceProvider

С точки зрения жизненного цикла сервисы могут представлять один из следующих типов:

"Transient,
Scoped,
Singleton."
Для создания каждого типа сервиса предназначен соответствующий метод AddTransient(), AddScoped() и AddSingleton().

Transient:

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

Scoped:

для каждого запроса создается свой объект сервиса. То есть если в течение одного запроса есть несколько обращений к одному сервису, то при всех этих обращениях будет использоваться один и тот же объект сервиса.

Singleton:

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

Метод AddTransient()

создает transient-объекты. Такие объекты создаются при каждом обращении к ним.

Метод AddTransient() имеет ряд перегруженных версий:

AddTransient(Type serviceType)

AddTransient(Type serviceType, Type implementationType)

AddTransient(Type serviceType, Func implementationFactory)

AddTransient()

AddTransient()

AddTransient(Func implementationFactory)

AddTransient(Func implementationFactory)

Система маршрутизации

отвечает за сопоставление входящих запросов с маршрутами и на основании результатов сопоставления выбирает для обработки запроса определенную конечную точку приложения

Конечная точка или endpoint

это некоторый код, который обрабатывает запрос. По сути конечная точка объединяет шаблон маршрута, которому должен соответствовать запрос, и обработчик запроса по этому маршруту.

Microsoft .AspNetCore.Routing .IEndpointRouteBuilder

Включает функционал для создания конечных точек

Microsoft.AspNetCore.Routing .EndpointMiddleware

добавляет в конвейер обработки запроса конечные точки. Добавляется в конвейер с помощью метода UseEndpoints()

Microsoft.AspNetCore.Routing .EndpointRoutingMiddleware

добавляет в конвейер обработки запроса функциональность сопоставления запросов и маршрутов. Данный middleware выбирает конечную точку, которая соответствует запросу и которая затем обрабатывает запрос. Добавляется в конвейер с помощью метода UseRouting()

Метод Map в контексте определения конечной точки

Это самый простой способ определения конечной точки в приложении, он реализован как метод расширения для типа IEndpointRouteBuilder. Он добавляет конечные точки для обработки запросов типа GET.

Как определить параметр в пути как необязательный

app.Map("/users/{id?}", (string? id) => $"User Id: {id??"Undefined"}");

Как ограничить маршрут по типу данных

app.Map("/users/{id:int}",(int id) => $"User Id: {id}");

ASP.NET Core предоставляет следующий ряд ограничений маршрута (кроме тех, что по типу данных):

minlength(value)
maxlength(value)
length(value)
length(min, max)
min(value)
max(value)
range(min, max)
alpha
regex(expression)
required. Все классы ограничений находятся в пространстве имен Microsoft.AspNetCore.Routing.Constraints

minlength(value)

Строка должна иметь символов не меньше value. Представляет класс MinLengthRouteConstraint. Пример: {name:minlength(3)}

maxlength(value)

Строка должна иметь символов не больше value. Представляет класс MaxLengthRouteConstraint. Пример: {name:maxlength(20)}

length(value)

Строка должна иметь ровно столько символов, сколько определено в параметре value. Представляет класс LengthRouteConstraint. Пример: {name:length(10)}

length(min, max)

Строка должна иметь символов не меньше min и не больше max. Представляет класс LengthRouteConstraint. Пример: {name:length(3, 20)}

min(value)

Число должно быть не меньше value. Представляет класс MinRouteConstraint. Пример: {age:min(3)}

max(value)

Число должно быть не больше value. Представляет класс MaxRouteConstraint. Пример: {age:max(20)}

range(min, max)

Число должно быть не меньше min и не больше max. Представляет класс RangeRouteConstraint. Пример: {age:range(18, 99)}

alpha

Строка должна состоять из одного и более алфавитных символов. Представляет класс AlphaRouteConstraint. Пример: {name:alpha}

regex(expression)

Строка должна соответствовать регулярному выражению expression. Представляет класс RegexRouteConstraint. Пример: {phone:regex(^\d{{3}}-\d{{3}}-\d{{4}}$)}

required

Параметр является обязательным, и его значение должно быть определено. Представляет класс RequiredRouteConstraint.

Для создания собственного ограничения маршрута нужно...

реализовать интерфейс IRouteConstraint с одним единственным методом Match:

public interface IRouteConstraint
{
bool Match(HttpContext? httpContext,
IRouter? route,
string routeKey,
RouteValueDictionary values,
RouteDirection routeDirection);
}

Параметры метода Match:

httpContext: объект HttpContext, который инкапсулирует информацию о HTTP-запросе

route: объект IRouter, который представляет маршрут, в рамках которого применяется ограничение

routeKey: объект String - название параметра маршрута, к которому применяется ограничение

values: объект RouteValueDictionary, который представляет набор параметров маршрута в виде словаря, где ключи - названия параметров, а значения - значения параметров маршрута

routeDirection: объект перечисления RouteDirection, которое указывает, применяется ограничение при обработке запроса, либо при генерации ссылки

Этапы URL matching

Сначала выбираются все конечные точки, шаблон маршрута которых совпадает с путем запроса

Далее из полученного на предыдущем этапе набора конечных точек удаляются те, которые не соответствуют ограничениям маршрута

Затем из полученного на предыдущем этапе набора конечных точек удаляются те, которые не удавлетворяют политике объекта MatcherPolicy (вкратце: класс MatcherPolicy позволяет определить порядок сравнения конечных точек и адреса URL)

И в самом конце применяется объект EndpointSelector для выбора из полученного на предыдущем этапе списка конечной точки, которая в конечном счете и будет обрабатывать запрос

Специфичность шаблона определяется на основе следующих критериев:

Шаблон маршрута с большим количеством сегментов более специфичен, чем шаблон меньшим количеством сегментов

Сегмент с текстовым литералом (статический сегмент) более специфичен, чем сегмент с параметром маршрута

Сегмент с параметром, к которому применяется ограничение маршрута, более специфичен, чем сегмент с параметром без ограничения

Комплексный сегмент более специфичен, чем сегмент с параметром с ограничением

Параметр catch-all (параметр, который соответствует неопределенному количеству сегментов) наименее специфичен

Как подключить статические файлы

app.UseStaticFiles();

Как изменить путь к статическим файлам проекта?

var builder = WebApplication.CreateBuilder(
new WebApplicationOptions { WebRootPath = "static"});

поддержка страниц html по умолчанию

DefaultFilesOptions options = new DefaultFilesOptions();
options.DefaultFileNames.Clear(); // удаляем имена файлов по умолчанию
options.DefaultFileNames.Add("hello.html"); // добавляем новое имя файла
app.UseDefaultFiles(options); // установка параметров

Позволяет пользователям просматривать содержимое каталогов на сайте:

app.UseDirectoryBrowser();
app.UseStaticFiles();

Конфигурация приложения в ASP.NET Core представляет объект интерфейса

IConfiguration:

public interface IConfiguration
{
string this[string key] { get; set; }
IEnumerable GetChildren();
IChangeToken GetReloadToken();
IConfigurationSection GetSection(string key);
}

IConfiguration содержит компоненты:

this [string key]
GetChildren():
GetReloadToken()
GetSection(string key)

this [string key]

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

GetChildren():

Возвращает набор подсекций текущей секции конфигурации в виде объекта IEnumerable

GetReloadToken()

возвращает объект IChangeToken, который применяется для отслеживания изменения конфигурации

GetSection(string key)

Возвращает секцию конфигурации, которая соответствует ключу key

IConfigurationRoot

public interface IConfigurationRoot : IConfiguration
{
IEnumerable Providers { get; }
void Reload();
}

Передать параметры командной строки через метод AddCommandLine():

var builder = WebApplication .CreateBuilder();
string[] commandLineArgs = { "name=Sam", "age=25" };
builder.Configuration .AddCommandLine(commandLineArgs);

Как добавить JSON - или несколько файлов JSON?

builder.Configuration
.AddJsonFile("config.json")
.AddJsonFile("otherconfig.json");

За использование конфигурации в XML-файле отвечает...

провайдер XmlConfigurationProvider

Для загрузки xml-файла применяется

метод расширения AddXmlFile()

Но json может хранить также более сложные по составу объекты. И чтобы обратиться к этой настройке...

нам надо использовать знак двоеточия для обращения к иерархии настроек

Пример логирования

app.Logger.LogInformation ($"Processing request {context.Request.Path}");

В чем смысл категории логгера?

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

Мы можем использовать следующие значения LogLevel:

Trace
Debug
Information
Warning
Error
Critical
None

Trace

Уровень логирования, используемый для вывода наиболее детализированных сообщений, содержащих важную информацию о приложении и его строении

Debug

Уровень логирования, используемый для вывода информации, полезной при разработке и отладке приложения

Information

Уровень логирования, позволяющий просто отслеживать поток выполнения приложения

Warning

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

Error

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

Critical

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

None

Уровень логирования, при котором вывод информации в лог не применяется

Для вывода соответствующего уровня информации у объекта ILogger определены соответствующие методы расширения:

LogDebug()

LogTrace()

LogInformation()

LogWarning()

LogError()

LogCritical()

Перегрузки методов ILogger:

string data: строковое сообщение для лога

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

string format: строковое сообщения для лога, которое может содержать параметры

object[] args: набор параметров для строкового сообщения

Exception error: логгируемый объект исключения

Log()

позволяет определить уровень логгера через один из параметров

// добавляем IDistributedMemoryCache // добавляем сервисы сессии

builder.Services .AddDistributedMemoryCache();
builder.Services.AddSession();

добавляем middleware для работы с сессиями

app.UseSession();