SnailAspNetCoreFramework

Présentation du projet

• Ce projet se positionne comme un cadre de développement rapide pour les petites et moyennes entreprises basé sur le noyau asp.net, comprenant un code back-end et front-end complet.
• La version v2.0 est actuellement en cours de développement. La version v1.0 peut être exécutée directement après le changement de branche. Pour les tutoriels, veuillez vous référer à ma série de blogs ou à la documentation du projet.
• Pile technologique back-end : asp.net core 3.1, cap, swag, ef core code first, autofac, automapper, nlog, aop
• Pile technologique frontale : vue-element-admin, composants du module de développement rapide Crud, mock
• Fonctions implémentées : contrôle des autorisations basé sur les rôles, accord hiérarchique du projet, génération automatique de code, journalisation, surveillance des performances, aop, etc.

Comment exécuter le projet

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

Démonstration du projet

Ce qui suit est un diagramme de démonstration basé sur la version v1.0

• 1. Téléchargez et exécutez le projet
• 2. Générez automatiquement des projets basés sur des fichiers de configuration
• 3. Exécutez le projet

Présentation du répertoire de projets

--ApplicationCore // La couche d'abstraction principale adopte un mode d'architecture clair et ne dépend pas des autres couches. Les trois autres projets s'appuient tous sur ce type de bibliothèque et sont responsables des définitions publiques telles que les interfaces, les constantes, les énumérations, les dto, les entités, etc.
----Const // Définition de constante, telle que les constantes de configuration, les constantes de nom d'événement
----Dtos // tous les dtos
----Entités // Toutes les entités
----Enums // énumération
----IServices //Définition abstraite de la couche Service
----Utilitaires // Classe d'aide

--Infrastructure //La couche infrastructure fournit des services de données pour les couches supérieures (telles que la couche de service et la couche d'application).
----Data/config // Configuration API fluide du framework d'entité de base de données
----EFValueConverter // Conversion entre le type de base de données Entityframework et le type clr, telle que la conversion d'énumération
----Migrations //Générer d'abord le répertoire pour la migration du code du framework d'entité

--Service // Couche de service, utilisée pour implémenter l'interface de service dans ApplicationCore, la couche principale pour l'implémentation de la logique d'application
----Cache // Implémentation du cache, qui sera supprimée et extraite ultérieurement du projet Snail.
----Intercepteur //Intercepteur implémenté par défaut
----BaseService.cs //La classe de base de chaque service contient les méthodes communes de chaque service, telles que CRUD
----InitDatabaseService.cs // Responsable de l'initialisation des données de la base de données
----InterceptorService.cs //Classe de base de l'intercepteur

--Web // Responsable de tous les traitements associés aux entrées et sorties des paramètres d'interface (tels que la vérification des paramètres, la réservation du format de sortie, etc.)
----AutoFacModule // configuration de l'injection autofac
----AutoMapperProfiles // configuration du mappeur automatique
----ClientApp // Projet front-end
------build // Répertoire de sortie généré par la compilation frontale
------simulation // Simulation frontale
------src // Code principal du front-end
----CodeGenerater //Module T4 et logique associée pour la génération de code
----ConfigureServicesExtensions // Extensions d'injection de ServiceProvider pour éviter de les écrire dans le fichier de démarrage
----Contrôleurs //Contrôleurs
----docs // Ensemble de documents
----Dto // La classe dto ne sera utilisée que dans la couche web
----Filtre // filtre
----Hubs // signaleur
----Permission //Implémentation par défaut des autorisations
----staticFile // Utilisé pour stocker les fichiers téléchargés

Conception structurelle globale du projet

DDD est utilisé, mais différentes technologies de DDD doivent être appliquées en fonction de la taille du projet. De manière générale, il est divisé en projets suivants.

• Service : couche de service, utilisée pour implémenter l'interface de service dans ApplicationCore, la couche principale pour l'implémentation de la logique d'application.
• Couche Infrastructure : Couche de base. Cette couche est réutilisée dans différents projets. Elle s'appuie sur la convention d'interface de la couche ApplicationCore pour fournir des services de données pour les couches supérieures (telles que la couche de service et la couche d'application). Parallèlement, l'interface universelle d'accès aux données d'IDAL est implémentée.
• Couche ApplicationCore : couche de logique applicative, mode DDD, contient toute la logique métier et ne dépend pas des autres couches
• Couche Web : responsable de tous les traitements associés aux entrées et sorties des paramètres d'interface (tels que la vérification des paramètres, la réservation du format de sortie, etc.) et des appels à la couche Application/DAL.

Autorisations et vérification universelles des données

Couche WEB

• Responsable du traitement des paramètres d'entrée et de sortie, de l'interception des exceptions et de la mise en cache Web
• Pour les opérations de données de type statistiques de requêtes, la couche DAL peut être directement appelée.
• La configuration des environnements de développement et de test peut être séparée

Vérification des paramètres --implémentée

• Utilisation de l'interface de Microsoft --implémenté

Convention de sortie --implémentée

• Le code d'état HTTP suit la convention du code d'état, 20x correspond au succès (l'interface a été appelée avec succès), 40x correspond à une erreur de demande (exception métier, non autorisé, etc.), 50x correspond à une erreur de serveur (exception de serveur) - implémenté
• Le contenu du résultat renvoyé est principalement dans le format de données réel requis par le frontal, qui est un objet json ; s'il s'agit d'un message d'erreur, le contenu de l'erreur est renvoyé. --Réalisé

Gestion des exceptions --implémentée

• La gestion des exceptions utilise la technologie Microsoft, reportez-vous à https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/error-handling?view=aspnetcore-2.2
• Toutes les exceptions ne seront pas détectées
• Les exceptions métier sont envoyées à l'extérieur. Les exceptions du serveur sont interceptées et envoyées à l'extérieur. Le format de sortie de l'invite suit la convention de sortie.

swagger -- implémenté

• Utiliser NSwagger

Couche ApplicationCore

• Ce projet ne dépend d'aucun autre projet, utilisez une architecture propre, reportez-vous à : https://docs.microsoft.com/zh-cn/dotnet/standard/modern-web-apps-azure-architecture/common-web- architectures d'applications

cache

• L'interface ICache implémente Redis, Memcached, MemoryCache, etc. Vous pouvez envisager d'utiliser easycaching.
• Utilisez AOP pour la mise en cache afin d'éviter d'écrire une logique de mise en cache dans chaque méthode. mise en cache facile+fac automatique
• Les mises à jour du cache sont basées sur des événements et des composants tiers sont introduits. mise en cache facile + capuchon

Piloté par domaine

Piloté par domaine, si cela dépend d'autres couches, cela dépend de l'interface de la couche correspondante plutôt que de l'implémentation.

AOP -- implémenté

• Pour l'entrée AOP dans les journaux et les caches, pensez à utiliser autofac

COI -- mis en œuvre

• Utiliser la télécopie automatique

Table mémoire --implémentée

• Stockez des tables qui changent rarement et contiennent des quantités de données relativement faibles en mémoire (pas de caches, mais des objets), et utilisez la réflexion événementielle pour synchroniser les données les plus récentes.

événement

• publier et s'abonner
• Utilisez cap pour basculer entre les applications distribuées et uniques

Traitement des journaux --implémenté

• Utiliser nlog

bus de commande --implémenté

• Utiliser Mediatr

Couche DAL

• Responsable de toutes les opérations liées aux données
• Encapsuler les interfaces et implémentations d'accès aux données courantes, telles que l'utilisation d'EF pour implémenter les fonctions suivantes
• Utilisez l'idée de programmation orientée interface pour étendre la couche DAL en utilisant des technologies autres que EF à l'avenir.
• En utilisant le mode Repository, en fait, EF lui-même est un mode Repository, mais afin d'unifier l'interception et l'application de sa propre logique au niveau des opérations d'accès à la base de données, il utilise ensuite son propre Repository pour encapsuler EF.
• Requête de table unique, pagination
• Requête relationnelle simple de plusieurs tables, pagination
• CRUD simple

mappeur automatique

• Mappeur automatique de référence pour l'affectation et la conversion d'objets
• Implémentez la classe objectmapper basée sur une expression pour une affectation d'objet simple, compensant ainsi les défauts de la configuration complexe et des faibles performances d'automapper en utilisant la réflexion.

Utilisation de EF

• Journal du langage SQL d'exécution EF**--implémenté**
• Pour les types d'énumération, utilisez la technologie ValueConverter d'EF pour convertir automatiquement, et il est convenu que le type stocké dans la base de données est de type chaîne au lieu du type Int, ce qui est pratique pour la compréhension**--Implémenté**

messagerie en temps réel

• Utiliser le signaleur

Sélection technologique

traitement des transactions

Utilisez les modes référentiel et unité de travail, mais utilisez le mode référentiel fourni avec EF.

Méthode de traitement de la base de données

• Utilisez EF pour le traitement des données et n’envisagez pas d’autres méthodes.

Interface frontale

• Mettez-le dans le projet Web et utilisez la méthode spa

il faut faire

• Injection de test unitaire
• La couche de service ne doit pas être dans la couche Web, mais dans le noyau d'application

multilingue

Divers détails techniques

CAPUCHON

• L'implémentation originale de CAP ne prend pas très bien en charge autofac. Dans ce projet, SnailCapConsumerServiceSelector est écrit pour le gérer.
• CAP traite nativement les contrôleurs et les non-contrôleurs différemment. Les contrôleurs doivent uniquement ajouter l'attribut CapSubscribe à la méthode, tandis que les contrôleurs doivent implémenter l'interface ICapSubscribe sur la classe et ajouter l'attribut CapSubscribe à la méthode.

Comment utiliser

1. git clone ce projet 2. Configurez codeGenerate.json 3. Exécutez ce projet et après vous être connecté à swagger, exécutez l'interface codeGenerate 4. Exécutez add-migration 5. Démarrez le projet

Article de blog du didacticiel

Blog de la série de frameworks SnailAspNetCoreFramework
1. Introduction et idées générales de conception de chaque projet et répertoire dans le cadre - Cadre de développement rapide SnailAspNetCoreFramework
2. Vérification des entrées de l'interface, format de sortie et gestion des exceptions : conception back-end du cadre de développement rapide SnailAspNetCoreFramework
3. Conception d'autorisations universelles - Conception back-end du cadre de développement rapide SnailAspNetCoreFramework
4. Comment fournir de bons documents d'interface (Swagger) au front-end - Conception back-end du cadre de développement rapide SnailAspNetCoreFramework
5. Utilisation du cache dans divers scénarios : conception backend du cadre de développement rapide SnailAspNetCoreFramework
6. Conception AOP basée sur Castle et cache commun, performances, implémentation de l'intercepteur de journaux - Conception back-end du cadre de développement rapide SnailAspNetCoreFramework
7. Introduction à l'injection de dépendances - autofac - Conception back-end du cadre de développement rapide SnailAspNetCoreFramework
8. Pourquoi utiliser Eventbus et comment l'utiliser - Conception back-end du cadre de développement rapide SnailAspNetCoreFramework
9. Introduction à Nlog, le composant de journalisation - Conception back-end du cadre de développement rapide SnailAspNetCoreFramework
10.Introduction à Mediatr - Conception back-end du cadre de développement rapide SnailAspNetCoreFramework
11. Conception CRUD universelle pour les couches contrôleur, service et Dal – Conception backend du cadre de développement rapide SnailAspNetCoreFramework
12. Outil de mappage d'objets automapper - Conception back-end du cadre de développement rapide SnailAspNetCoreFramework
13. Comment surveiller les instructions SQL générées par EF - Conception back-end du cadre de développement rapide SnailAspNetCoreFramework
14. Introduction à plusieurs méthodes de déploiement de .net core - Conception back-end du cadre de développement rapide SnailAspNetCoreFramework
15. Signal de communication en temps réel - Conception back-end du cadre de développement rapide SnailAspNetCoreFramework
16. Comment utiliser d'abord le code ef pour itérer en continu la version de base de données du projet - Conception back-end du cadre de développement rapide SnailAspNetCoreFramework
17. Introduction à la fonction de génération automatique de code—Conception back-end du cadre de développement rapide SnailAspNetCoreFramework
18. Comment vérifier si chaque fonction du projet est normale (HealthCheck) - Conception back-end du cadre de développement rapide SnailAspNetCoreFramework
19. Introduction à Hangfire pour les tâches planifiées – Conception backend du cadre de développement rapide SnailAspNetCoreFramework
20. Introduction générale au front-end – Conception frontale du cadre de développement rapide SnailAspNetCoreFramework
21. Plus besoin de mendier pour les interfaces back-end (utilisation de MOCK) - Conception frontale du cadre de développement rapide SnailAspNetCoreFramework
22. Contrôle des autorisations frontales - Conception frontale du cadre de développement rapide SnailAspNetCoreFramework
23. Comment éviter d'écrire à plusieurs reprises du code CRUD frontal (introduction et utilisation de divers composants SnailXXX dans le front-end) - Conception frontale du cadre de développement rapide SnailAspNetCoreFramework
24. Introduction à la demande de proxy - Conception frontale du cadre de développement rapide SnailAspNetCoreFramework