SnailAspNetCoreFramework

Введение в проект

• Этот проект позиционируется как платформа быстрой разработки для малых и средних предприятий на основе ядра asp.net, включая полный внутренний и внешний код.
• Версия v2.0 в настоящее время находится в разработке. Версию v1.0 можно запустить сразу после переключения ветки. Учебные пособия можно найти в моей серии блогов или в документации проекта.
• Стек внутренних технологий: asp.net core 3.1, cap, swag, ef core code first, autofac, automapper, nlog, aop
• Стек интерфейсных технологий: vue-element-admin, компоненты модуля быстрой разработки crud, макет
• Реализованные функции: управление разрешениями на основе ролей, иерархическое соглашение проекта, автоматическая генерация кода, ведение журналов, мониторинг производительности, AOP и т. д.

Как запустить проект

 git clone [email protected]:shengyu-kmust/SnailAspNetCoreFramework.git
git clone [email protected]:shengyu-kmust/Snail.git
cd SnailAspNetCoreFramework
dotnet build

Демонстрация проекта

Ниже приведена демонстрационная диаграмма, основанная на версии v1.0.

• 1. Загрузите и запустите проект
• 2. Автоматическое создание проектов на основе файлов конфигурации.
• 3. Запустите проект

Введение в каталог проектов

--ApplicationCore // Базовый уровень абстракции использует режим четкой архитектуры и не зависит от других уровней. Все остальные три проекта полагаются на этот тип библиотеки и отвечают за общедоступные определения интерфейсов, констант, перечислений, dtos, сущностей и т. д. .
----Const // Определение констант, таких как константы конфигурации, константы имен событий.
----Dtos // все dtos
----Сущности // Все сущности
----Enums // перечисление
----IServices //Абстрактное определение уровня сервиса
----Утилиты // Класс справки

--Инфраструктура //Уровень инфраструктуры предоставляет услуги передачи данных верхним уровням (таким как уровень обслуживания и уровень приложений).
----Data/config // Конфигурация API-интерфейса базы данныхEntityFramework
----EFValueConverter // Преобразование между типом базы данныхentityframework и типом clr, например преобразование перечисления
----Migrations //Сначала создайте каталог для миграции кодаEntityFramework.

--Service // Уровень сервиса, используемый для реализации интерфейса сервиса в ApplicationCore, основного уровня для реализации логики приложения.
----Cache // Реализация кэша, которая позже будет удалена и извлечена в проект Snail.
----Перехватчик //Перехватчик реализован по умолчанию
----BaseService.cs //Базовый класс каждой службы содержит общие методы каждой службы, например CRUD
----InitDatabaseService.cs // Отвечает за инициализацию данных базы данных
----InterceptorService.cs //Базовый класс перехватчика

--Web // Отвечает за всю связанную обработку ввода и вывода параметров интерфейса (например, проверку параметров, резервирование формата вывода и т. д.)
----AutoFacModule // конфигурация инъекции autofac
----AutoMapperProfiles // конфигурация автосопоставления
----ClientApp // Фронтенд-проект
------build // Выходной каталог, созданный в результате компиляции интерфейса.
------mock // макет внешнего интерфейса
------src // Основной код внешнего интерфейса
----CodeGenerater //Модуль T4 и связанная с ним логика для генерации кода
----ConfigureServicesExtensions // Расширения внедрения ServiceProvider, чтобы избежать записи их в файл запуска
----Контроллеры //Контроллеры
----docs // Набор документов
----Dto // Класс dto будет использоваться только на веб-слое
----Фильтр // фильтр
----Хабы // сигнализатор
----Permission //Реализация разрешений по умолчанию
----staticFile // Используется для хранения загруженных файлов

Общий конструктивный дизайн проекта

Используется DDD, но в зависимости от размера проекта необходимо применять разные технологии DDD. Вообще говоря, он делится на следующие проекты.

• Сервис: уровень сервиса, используемый для реализации интерфейса сервиса в ApplicationCore, основной уровень реализации логики приложения.
• Уровень инфраструктуры: базовый уровень. Этот уровень повторно используется в различных проектах. Он основан на соглашении об интерфейсах уровня ApplicationCore для предоставления услуг передачи данных для верхних уровней (таких как уровень обслуживания и уровень приложения). При этом реализован универсальный интерфейс доступа к данным IDAL.
• Уровень ApplicationCore: уровень логики приложения, режим DDD, содержит всю бизнес-логику и не зависит от других уровней.
• Веб-уровень: отвечает за всю связанную обработку ввода и вывода параметров интерфейса (например, проверку параметров, резервирование формата вывода и т. д.), а также вызовы уровня приложения/DAL.

Универсальные разрешения и проверка данных

ВЕБ-слой

• Отвечает за обработку входных и выходных параметров, перехват исключений и веб-кэширование.
• Для операций с данными типа статистики запросов уровень DAL может быть вызван напрямую.
• Конфигурацию сред разработки и тестирования можно разделить

Проверка параметров -- реализована

• Использование интерфейса Microsoft — реализовано

Соглашение о выводе -- реализовано

• Код состояния HTTP соответствует соглашению о коде состояния: 20x — успех (интерфейс был успешно вызван), 40x — ошибка запроса (бизнес-исключение, несанкционированное и т. д.), 50x — ошибка сервера (исключение сервера) — реализовано
• Содержимое возвращаемого результата в основном имеет фактический формат данных, требуемый интерфейсом, который представляет собой объект json. Если это сообщение об ошибке, возвращается содержимое ошибки. --Достигнуто

Обработка исключений -- реализовано

• Обработка исключений использует технологию Microsoft, см. https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/error-handling?view=aspnetcore-2.2.
• Все исключения не будут перехвачены
• Бизнес-исключения выводятся наружу. Исключения сервера перехватываются и выводятся наружу. Формат вывода приглашения соответствует соглашению о выводе.

чванство - реализовано

• Используйте Нсваггер

Уровень ApplicationCore

• Этот проект не зависит от каких-либо других проектов, используйте чистую архитектуру, см. https://docs.microsoft.com/zh-cn/dotnet/standard/modern-web-apps-azure-architecture/common-web-. прикладные архитектуры

кэш

• Интерфейс ICache реализует redis, memcached, MemoryCache и т. д. Вы можете рассмотреть возможность использования easycaching.
• Используйте АОП для кэширования, чтобы избежать написания логики кэширования в каждом методе. easycaching+автофак
• Обновления кэша управляются событиями, и вводятся сторонние компоненты. easycaching+cap

Управление доменом

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

АОП -- реализовано

• Для записи AOP в журналы и кэши рассмотрите возможность использования autofac.

МОК -- реализовано

• Использовать автофак

Таблица памяти -- реализована

• Храните таблицы, которые изменяются нечасто и имеют относительно небольшие объемы данных в памяти (не кэши, а объекты), и используйте событийно-ориентированное мышление для синхронизации последних данных.

событие

• публиковать и подписываться
• Используйте ограничение для переключения между распределенными и отдельными приложениями.

Обработка журналов -- реализована

• Используйте нлог

командная шина -- реализована

• Используйте Медиатр

Уровень DAL

• Отвечает за все операции, связанные с данными.
• Инкапсулируйте общие интерфейсы и реализации доступа к данным, например использование EF для реализации следующих функций.
• Используйте идею интерфейсно-ориентированного программирования для расширения уровня DAL с использованием технологий, отличных от EF, в будущем.
• Используя режим репозитория, по сути, EF сам по себе является режимом репозитория, но для того, чтобы единообразно перехватывать и применять собственную логику на уровне операций доступа к базе данных, он затем использует собственный репозиторий для инкапсуляции EF.
• Запрос одной таблицы, пейджинг
• Простой реляционный запрос к нескольким таблицам, подкачка
• Простой CRUD

автокартограф

• Эталонный автосопоставитель для назначения и преобразования объектов
• Реализуйте класс objectmapper на основе выражений для простого назначения объектов, компенсируя недостатки сложной конфигурации automapper и низкой производительности с помощью отражения.

Использование ЭФ

• Журнал языка sql выполнения EF** – реализован**
• Для типов перечисления используйте технологию ValueConverter EF для их автоматического преобразования. Согласовано, что тип, хранящийся в базе данных, является строковым типом, а не типом Int, что удобно для понимания** - Реализовано**.

общение в реальном времени

• Использовать сигнал

Выбор технологии

обработка транзакций

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

Метод обработки базы данных

• Используйте EF для обработки данных и не рассматривайте другие методы.

Внешний интерфейс

• Поместите его в веб-проект и используйте метод спа.

нужно сделать

• Внедрение модульного теста
• Уровень обслуживания должен находиться не на веб-уровне, а на уровне ядра приложения.

многоязычный

Различные технические детали

КАП

• Исходная реализация CAP не очень хорошо поддерживает autofac. В этом проекте для его обработки написан SnailCapConsumerServiceSelector.
• CAP изначально обрабатывает контроллеры и не-контроллеры по-разному. Контроллерам нужно только добавить атрибут CapSubscribe к методу, тогда как контроллерам необходимо реализовать интерфейс ICapSubscribe в классе и добавить атрибут CapSubscribe к методу.

Как использовать

1. git клонируйте этот проект 2. Настройте codeGenerate.json 3. Запустите этот проект и после входа в Swagger запустите интерфейс codeGenerate 4. Запустите add-migration 5. Запустите проект

Учебная запись в блоге

Блог серии SnailAspNetCoreFramework Framework
1. Введение и общие идеи дизайна каждого проекта и каталога в рамках — среда быстрой разработки SnailAspNetCoreFramework.
2. Проверка ввода интерфейса, формат вывода и обработка исключений — дизайн серверной части среды быстрой разработки SnailAspNetCoreFramework.
3. Универсальный дизайн разрешений - серверная часть среды быстрой разработки SnailAspNetCoreFramework.
4. Как предоставить хорошие интерфейсные документы (Swagger) для внешнего интерфейса - дизайн внутренней части среды быстрой разработки SnailAspNetCoreFramework
5. Использование кэша в различных сценариях — дизайн серверной части среды быстрой разработки SnailAspNetCoreFramework.
6. Проектирование АОП на основе замка и реализация общего кэша, производительности и перехватчика журналов — серверная часть среды быстрой разработки SnailAspNetCoreFramework.
7. Введение во внедрение зависимостей – autofac – серверная часть среды быстрой разработки SnailAspNetCoreFramework
8. Зачем использовать Eventbus и как его использовать - серверная часть среды быстрой разработки SnailAspNetCoreFramework
9. Знакомство с Nlog, компонентом журнала - серверная часть среды быстрой разработки SnailAspNetCoreFramework.
10. Введение в Mediatr — серверная часть среды быстрой разработки SnailAspNetCoreFramework.
11. Универсальный дизайн CRUD для уровней контроллера, сервиса и дали — SnailAspNetCoreFramework, серверная часть среды быстрой разработки.
12. Инструмент автоматического сопоставления объектов — SnailAspNetCoreFramework, серверная часть среды быстрой разработки.
13. Как отслеживать операторы sql, генерируемые EF — серверная часть среды быстрой разработки SnailAspNetCoreFramework
14. Знакомство с несколькими методами развертывания ядра .net — серверная часть среды быстрой разработки SnailAspNetCoreFramework.
15. Сигнал связи в реальном времени — серверная часть среды быстрой разработки SnailAspNetCoreFramework.
16. Как сначала использовать код ef для непрерывной итерации версии базы данных проекта — серверная часть среды быстрой разработки SnailAspNetCoreFramework
17. Знакомство с функцией автоматической генерации кода — серверная часть среды быстрой разработки SnailAspNetCoreFramework.
18. Как следить за тем, чтобы каждая функция проекта работала нормально (HealthCheck) - серверная часть среды быстрой разработки SnailAspNetCoreFramework
19. Введение в зависание для запланированных задач — дизайн серверной части среды быстрой разработки SnailAspNetCoreFramework.
20. Общее введение во внешний интерфейс — дизайн внешнего интерфейса среды быстрой разработки SnailAspNetCoreFramework.
21. Больше не нужно просить о внутренних интерфейсах (использование MOCK) - интерфейсный дизайн среды быстрой разработки SnailAspNetCoreFramework.
22. Контроль разрешений внешнего интерфейса — дизайн внешнего интерфейса среды быстрой разработки SnailAspNetCoreFramework.
23. Как избежать повторного написания внешнего CRUD-кода (внедрение и использование различных компонентов SnailXXX во внешнем интерфейсе) - дизайн внешнего интерфейса среды быстрой разработки SnailAspNetCoreFramework
24. Введение в прокси-сервер запроса - интерфейсный дизайн среды быстрой разработки SnailAspNetCoreFramework.