Microservice-Template

Nimble Framework

Внимание! Пожалуйста, ознакомьтесь со всеми комментариями с надписью “ATTENTION!”, потому что эти места потребуют от вас некоторых решений и/или действий.

Attention! Please find out all comments with ‘ATTENTION!’ because that is required some decisions or actions from you.

Как установить

Для установки версии 8.x пожалуйста прочитайте статью wiki, в которой описано как очень просто установить шаблоны при помощи одной команды из командной строки на ваш рабочий компьютер. Также вы можете использовать расширение для Visual Studio Microservice-Template из marketplace.

How to install

To install version 8.x please, read wiki where you can find information about a simple way using one command in command prompt to install templates on your workstation. Another way to install extension is use Visual Studio marketplace Microservice-Template.

Дополнительная информация (Additional info)

На сайте разработчика.
Видео презентация новой версии Nimble Framework v.6.

История Nimble Framework

2024-02-06 Версия 8.0.1

Вместо nuget-пакета OperationResultCoreв обоих шаблонах теперь используется более простая и современная реализация RFC7807 - Calabonga.Results, которая существенно “облегчила” сериализацию выдаваемых результатов повысив параметры производительности в несколько раз.

Сборка OperationResultCore удалена из обоих шаблонов.
Сборка Calabonga.Results установлена из обоих шаблонов.
Обновились nuget-пакеты
Удалены ненужные архивы старых версий на платформах ниже версии 8.x.
Удалены артефакты, которые позволяли генерировать шаблоны без использования template-проектов.

2023-11-20 Версия 8.0.0

Новая и первая версия шаблонов для микросервисов на платформе NET8.

Install module

Произведен некоторый рефакторинг папок и, соответственно, namespace в шаблонах, чтобы соблюсти договоренности о именованиях.
Обновлены nuget-пакеты
IdentityModule: добавлена возможно авторизации и по Bearer вдобавок к Cookie.
IdentityModule: добавлена PolicyCorsName и PolicyDefaultName
IdentityModule и Module: обновлена реализация EventItemEndpoints и ProfilesEndpoints чтобы можно было использовать Endpoint Explorer для генерации .http файлов для вызова методов прямо из Visual Studio:
Подключена сборка Microsoft.AspNetCore.OpenApi для полноценной реализации OpenApi. Удалены ненужные зависимости.
Произведены другие мелкие правки, в том числе синтаксические.

2023-09-24 Версия 7.0.8:

Из репозитория удалены исходные файлы для NET 5, а также готовые архивы для использования NET 5.
Обновлены nuget-пакеты
Небольшие правки по оптимизации appSettings.json для develop и production развертывания.
Добавлена обязательная проверка возможных NullReferenceException в файл проекта для каждого из шаблонов. ``` diff
- net7.0
- enable
- enable
- </PropertyGroup>
- net7.0
- enable
- enable
- true
- enable
- </PropertyGroup> ```

Обновлена конфигурация .editor.config.

  +[*.json]
  +
  +indent_size = 4
  +indent_style = space
  +tab_width = 4

  # C# files
  [*.cs]
  @@ -218,10 +223,15 @@ dotnet_naming_style.instance_field_style.required_prefix = _

  # ReSharper properties
  max_line_length = 200
  +resharper_arguments_anonymous_function = named
  +resharper_blank_lines_after_multiline_statements = 1
  +resharper_blank_lines_before_control_transfer_statements = 1
  +resharper_csharp_keep_blank_lines_in_code = 1
  resharper_csharp_max_line_length = 200
  resharper_csharp_wrap_after_declaration_lpar = true
  resharper_csharp_wrap_extends_list_style = chop_if_long
  resharper_csharp_wrap_lines = false
  +resharper_instance_members_qualify_declared_in = base_class
  resharper_max_attribute_length_for_same_line = 300
  resharper_place_type_constraints_on_same_line = true
  resharper_wrap_before_arrow_with_expressions = true

2023-08-07 Версия 7.0.7

Сделан рефакторинг папок в проектах с целью добиться максимального соответствия концепции Clean Architecture, и в частности Vertical Slice Architecture. Выпущена
Обновлены nuget-пакеты некоторых базовых сборок
Исправлены мелкие недочеты (naming convention, syntax issies, etc.)

2023-08-04 Версия 7.0.6

Созданы шаблоны для dotnet CLI. Теперь можно установить шаблоны очень просто через команду dotnet. Например, чтобы установить шаблон для Microservice Identity Module достаточно выполнить команду:

dotnet new install Calabonga.Microservice.IdentityModule.Template

Install identity module

А для установки Microservice Module нужно такую команду:

dotnet new install Calabonga.Microservice.Module.Template

Install module

Проверить установлены ли шаблоны можно командой

dotnet new list

Команда выведет список всех установленных шаблонов:

template list

Также после установки шаблонов, они станут доступы в Visual Studio и JetBrains Rider.

Visual Studio

Visual Studio create new project screen

JetBrains Rider

JetBrains Rider create new project screen

2023-06-15 Версия 7.0.5

Обновлены nuget-пакеты
Немного изменена структура классов для наследников от IRequest и IRequestHandler. Теперь запросы с перехватчиками объединены в один класс, что на самом деле гораздо удобнее.
Поправлены некоторые описания Summary

2023-05-22

Пример использования шаблона для построения backend (API) для каталога товаров. В этом репозитории “пошаговая” реализация, которая записана на видео. Можно посмотреть примеры (examples of using) разных механизмов: Validation, Transactions, Notification and etc.

2023-04-15 Версия 7.0.4

Обновлены сборки (nuget) для AutoMapper, FluentValidation, Microsoft.AspNetCore.Authentication,Serilog.
Конфигурация для Serilog вынесена в appSettings.json
LoggerExtensions удалены, потому что подключено Structural logging на базе Serilog.
Потому как StopTheHostException переименован HostAbortedException перехватывать его теперь стали по-новому.
Перехват исключений ValidationException теперь работает через OperationResult, для этого обновлен ValidatorBehavior.

2023-03-11 Версия 7.0.3

Обновлены сборки (nuget) для OpenIddict (OAuth2.0).
Из шаблона удалена сборка GitInfo, которая позволяла использовать версионирование на основе GIT, потому что при создании проекта вне папки репозитория появлялась ошибка: NETSDK1018 Invalid NuGet version string: '0.0.0+main.'.. Пожалуйста, ознакомьтесь со всеми комментариями с надписью “ATTENTION!”, потому что эти места потребует от вас некоторых решений или действий. Например, использовать или не использовать версионирование на основе GIT возможностей.
Исправлена работа FluentValidation для EventItemValidator.
Исправлена работа ErrorHandlerMiddleware для отображения ошибок валидации.

2023-02-24 Версия 7.0.2

Версия получила следующие изменения:

Новая версия Mediatr получила обновление, в том числе была удалена зависимость от nuget-пакета MediatR.Extensions.Microsoft.DependencyInjection. А также изменилась регистрация зависимости.

- services.AddMediatR(Assembly.GetExecutingAssembly());
+ services.AddMediatR(cfg => cfg.RegisterServicesFromAssemblyContaining<Program>());

Обновились сборки EntityFramework.
Обновилась версия для расширение для Visual Studio (VSIX).

2023-02-05 Версия 7.0.1

Обновлены почти все nuget-пакеты, в том числе и один из самых важных OpenIddict:

- <PackageReference Include="OpenIddict.AspNetCore" Version="3.1.1" />
+ <PackageReference Include="OpenIddict.AspNetCore" Version="4.0.0" />

Исправлено несколько синтаксических ошибок
Обновлены методы в IAccountService. За счет этого существенно сокращено количество повторяющихся запрос в базу данных за информацией о пользователе.

2022-11-12

Шаблоны для создания проектов для микросервисной архитектуры успешно мигрировали на NET7. Обновились сборки всех необходимых nuget-пакетов, а также сами проекты теперь строятся на NET7. Не забудьте обновить CI/CD если будете публиковать новые версии для NET7.

2022-10-02

Новые версии шаблонов теперь работают совместно. То есть теперь созданное приложение из шаблона Calabonga.Microservice.Module может авторизоваться у приложения, которое создано из шаблона Calabonga.Microservice.IdentityModule прямо после создания приложений из шаблонов.

В связи с тем, что обновления были в разных модулях в прошлый раз, шаблоны на данный момент имеют разные версии (В будущем это расхождение будет невелировано):

Calabonga.Microservice.IdentityModule имеет версию 6.1.4
Calabonga.Microservice.Module имеет версию 6.1.2

Что в новой версии

Обновлены сборки (nuget-пакеты)
Удалены шаблоны, которые использовали IdentityServer4 в качестве сервера авторизации.
Добавлена сборка Calabonga.AspNetCore.AppDefinitions, которая подключает возможность использования AppDefinitions в проектах на платформе ASP.NET Core.

2022-09-03 Версия 6.1.3

В новой версии 6.1.3 обновился метод авторизации по Authorization Code Flow. Подключены механизмы, которые приведены в пример на сайте OpenIddict Samples. Теперь авторизация учитывает Consent, а также подключены более жесткие требования к формированию id_token и access_token, которые рекомендованы стандартами OAuth2.0.

2022-07-26 Версия 6.1.2

В новой версии 6.1.2 добавлены некоторые инициализации для того, чтобы было проще подключить EntityFramework провайдер для Microsoft SQL Server (UseSqlClient). Добавленные строки кода были закоментированы, чтобы можно было оставить функциональность для IN-MEMORY режима.

2022-07-04 Версия 6.1.1

В новой версии 6.1.1 удалены проекты из папки FullAPI (вместе с папкой). Версия с IdentityServer больше не будет получать обновления, но пока останется доступной. Вы можете ее найти в папке MinimalAPI-IS4. Если вам еще нужны эти проекты, настоятельно рекомендую сделать fork моего репозитория.

Обновлены nuget-пакеты, которые использованы в шаблонах (EntityFramework, FluentValidation).
Удалены старые проекты.
Обновлены собранные архивы для Visual Studio в папке OUTPUT.

2022-05-14 Версия 6.1.0

На платформе NET6 (В папке AspNetCore v6.1) можно найти новую версию Nimble Framework, который предназначен для быстрого создания микросервисной архитектуры. Nimble Framework содержит IdentityModule (AuthServer) и Module (microservice). Новая версия доступна для скачивания.

Удален IdentityServer4 как основа для аутентификации и авторизации на базе OAuth2.0. Теперь Nimble Framework использует для шаблона с сервером авторизации OpenIddict, который также реализует спецификации OAuth2.0.
Обновлен механизм авторизации на странице swagger. Теперь используется Authorization Code Flow, который реализует форму входа. Это позволит использовать шаблон “из коробки”.
Обновлен механизм авторизации для второстепенных сервисов (механизм передачи ролей в токен)
Обновлены почти все сборки (переведены на NET6), которые использованы в шаблонах
Реализована система Definitions

2022-01-16 Версия 6.0.1

Обновлены nuget-пакеты Automapper и Mediatr
Обновились сборки для ASP.NET Core, EntityFrameworkCore
Добавлена информация к шаблону о его времени сборке и прочая информация про Copyright
Обновлен “сборщик” шаблонов, который позволяет быстро обновлять solutions

В статье блога и Видео презентация

2022-05-11

Реализация OpenIddict в шаблонах завершена, теперь формируются шаблоны для Visual Studio.

2022-05-04

Начались работы по переходу от IdentityServer4 на OpenIddict как основной сервис авторизации OAuth2.0. Причина переезда - скорое окончание срока поддержки IdentityServer4 и перехода его на платную основу.

2021-11-21

На платформе NET6 (В папке AspNetCore v6.0) теперь существует два вида шаблонов микросервисов (FullAPI и MinimalAPI), каждый из которых содержит IdentityModel и простой Module. Папка FullAPI содержит уже знакомые шаблоны микросервисов, просто они теперь переведены на NET6. А в папке MinimalAPI новая версия тех же шаблонов, которые построены на базе MinimalAPI.

Шаблоны микросервисов переведены на новую версию NET6. Обновлены почти все файлы, использованы новые “фишки”, которые появились в C#.
Обновились сборки для ASP.NET Core, EntityFrameworkCore и Swagger (OpenAPI). Теперь используются версии NET6.
Удалены дубликаты контроллеров, которые демонстрировали использовать подхода Readonly/Writable (Calabonga.UnitOfWork.Controllers). Теперь остался только один пример, построенный на базе Mediatr.
Обновлена инфраструктура папок. Использована Vertical Slice Architecture, которую представил Jimmy Bogard.
Обновилось расширение VSIX-расширения для Visual Studio.

2021-11-01

Удалены старые шаблоны для версий NET Core 2.2 и NET Core 3.0.
Началась разработка шаблонов для новой версии.

2021-09-06 Версия 5.0.7

Обновились сборки для ASP.NET Core, EntityFrameworkCore и Swagger (OpenAPI). А также nuget-пакеты Calabonga.Microservices.Core, FluentValidation и другие.
Добавлено несколько комментариев в код для обеспечения определенности в действиях
Обновилось расширение VSIX-расширения для Visual Studio. 4.

2021-10-31 Версия 5.0.8

Обновились сборки для ASP.NET Core, EntityFrameworkCore и Swagger (OpenAPI). А также nuget-пакет FluentValidation и другие.
Конструкции некоторых методов переведин на lambda-выражения, чтобы следовать моде.
Обновилось расширение VSIX-расширения для Visual Studio.

2021-09-08 Версия 5.0.6

Обновились сборки для ASP.NET Core и EntityFrameworkCore. А также nuget-пакеты OperationResultCore, Calabonga.Microservices.Core, Swagger, FluentValidation и другие.
Обновились метаданные, используемые для VSIX-расширения для Visual Studio.

2021-06-04 Версия 5.0.5

Исправлено несколько опечаток.
Обновились сборки для ASP.NET Core и EntityFrameworkCore. А также nuget-пакеты OperationResultCore, Calabonga.Microservices.Core, Swagger, FluentValidation и другие.

2021-03-23 Версия 5.0.4

Стандартный logger заменен на Serilog. Теперь читать логи стало проще.
Исправлено несколько опечаток.
Обновились сборки для ASP.NET Core и EntityFrameworkCore. А также nuget-пакеты OperationResultCore, Calabonga.Microservices.Core и другие.
Реализация Mediatr-запросов (Request) из классов превратились в записи (class -> record) С#.

2021-03-16 Версия 5.0.3

Удалена зависимость от некоторых сборок, которые вынесены на более высокий уровень. Это позволит обновлять их отдельно.
Исправлено несколько опечаток.
Обновились сборки для ASP.NET Core и EntityFrameworkCore до версий (5.0.4). А также nuget-пакеты OperationResultCore, Calabonga.Microservices.Core и другие.
Реализация Mediatr-запросов из контроллеров перенесены в проекты шаблонов из сборки Calabonga.AspNetCore.Controllers, чтобы примеры использования были доступны разработчику.

2021-01-27 Версия 5.0.2

Применены языковые фишки из C# 9.0. Другими словами, был неслабый рефакторинг кода для оптимизации.
Исправлено несколько опечаток.
Обновились сборки для ASP.NET Core и EntityFramework Core до версий (5.0.2). А также nuget-пакеты OperationResultCore, Calabonga.Microservices.Core и другие.

2020-12-04 Версия 5.0.1

В шаблоне микросервиса с IdentityServer4 и шаблоне без него удалены проекты xxx.Core. Файлы из этих проектов перенесены в проект xxx.Entities. Ссылки на Exceptions вынесены в nuget-пакет Calabonga.Microservices.Core.
В шаблоне микросервиса с IdentityServer4 добавлена возможность аутентификации как для Cookie типа, так и для Bearer. Да! Теперь настроено два типа аутентификации.
Применены языковые фишки из C# 8.0. Другими словами, был неслабый рефакторинг кода для оптимизации.
Исправлено множество опечаток.

2020-11-15 Версия 5.0.0

Все проекты во всех решениях (solutions) обновились до версии .NET 5.0.
Обновились nuget-сборки для ASP.NET Core и EntityFramework Core (5.0.0).
Добавилась реализация логирования, как пример использования, который описан на видео ILogger в ASP.NET Core
На страницу API (Swagger) выведена информация о названии ветки (branch) и номер публикации (commit).