День 1851. #Шпаргалка
Примеры Кода для Повседневных Задач
В этой серии представлю вам коллекцию фрагментов кода C#, охватывающих широкий спектр сценариев, с которыми вы можете столкнуться при разработке ПО.

III. Операции с файлами
Операции с файлами являются общим требованием во многих задачах. В этом разделе мы рассмотрим, как работать с файлами и каталогами в C#, используя пространство имён System.IO.

1. Чтение текстового файла
Чтобы прочитать текстовый файл в C#, вы можете использовать класс File и его метод ReadAllText():

var path = "example.txt";
var content = File.ReadAllText(path);
Console.WriteLine(content);

2. Запись текстового файла
Чтобы записать текстовый файл, можно использовать метод WriteAllText() класса File:

var path = "output.txt";
var content = "Hello, World!";
File.WriteAllText(path, content);

3. Дозапись текста в файл
Чтобы добавить текст в текущий файл, можно использовать метод AppendAllText():

var path = "log.txt";
var logEntry = "New log entry";
File.AppendAllText(path, logEntry);

4. Чтение файла построчно
Для чтения файла построчно подойдёт метод ReadLines():

var path = "example.txt";
foreach (var line in File.ReadLines(path))
  Console.WriteLine(line);

5. Создание/удаление папки
Для создания/удаления папки используйте соответственно методы CreateDirectory() и Delete() класса Directory:

var path = "new_directory";
Directory.CreateDirectory(path);
Directory.Delete(path, true);

Второй параметр метода Delete указывает, надо ли удалять всё содержимое папки.

6. Проверка существования
Чтобы проверить существование файла или папки, используйте метод Exists() класса File или Directory соответственно:

var fPath = "example.txt";
var dPath = "directory";

var fileExists = File.Exists(fPath);
var dirExists = Directory.Exists(dPath);

7. Список файлов в папке
Используйте метод GetFiles() класса Directory:

var path = " directory";
var files = Directory.GetFiles(path);

foreach (var f in files)
  Console.WriteLine(f);

8. Копия/перемещение файла
Используйте соответственно методы Copy() или Move() класса File:

var source = "example.txt";
var copy = "copy_example.txt";
var moved = "moved_example.txt";

File.Copy(source, copy);

File.Move(source, moved);

Источник: https://medium.com/bytehide/100-csharp-code-snippets-for-everyday-problems-e913c786dec9

День 1852. #юмор
А вам тяжело расставаться с проектами?

День 1853. #ЗаметкиНаПолях
Автоматически Регистрируем Конечные Точки в Минимальных API
В минимальных API регистрация каждой конечной точки через app.MapGet, app.MapPost и т.п. может привести к появлению повторяющегося кода. По мере роста проекта этот ручной процесс становится всё более трудоёмким и загромождать файл Program.cs. Можно попробовать группировать конечные точки, используя методы расширения, но это похоже на переизобретение контроллеров.

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

Сначала создадим интерфейс. Метод MapEndpoint принимает IEndpointRouteBuilder, который мы сможем использовать для вызова MapGet, MapPost и т.п.

public interface IEndpoint
{
  void MapEndpoint(IEndpointRouteBuilder app);
}

Каждая реализация IEndpoint должна содержать ровно одно определение конечной точки. Ничто не мешает регистрировать несколько, но лучше не стоит.

public class GetUserStats : IEndpoint
{
  public void MapEndpoint(IEndpointRouteBuilder app)
  {
    app.MapGet(
     "users/{id}/stats", 
     async (Guid id) =>
     { 
      return await GetStats(id);
     }
    );
  } 
}

Теперь используем рефлексию для сканирования сборок .NET и поиска классов, реализующих IEndpoint:

public static IServiceCollection AddEndpoints(
  this IServiceCollection services,
  Assembly assembly)
{
  var svcs = assembly.DefinedTypes
    .Where(t => t is 
     { IsAbstract: false, IsInterface: false } &&
     t.IsAssignableTo(typeof(IEndpoint)))
    .Select(t => 
     ServiceDescriptor.Transient(typeof(IEndpoint), t))
    .ToArray();

  services.TryAddEnumerable(svcs);
  return services;
}

Наконец создадим метод расширения для регистрации конечных точек. Мы ищем все регистрации IEndpoint. Это будут классы конечных точек, которые мы теперь можем зарегистрировать в приложении, вызвав их метод MapEndpoint. Здесь мы также добавим параметр RouteGroupBuilder для возможности группировки конечных точек.

public static IApplicationBuilder MapEndpoints(
  this WebApplication app,
  RouteGroupBuilder? rgb = null)
{
  var endpoints = app.Services
    .GetRequiredService<IEnumerable<IEndpoint>>();

  // Регистрируем в группу, если она задана.
  // Если нет, то на уровне приложения
  var builder = rgb is null ? app : rgb;

  foreach (IEndpoint ep in endpoints)
    ep.MapEndpoint(builder);

  return app;
}

Вот как будет выглядеть файл Program.cs:
- AddEndpoints регистрирует реализации IEndpoint,
- MapEndpoints регистрирует конечные точки.

var builder = 
 WebApplication.CreateBuilder(args);
…
builder.Services.AddEndpoints(
 typeof(Program).Assembly);

var app = builder.Build();
…
app.MapEndpoints();
app.Run();

Итого
Автоматическая регистрация конечных точек в минимальных API может значительно повысить эффективность разработки и удобство сопровождения проекта. Хотя важно признать потенциальное влияние рефлексии на производительность при запуске приложения, а также на возможность использовать Native AOT. Потенциальным улучшением может стать использование генераторов кода для логики регистрации.

Полный код проекта тут.

Источник: https://www.milanjovanovic.tech/blog/automatically-register-minimal-apis-in-aspnetcore

День 1854. #ЧтоНовенького
Планы на .NET 9
Мы находимся в начале очередного ежегодного цикла выпусков .NET. Microsoft поделились своим видением на .NET 9, релиз которого запланирован на .NET Conf 2024 в конце года. Наиболее важными направлениями являются разработка облачных приложений, значительные инвестиции в производительность и безопасность, а также развитие всей платформы. Первая превью версия .NET 9 уже выпущена.

Платформа для облачной разработки
В .NET 9 будет продолжено развитие облачных технологий с упором
на производительность во время выполнения и мониторинг приложений. Также будет уделено внимание упрощению интеграции с популярными сервисами, например, Kubernetes или Redis. Все эти возможности объединены в .NET Aspire, что значительно снизит стоимость и сложность создания облачных приложений.

Продолжится разработка Native AOT и тримминг приложений как ключевых инструментов для оптимизации рабочих приложений. В .NET 8 оптимизированы приложения веб-API, в .NET 9 будут оптимизированы другие типы приложений, а также обещано дальнейшее улучшение сборщика данных для динамической адаптации к размерам приложений (DATAS).

В Azure Container Apps позаботятся о том, чтобы приложения .NET 9 можно было легко масштабировать до нескольких экземпляров в их Kubernetes-среде. Также планируются улучшения безопасности при работе с такими данными, как токены защиты от подделки и токены аутентификации, и оптимизация API ограничений при работе с несколькими экземплярами.

Пример приложения eShop, который был продемонстрирован на .NET Conf в прошлом году, будет обновлён, чтобы использовать преимущества этих новых возможностей и вариантов развертывания по мере развития .NET 9 в течение года.

Visual Studio и VS Code будут включать новые возможности разработки и развёртывания для .NET Aspire: настройку компонентов, отладку (включая горячую перезагрузку) хоста приложений и дочерних процессов, а также полную интеграцию с панелью разработчика. Разработчики смогут развёртывать свои проекты в приложениях-контейнерах Azure из Visual Studio, VS Code и с помощью Azure Developer CLI.

Дорожная карта .NET 9
Здесь можно посмотреть детальные дорожные карты по разработке новинок в каждой сфере, будь то C#, ASP.NET, Entity Framework или Roslyn. Пока многие из них пустые, но в скором времени будут обновлены.

PS: если вы ждали Discriminated Unions в C#, то их там (пока) нет. Вообще новинок в C# довольно мало, и они сильно узкоспециализированные. Надеюсь, что в течение года появится что-то более интересное.

Источник: https://devblogs.microsoft.com/dotnet/our-vision-for-dotnet-9/

День 1855. #Шпаргалка
Шпаргалка по LINQ

См. подробнее
- Книга «LINQ Explained with sketches»
- Новые методы LINQ в .NET 9

См. также
- LINQ на Стероидах с SIMD
- Parallel LINQ
- Использование LINQ с асинхронными потоками

Источник: https://steven-giesel.com/blogPost/62049533-001a-46fb-a1da-88effc0183f1/linq-mindmap-net-9-edition

День 1856. #ЗаметкиНаПолях
Получаем Все Исключения из Parallel.ForEachAsync
На C# вы можете написать асинхронный код, похожий на синхронный код. Люди, использующие async/await, ожидают, что смогут перехватывать исключения, как в синхронном коде. Это очень удобно, но иногда вам нужно получить все исключения из асинхронного метода.

try
{
  // Это выбросит несколько исключений
  await Parallel.ForEachAsync(
   Enumerable.Range(1, 10), 
   async (i, _) =>
   {
     throw new Exception(i.ToString());
   });
}
// Обработает только первое исключение
// Остальные потеряются
catch (Exception ex)
{
  // Выведет случайное число от 1 до 10,
  // в зависимости от порядка обработки
  Console.WriteLine(ex.ToString());
}

Если вы хотите получить все исключения, необходимо использовать Task.Exceptions или метод, предоставляющий содержимое этого метода, например Task.Wait.

try
{
  await Parallel.ForEachAsync(
   Enumerable.Range(1, 10), 
   async (i, _) =>
   {
     throw new Exception(i.ToString());
   }).WithAggregateException();
}
catch (Exception ex)
{
  // Выведет все исключения, 
  // т.к. ex - это AggregateException
  Console.WriteLine(ex.ToString());
}

internal static class TaskExtensions
{
  public static async Task
   WithAggregateException(this Task task)
  {
    // Отключаем выброс исключений,
    // Они будут обработаны в task.Wait()
    await task.ConfigureAwait(
     ConfigureAwaitOptions.SuppressThrowing);

    // Задача уже выполнена, поэтому Wait только
    // выбросит AggregateException при ошибке
    task.Wait();
  }
}

Заметьте, что Parallel.ForEachAsync прекращает обработку элементов из коллекции после выброса первого исключения. Он ожидает завершения текущих задач, а затем сообщает об исключениях. Количество выполненных задач будет зависеть от количества параллельно выполняемых операций. Например, если задать для Parallel.ForEachAsync опцию

var options = new ParallelOptions() { 
 MaxDegreeOfParallelism = 3 
};

то будут выполнены только 3 задачи.
Чтобы этого избежать, можно внутри задачи сохранять выброшенные исключения:

var exceptions = new ConcurrentBag<Exception>();
await Parallel.ForEachAsync(
 Enumerable.Range(1, 10), 
 async (i, _) =>
 {
   try
   {
     throw new Exception(i.ToString());
   }
   catch (Exception ex)
   {
     exceptions.Add(ex);
   }
 });

if (!exceptions.IsEmpty)
  throw new AggregateException(exceptions);

Источник: https://www.meziantou.net/getting-all-exceptions-thrown-from-parallel-foreachasync.htm

День 1857. #Холивар
Возник у нас тут небольшой спор с Кириллом, автором канала C# Heppard (кстати, подписывайтесь). Кирилл пишет:

«Я всегда вспоминаю один диалог. Состоялся он, ох, уж сколько лет прошло, на одном локальном митапе. Я, как всегда, вещал про то, что было бы неплохо писать оптимальный код, в том смысле, чтобы экономить байтики и наносекунды. То да сё, слайды, смешки, лёгкое непонимание в глазах слушателей. Наконец, секция вопросов и ответов.

Я хорошо помню этого мужика, который во время доклада делал фейс-палмы, громко ёрзал стулом, сидел в телефоне. Я ждал вопросов от него и дождался.

- Скажите, а зачем всё это?
- В смысле, - не понимаю я.
- В том смысле, - сказал он авторитетно, - что это всё не нужно. Проще купить плашку в 16 ГБ памяти, чем всё это знать.»

И ещё несколько лет назад, я бы тоже посмеялся над мужиком. А тут… В общем, не знаю почему, но решил я выступить адвокатом дьявола)))

Тут надо оговориться, что Кирилл в основном занимается оптимизациями, а я всё-таки фуллстек, и экономия байтиков и наносекунд для меня скорей теоретическая область и «чисто по фану». То есть, я практически этим не занимаюсь, т.к. в моей практике я чаще оптимизирую запросы к БД или UI в браузере. Но…

В принципе, мужик не так уж и не прав. Понятно, что нет серебряной пули, и у всех ситуации разные. Но, как мне кажется, в довольно приличном количестве случаев апгрейд железа – действительно выход. Понятно, что мы - программисты, мы все любим чистый и быстрый код. Хлебом нас не корми, дай реализовать свой супербыстрый и эффективный по памяти вариант сортировки или словаря.

Но давайте перенесёмся на самый высокий уровень – уровень бизнеса. Как говорит Марк Симан: «Не забывайте, что в конечном итоге, вы делаете продукт, который должен решать задачи бизнеса». Так вот, с точки зрения бизнеса, оптимизировать алгоритм или докупить памяти – разницы нет. Всё выражается в деньгах. Надо заплатить за одно или за другое. Если ПМ, техлид или другой менеджер этого уровня прикинет, как говорится, писю к носу, и сравнит, сколько денег будет стоить апгрейд железа, и сколько примерно надо потратить человекочасов (умноженных на часовую ставку программистов) на оптимизацию, то вполне может оказаться, что «докупить плашку памяти» просто выгоднее для бизнеса (по крайней мере, на ближайшую перспективу).

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

В общем, давайте обсудим. Что думаете? Апгрейд железа может быть опцией? Бывали ли у вас в практике такие случаи?

День 1858. #Шпаргалка
Примеры Кода для Повседневных Задач
В этой серии представлю вам коллекцию фрагментов кода C#, охватывающих широкий спектр сценариев, с которыми вы можете столкнуться при разработке ПО.

IV. Потоки
Многопоточная обработка — важный аспект параллельного программирования на C#. Рассмотрим, как работать с потоками, используя пространство имен System.Threading.

1. Создание нового потока
Чтобы создать новый поток в C#, вы можете использовать класс Thread:

using System.Threading;

void PrintNumbers()
{
  for (int i = 1; i <= 5; i++)
    Console.WriteLine(i);
}

var thread = new Thread(PrintNumbers);

2. Операции над потоком
- Запуск

thread.Start();

- Слияние (ожидание завершения потока)

thread.Join();

- Приостановка (текущий поток)

Thread.Sleep(1000); // пауза на 1 секунду

См. подробнее о потоках

3. Использование пула потоков
Для работы с пулом потоков используется класс ThreadPool:

using System.Threading;

ThreadPool.QueueUserWorkItem(PrintNumbers);

См. подробнее о пуле потоков

V. Задачи
1. Создание новой задачи
Для создания и запуска задачи используется класс Task:

using System.Threading.Tasks;

Task.Run(PrintNumbers);

См. подробнее о задачах

2. Ожидание задачи

var task = Task.Run(PrintNumbers);
task.Wait();

3. Отмена задачи
Для отмены задачи в C# используется класс CancellationTokenSource, создающий токен отмены. А для собственно отмены – метод токена Cancel():

using System.Threading;
using System.Threading.Tasks;

var cts = new CancellationTokenSource();
Task.Run(() => PrintNumbers(), cts.Token);
cts.Cancel();

См. подробнее «Скоординированная отмена»

Источник: https://medium.com/bytehide/100-csharp-code-snippets-for-everyday-problems-e913c786dec9

День 1859. #ЗаметкиНаПолях
Как Принудить Запускать Приложение от Имени Администратора
Чтобы заставить приложение запускаться в Windows от имени администратора, нужно добавить и изменить файл манифеста приложения. Манифест приложения — это XML-файл, который предоставляет информацию о приложении операционной системе.

Начнем с создания консольного приложения:

dotnet new console -n AdministratorApp

После этого в свойствах проекта добавим целевую ОС Windows.

<TargetFramework>net8.0-windows</TargetFramework>

Также нужно включить в проект файл app.manifest. В Visual Studio это можно сделать, щелкнув правой кнопкой мыши проект, выбрав Add > New Element… (Добавить > Новый элемент…). В появившемся окне найти Application Manifest file (Windows only) (Файл Манифеста приложения (только Windows)).

В файле app.manifest измените:

<requestedExecutionLevel level="asInvoker" uiAccess="false" />

на:

<requestedExecutionLevel level="requireAdministrator" uiAccess="false" />

Это заставит приложение требовать административных привилегий.

Теперь проверим административные привилегии в файле Program.cs:

using System.Security.Principal;

var p = new WindowsPrincipal(
     WindowsIdentity.GetCurrent());

if (p.IsInRole(WindowsBuiltInRole.Administrator))
  Console.WriteLine("Admin mode");
else
  Console.WriteLine("Not Admin mode");

Класс WindowsIdentity представляет личность пользователя Windows. WindowsIdentity.GetCurrent() получает личность пользователя, исполняющего текущий процесс, т.е. пользователя, запустившего приложение.
Объект WindowsPrincipal создаётся на основании WindowsIdentity и представляет собой контекст безопасности пользователя, что позволяет проверить его роль.

Теперь можно запустить приложение. В зависимости от ваших настроек Windows, вам либо будет предложено повысить привилегии и запустить приложение от имени администратора, либо приложение будет запущено, но выдаст ошибку:
Unhandled exception: System.ComponentModel.Win32Exception (740):
An error occurred trying to start process
'C:\...\AdministratorApp.exe' ….
The requested operation requires elevation.

Возникает исключение System.ComponentModel.Win32Exception с кодом ошибки 740 «Запрошенная операция требует повышения прав». Подразумевается, что мы можем запускать наше приложение только с правами администратора.

Если запустить приложение от имени администратора, мы увидим в консоли вывод:

Admin mode

Источник: https://code-maze.com/csharp-how-to-force-run-net-application-as-administrator/

День 1860. #ЗаметкиНаПолях
Используем HttpContext.Items для Передачи Данных в ASP.NET Core
HttpContext.Items — это словарь, к которому может получить доступ каждый компонент, участвующий в обработке HTTP-запроса. В отличие от HttpContext.Session, данные, сохранённые в HttpContext.Items, не сохраняются между запросами. Это изолирует данные и гарантирует, что они не будут мешать другим одновременным запросам.

В большинстве веб-приложений компонентам часто необходимо взаимодействовать друг с другом. Для этого должна быть организована передача параметров или общее состояние. Но это имеет определённые недостатки и проблемы: проблемы параллелизма, нарушение целостности данных, жёсткая связанность, издержки производительности и т. д.

HttpContext.Items позволяет промежуточному ПО, фильтрам и контроллерам обмениваться данными без прямой связи при их выполнении на разных этапах жизненного цикла запроса. Можно использовать любой тип данных для ключа. Однако, когда мы используем ключ строкового типа, мы рискуем столкнуться с коллизией ключей. Лучшая альтернатива — использовать объект в качестве ключа элемента.

Посмотрим, как использовать это в приложении веб-API ASP.NET Core.
1. Промежуточное ПО

public class CustomMW
{
  private RequestDelegate _next;
  public static readonly object MWKey = new();
  public CustomMW(RequestDelegate next)
  {
    _next = next;
  }
  public async Task Invoke(HttpContext ctx)
  {
    ctx.Items[MWKey] = "MW";
    await _next(ctx);
  }
}

Мы создаём новый экземпляр объекта для ключа MWKey. В методе Invoke() устанавливаем значение в словаре HttpContext.Items.

В Program.cs используем наше промежуточное ПО:

…
app.UseMiddleware<CustomMiddleware>();
app.Run()

2. Фильтр

public class CustomFilter : IActionFilter
{
  public static readonly object 
   FilterKey = new();
   …
  public void OnActionExecuting(
   ActionExecutingContext ctx)
  {
    ctx.HttpContext.Items[FilterKey] = "Loading…";
    …
  }
  public void OnActionExecuted(
   ActionExecutedContext ctx) {
    ctx.HttpContext.Items[FilterKey] = "Loaded.";
    …
  }
  …
}

Зарегистрируем фильтр в сервисах:

builder.Services.AddScoped<CustomFilter>();

3. В контроллере

[ServiceFilter(typeof(CustomFilter))]
public IEnumerable<Item> Get()
{
  HttpContext.Items.TryGetValue(
   CustomMW.MWKey, out var mwValue);
  …
}

Внутри метода контроллера мы используем TryGetValue() для получения значения, установленного в промежуточном ПО по ключу MWKey.

Итого
HttpContext.Items позволяет эффективно использовать данные между компонентами обработки запроса и автоматически удаляет сохранённые данные после завершения запроса.
Полный код примера на GitHub.

Источник: https://code-maze.com/aspnetcore-httpcontext-items-pass-data/

День 1861. #ВопросыНаСобеседовании #Многопоточность
Самые часто задаваемые вопросы на собеседовании по C#

29. Какие потенциальные проблемы могут возникнуть при использовании Thread.Abort() для завершения работающего потока? Объясните последствия и предложите альтернативные методы корректной остановки потока.

Использование Thread.Abort() для завершения работающего потока может привести к нескольким потенциальным проблемам:
1. Непредсказуемое состояние.
Thread.Abort() вызывает исключение ThreadAbortException, которое немедленно прерывает поток, потенциально оставляя общие ресурсы, структуры данных или критические разделы в несогласованном состоянии.
2. Утечки ресурсов.
Если прерванный поток выделил ресурсы, такие как дескрипторы, файловые потоки или соединения с базой данных, они могут не быть освобождены, что приведёт к утечке ресурсов.
3. Взаимные блокировки.
Прерванные потоки, удерживающие блокировки или другие примитивы синхронизации, могут не иметь возможности их освободить, что приводит к взаимоблокировкам в других потоках.
4. Обработка ThreadAbortException.
Если поток перехватывает ThreadAbortException и игнорирует его, запрос на прерывание завершится неудачно, и поток продолжит выполнение.
5. Устарело и больше не поддерживается.
Метод Thread.Abort() не поддерживается в .NET Core, .NET 5 и более поздних версиях, что указывает на то, что его не следует использовать в современных приложениях.

Чтобы корректно остановить поток, есть следующие альтернативы.

1. Общий флаг
Добавим логический флаг, который будет периодически проверяться выполняемым потоком. Если флаг установлен в true, поток должен завершиться. Обязательно использовать ключевое слово volatile или класс Interlocked, чтобы обеспечить правильную синхронизацию:

volatile bool stopRequested = false;
var thread = new Thread(() => {
  while (!stopRequested)
  {
    // выполняем работу
    // ...
  }
});

// Останавливаем поток
stopRequested = true;

2. Токен отмены
Если использовать задачи вместо потоков, библиотека параллельных задач (TPL) предоставляет модель отмены с использованием токена отмены:

var cts = new CancellationTokenSource();
var task = Task.Run(() =>
{
  while (!cts.IsCancellationRequested)
  {
    // Выполняем работу
    // ...
  }
});

// Останавливаем задачу
cts.Cancel();

Грамотная остановка потоков с помощью этих методов гарантирует освобождение ресурсов, правильное управление блокировками и сохранение согласованного состояния общих данных. Она также совместима с современными версиями .NET и TPL.

Источник: https://dev.to/bytehide/c-multithreading-interview-questions-and-answers-4opj

День 1862. #ЗаметкиНаПолях
REST vs RESTful. В чём Разница? Начало
REST API — один из самых популярных API в сообществе веб-разработчиков. В чем разница между REST API и RESTful API?

Короткий ответ: REST - REpresentational State Transfer (Передача Репрезентативного Состояния). Это архитектурный шаблон для создания веб-сервисов. RESTful-сервис реализует этот шаблон.

Длинный ответ начинается со слов «вроде как» и «это зависит» и продолжается более полными определениями.

REST
Для некоторых REST – это обмен JSON-данными между клиентом и сервером. Это не только не полное определение, но и не всегда верное. Спецификация REST не требует HTTP или JSON, JSON или XML там даже не упоминаются.

Рой Филдинг представил архитектурный шаблон REST в своей диссертации в 2000 году. Там описывается метод облегчения обмена данными приложений между клиентами и серверами. Ключевой особенностью является то, что от клиента не требуется никаких предварительных знаний о приложении. Филдинг не предъявляет особых требований. Вместо этого он определяет REST в отношении ограничений и архитектурных элементов.

Архитектурные ограничения REST
1. Клиент-сервер
REST-сервисы имеют сервер, который управляет данными и состоянием приложения. Сервер взаимодействует с клиентом, который обрабатывает взаимодействие с пользователем. Чёткое разделение задач сервера и клиента означает, что вы можете обновлять и улучшать их независимо.

2. Нет сохранения состояния
Сервер не поддерживает состояние клиента. Клиенты управляют состоянием своего приложения. Их запросы к серверу содержат всю информацию, необходимую для их обработки.

3. Кэш
Сервер должен помечать свои ответы как кэшируемые или нет. Так инфраструктура и клиент могут кэшировать ответы, когда это возможно, для повышения производительности. Некэшируемая информация может удаляться, так что ни один клиент не будет использовать устаревшие данные.

4. Единый интерфейс
Филдинг говорит: «Главной особенностью, которая отличает архитектурный стиль REST от других сетевых стилей, является акцент на единообразном интерфейсе между компонентами». REST-сервисы предоставляют данные в виде ресурсов с согласованным пространством имён.

5. Многоуровневая система
Компоненты системы не могут «видеть» ничего за пределами своего уровня. Так вы можете легко добавить балансировщики нагрузки и прокси-серверы для повышения безопасности или производительности.

RESTful-сервис — это больше, чем веб-сервер, который обменивается JSON или любыми другими форматами данных. Вместе приведённые выше ограничения создают очень специфический тип приложения.

Применение ограничений
Клиент-серверность, многоуровневость системы и ограничение на несохранение состояния образуют приложение с чёткими границами и чётким разделением задач. По запросу данные передаются с сервера клиенту, где они отображаются или обрабатываются. Если необходимы какие-либо изменения в состоянии, клиент отправляет изменённые данные обратно на сервер для хранения. В REST и клиент, и сервер обладают общими знаниями о данных и их состоянии. Архитектура не скрывает данные, она лишь скрывает реализацию. Данные приложения доступны клиентам в понятном и согласованном интерфейсе и, по возможности, кэшируются.

Окончание следует…

Источник: https://blog.ndepend.com/rest-vs-restful/

День 1863. #ЗаметкиНаПолях
REST vs RESTful. В чём Разница? Окончание
Начало

RPC через HTTP vs RESTful
Часто говорят, что сервис «не REST», из-за неправильных URI или использования глаголов HTTP. Имеется в виду представление данных REST как единообразного набора ресурсов.

Это различие иногда формулируется как различие между вызовами удаленных процедур (RPC) и REST. Представьте себе веб-сервис для перечисления, добавления и удаления товаров онлайн-магазина.

В одной версии есть один URL, который мы запрашиваем с помощью HTTP GET или POST. Вы взаимодействуете с сервисом, отправляя данные POST, содержащие то, что вы хотите сделать. Например, добавить элемент с помощью NewItem:

POST /inventory HTTP/1.1
{
  "NewItem": {
    "name": "new item",
    "price": "9.99",
    "id": "1001"
  }
}

Запросить через POST и ItemRequest:

POST /inventory HTTP/1.1
{
  "ItemRequest": {
    "id": "1001"
  }
}

Некоторые реализации также допускают запросы через GET-параметры:

POST /inventory?id=1001 HTTP/1.1

И т.п.

Это не REST. Мы не обмениваемся состоянием ресурсов. Мы вызываем функцию с аргументами, которые находятся в документе JSON или параметрая URL.

RESTful-сервис имеет URI для каждого ресурса. Поэтому добавление нового товара будет выглядеть так же, как в примере выше. Но на этом сходства заканчиваются.
Запрос элемента – это всегда GET:

GET /item/1001 HTTP/1.1

Удаление - DELETE:

DELETE /item/1001 HTTP/1.1

Изменение - PUT:

PUT /inventory HTTP/1.1
{
  "Item": {
   "name": "new item",
   "price": "7.99",
   "id": "1001"
  }
}

Разница важна. В REST операции используют различные глаголы HTTP, которые соответствуют действиям с данными: GET, POST, PUT, DELETE и PATCH имеют определённые контракты. Большинство хорошо спроектированных REST API также возвращают определённые коды HTTP в зависимости от результата запроса. Основным различием является то, что URI соответствуют данным, а не удалёнными методам.

REST против RESTful и модель зрелости Ричардсона
Разработка URI в соответствии с ресурсами и использование глаголов HTTP способствует предсказуемости API. Когда разработчики поймут, как вы структурировали ресурсы, они смогут сделать обоснованные прогнозы относительно структуры API. В этом смысле основное внимание уделяется пониманию самих данных, а не связанных с ними операций.

Но даже если вы не можете сделать API полностью предсказуемым, вы можете документировать любой REST-сервис с помощью HATEOAS. Тогда каждый элемент, возвращаемый сервером, будет содержать ссылки для удаления или изменения ресурса.

Многие сайты не соответствуют этому требованию, но по-прежнему называются REST. Леонард Ричардсон создал модель уровней зрелости REST:
0 – API через HTTP с вызовом удалённых методов с аргументами.
1 – Использование ресурсов вместо методов.
2 – Правильное использование HTTP-глаголов.
3 – Использование HATEOAS, что делает видимым весь API или его часть.
По Филдингу требуется третий уровень, так что большинство приложений не являются REST.

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

Архитектурный шаблон REST имеет множество преимуществ. Филдинг разработал его для Интернета, и 18 лет спустя большинство ограничений, которые он добавил, все ещё с нами. В 2000 году у нас не было Android или iPhone, а IE5 занимал 50% рынка браузеров. Но Филдинг понимал, что нужно онлайн-приложениям и как веб-клиенты будут развиваться от механизмов отображения HTML в полноценные приложения. Инструменты, которые мы используем сегодня, адаптированы к REST, а не наоборот.

Модель зрелости Ричардсона — хорошее руководство для разработки приложений. Желательно находиться на втором уровне модели и посмотреть, как третий уровень может улучшить ваш дизайн.

Источник: https://blog.ndepend.com/rest-vs-restful/

День 1864. #ЗаметкиНаПолях
Необязательные Параметры Могут Быть в Середине
В .NET необязательные параметры не всегда должны быть последними параметрами в сигнатуре метода. Хотя C# не позволяет объявлять необязательные параметры в середине, это можно сделать в IL или других языках, таких как VB.NET или F#. Кроме того, компилятор может создавать методы с необязательными параметрами в середине списка параметров.

Почему это имеет значение? Если вы пишете генератор исходного кода, который генерирует новые методы с теми же параметрами, что и другой метод, вам может потребоваться сгенерировать методы с необязательными параметрами в середине списка параметров. Хотя это довольно редкий случай, это допустимо в .NET и может быть полезно в некоторых сценариях.

Чтобы лучше понять суть вопроса, начнём с простого примера. Следующий код недопустим в C#:

// CS1737 Optional parameters must appear after all required parameters
void Sample(int a = 1, int b)
{
}

При компиляции метода с необязательными параметрами компилятор заменяет синтаксис C# двумя атрибутами: [Optional] и [DefaultParameterValue]. Атрибут [Optional] используется для пометки параметра как необязательного, а атрибут [DefaultParameterValue] используется для установки значения по умолчанию. Следующий код допустим в C#:

// Вывод: 42
Sample(b: 2);

// Объявляем "a" как необязательный 
// со значением 40 по умолчанию
void Sample(
 [Optional, DefaultParameterValue(40)]
 int a, 
 int b)
{
  Console.WriteLine(a + b);
}

Обратите внимание, что компилятор C# более строг, чем в других языках, в отношении допустимых значений в [DefaultParameterValue]. Он гарантирует, что тип значения совпадает с типом параметра, но может не допускать некоторых допустимых преобразований. Например, следующий код будет допустим в VB.NET или F#, но не в C#:

// CS1908 The type of the argument to the DefaultParameterValue attribute must match the parameter type
void Sample(
 [Optional, DefaultParameterValue(default)] 
 CancellationToken cancellationToken)
{
}

Тот же метод в F# допустим:

type Class1 =
  static member Sample(
   [<Optional; DefaultParameterValue(CancellationToken())>]
   ct: CancellationToken) = ()

Кстати: даже компилятор C# может сгенерировать метод с необязательными параметрами в середине списка параметров. При создании индексатора с необязательными параметрами компилятор генерирует метод с необязательным параметром в середине:

// Создаёт метод (set_Item) с необязательным параметром в середине
// int set_Item(int a, int b = 2, int value)
public int this[int a, int b = 2]
{
  set { }
}

Источник: https://www.meziantou.net/optional-parameters.htm

День 1865. #ЗаметкиНаПолях
Безопасность Типов в xUnit с Помощью TheoryData<T>
В xUnit есть небольшая, но очень полезная особенность – класс TheoryData<T>.

Проблема
Имеем следующий код тестов репозитория:

public static IEnumerable<object[]> 
 Data => new List<object[]>
{
  new object[] { 
   new Action<IServiceCollection>(
    s => s.UseSqliteAsStorageProvider()) 
   },
  new object[] { 
   new Action<IServiceCollection>(
    s => s.UseSqlAsStorageProvider())
  },
  new object[] { 
   new Action<IServiceCollection>(
    s => s.UseInMemoryAsStorageProvider()) 
  }
};

[Theory]
[MemberData(nameof(Data))]
public void TestStorageProvider(
 Action<IServiceCollection> act)
{ … }

Проблема здесь в том, что данные имеют тип IEnumerable<object[]>, а параметр act — тип Action<IServiceCollection>. То есть теоретически можно передать в метод что угодно, и компилятор с радостью это примет. Вот тут-то и пригодится TheoryData<T>.

Решение
TheoryData<T> — это класс, который позволяет обертывать данные строго типизированным способом. Например:

public static TheoryData<Action<IServiceCollection>> 
 Data => new() 
{
  s => s.UseSqliteAsStorageProvider(),
  s => s.UseSqlAsStorageProvider(),
  s => s.UseInMemoryAsStorageProvider()
};

[Theory]
[MemberData(nameof(Data))]
public void TestStorageProvider(
 Action<IServiceCollection> act)
{ … }

Точно такой же тест, но более типобезопасный. Теперь компилятор не позволит передать в метод ничего, кроме Action<IServiceCollection>.

Источник: https://steven-giesel.com/blogPost/a8aa3385-8829-444a-b269-7ecb38aeaf2f/typesafety-in-xunit-with-theorydatat

День 1866. #ЗаметкиНаПолях
Определяем Разные Строковые Представления Объекта
Даже если внутренние данные одинаковы, иногда их можно представить по-разному. Взять структуру DateTime. Используя разные модификаторы, вы можете представлять одну и ту же дату в разных форматах.

var dt = new DateTime(2024, 1, 1, 8, 53, 14);
dt.ToString("yyyy-MM-dddd"); //2024-01-Monday
dt.ToString("Y"); //January 2024

Одна дата, но написана по-разному. Также можно предоставить культуру:

var it = new CultureInfo("it-IT");
dt.ToString("yyyy-MM-dddd", it); //2024-01-lunedì

Интерфейс IFormattable позволяет определить такое поведение в наших классах, переопределив метод ToString(). Например:

public class Person : IFormattable
{
  public string FirstName { get; set; }
  public string LastName { get; set; }
  public DateTime BirthDate { get; set; }

  public string ToString(
   string? format, 
   IFormatProvider? fp)
  {
    // Здесь определяем логику форматирования
  }
}

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

public class Person : IFormattable
{
  …
  public static class Formats
  {
    public const string FirstAndLastName = "FL";
    public const string Mini = "Mini";
    public const string Full = "Full";
  }
}

Наконец, реализуем ToString() с нашими форматами и случаем, когда формат не распознается:

public string ToString(
 string? format,
 IFormatProvider? fp)
{
  switch (format)
  {
    case Formats.FirstAndLastName:
      return $"{FirstName} {LastName}";
    case Formats.Full:
    {
      FormattableString fs = 
       $"{FirstName} {LastName} ({BirthDate:D})";
      return fs.ToString(fp);
    }
    case Formats.Mini:
      return $"{FirstName[0]}.{LastName[0]}";
    default:
      return this.ToString();
  }
}

Заметьте, что в случае Formats.Full мы используем FormattableString, чтобы применить параметр IFormatProvider к конечному результату.

Тестируем

var p = new Person
{
  FirstName = "Albert",
  LastName = "Einstein",
  BirthDate = new DateTime(1879, 3, 14)
};

p.ToString(Person.Formats.FirstAndLastName, it);
//Albert Einstein
p.ToString(Person.Formats.Full, it);
//Albert Einstein (venerdì 14 marzo 1879)
p.ToString(Person.Formats.Full, null);
//Albert Einstein (Friday, March 14, 1879)
p.ToString("INVALID FORMAT", CultureInfo.InvariantCulture);
//Person
$"I am not {p:Full}";
//I am not Albert Einstein (Friday, March 14, 1879)

Источник: https://www.code4it.dev/csharptips/iformattable-interface/

День 1867. #BestPractices
Избегайте Нескольких Булевых Параметров
Булевы параметры хороши, но сложно отследить, что делает каждый из них, если их несколько. Сегодня посмотрим, почему лучше избегать использования нескольких булевых параметров и как это отрефакторить.

Почему это плохо?
Посмотрим на следующий метод:

/// <summary>
/// Refreshes the control.
/// </summary>
/// <param name="force">Forces a refresh even if the renderer is suspended.</param>
/// <param name="lazy">Refreshes the control only if a set amount of time
/// has passed since the last refresh.</param>
void Refresh(bool force, bool lazy);

Это пример из библиотеки компонентов ImageListView. Проблема здесь в том, что два логических параметра обозначают четыре разные комбинации значений:

Refresh(true, true); 
Refresh(true, false);
Refresh(false, true);
Refresh(false, false);

И в некоторой степени вы ожидаете четырёх разных вариантов поведения. Но в реализации это не так:

internal void Refresh(bool force, bool lazy)
{
    if (force)
        base.Refresh();
    else if (lazy)
    {
        rendererNeedsPaint = true;
        lazyRefreshTimer.Start();
    }
    else if (CanPaint())
        base.Refresh();
    else
        rendererNeedsPaint = true;
}

Разрешены только определённые комбинации. Кроме того, «сила» и «ленивость» кажутся в этом контексте противоречивыми. Трудно запомнить, что делает каждая комбинация. Можно сказать, что это в некоторой степени нарушает «принцип единой ответственности», поскольку метод выполняет несколько задач.

Другой частый пример: есть уже существующий метод, и какой-то новый метод должен расширить/изменить его поведение. Для простоты предположим, что нужна сортировка. Самый простой способ — добавить булев параметр:

IEnumerable<Item> GetItems(Filter f);
IEnumerable <Item> GetItems(Filter f, bool sort);
// или ещё хуже:
IEnumerable <Item> GetItems(Filter f, bool sort, bool descending);

Проблема здесь – понять, что происходит. И чем больше параметров, тем больше комбинаций и тем сложнее понять метод.

Рефакторинг
1. Сделать каждую комбинацию отдельным методом
Так все варианты очевидны, и вы можете использовать более выразительное имя метода. Из примера выше:

void Refresh();
void RefreshForce();
void RefreshLazy();

Теперь ясно, что недопустимо использовать оба параметра сразу. При этом мы возлагаем на вызывающую сторону ответственность за решение, какой метод вызывать. Клиент знает, что он хочет сделать, и может выразить это более чётко. Внутри эти методы, безусловно, могут совместно использовать большую часть кода. Кроме того, если нужно изменить поведение одного из методов, это гораздо проще сделать, поскольку между ними меньше связи.

Замечание: надо различать общедоступный API и закрытые методы. Можно иметь несколько булевых параметров в закрытых методах, но надо стараться избегать их в публичных API. Публичный API - интерфейс с внешним миром и должен быть максимально понятным.

2. Использовать перечисления с возможными вариантами

enum RefreshMode { Default, Force, Lazy }

void Refresh(RefreshMode mode);

Хотя здесь показаны все возможные варианты, это не так ясно, как предыдущий подход. Все ещё возможно, что метод делает слишком много. Здесь всегда компромисс между слишком большим количеством параметров и слишком большим количеством методов.

Источник: https://steven-giesel.com/blogPost/9994b00c-8bc2-4794-ae74-80e6ee4cd5e5/avoid-multiple-boolean-parameters

День 1868. #Шпаргалка #Git
Популярные Настройки Git Config. Начало
Джулия Эванс спросила у коллег-программистов мнения о самых популярных и полезных настройках Git, которые они используют. Вот такой список получился.

Описание всех настроек можно найти в документации Git.

1. pull.ff only или pull.rebase true
Эти две были самыми популярными. Обе они преследуют схожие цели: избежать случайного создания коммита слияния при запуске git pull на ветке, где восходящая ветвь расходится.
- pull.rebase true эквивалентен запуску git pull --rebase каждый раз,
- pull.ff only эквивалентен запуску git pull --ff-only каждый раз.
Скорее всего, нет смысла устанавливать обе одновременно, поскольку --ff-only переопределяет --rebase.

2. merge.conflictstyle zdiff3
Делаем конфликты слияний более читабельными!
По умолчанию в git конфликты слияния выглядят так:

<<<<<<< HEAD
def parse(input):
    return input.split("\n")
=======
def parse(text):
    return text.split("\n\n")
>>>>>>> somebranch

Вам предлагается решить, что лучше: input.split("\n") или text.split("\n\n"). Но как? Что делать, если вы не помните, нужно \n или \n\n?
Вот как выглядит тот же конфликт слияния с merge.conflictstyle diff3:

<<<<<<< HEAD
def parse(input):
    return input.split("\n")
||||||| base
def parse(input):
    return input.split("\n\n")
=======
def parse(text):
    return text.split("\n\n")
>>>>>>> somebranch

Здесь содержится дополнительная информация: теперь исходная версия кода находится посередине! Итак, мы видим:
- одна сторона изменила \n\n на \n,
- другая сторона переименовала input в text.
Поэтому, по-видимому, правильным решением конфликта слияния является return text.split("\n"), поскольку он объединяет изменения с обеих сторон.
zdiff3 — это тот же diff3, но он лучше выносит любые общие строки в начале или конце за пределы зоны конфликта. То есть, если обе стороны сделали изменения, которые имеют общие строки в начале или в конце, то они будут корректно слиты и не будут входить в зону конфликта.

3. rebase.autosquash true
Цель autosquash — упростить модификацию старых коммитов. Допустим, у вас есть коммит с исправлением другого коммита (3 коммита назад), который вы хотели бы объединить с ним. Вы фиксируете новый коммит с помощью git commit --fixup OLD_COMMIT_ID, что даёт новому коммиту сообщение «fixup! …».
Теперь, когда вы запускаете git rebase --autosquash main, он автоматически объединяет все коммиты-исправления (fixup!) со своими целями.
rebase.autosquash true означает, что --autosquash всегда автоматически передаётся в git rebase.

4. rebase.autostash true
Это автоматически запускает git stash перед git rebase и git stash pop после. По сути, он передаёт --autostash в git rebase. Это означает, что вы можете запустить rebase на «грязном» рабочем дереве. Однако будьте осторожны: применение изменений из stash после успешного перебазирования может привести к нетривиальным конфликтам. Хотя, похоже, это не очень часто встречается у людей, поскольку этот вариант конфигурации кажется действительно популярным.

Продолжение следует…

Источник: https://jvns.ca/blog/2024/02/16/popular-git-config-options/