SnailAspNetCoreFramework

Introducción del proyecto

• Este proyecto se posiciona como un marco de desarrollo rápido para pequeñas y medianas empresas basado en el núcleo de asp.net, incluido el código completo de back-end y front-end.
• La versión v2.0 está actualmente en desarrollo. La versión v1.0 se puede ejecutar directamente después de cambiar de rama. Para obtener tutoriales, consulte mi serie de blogs o los documentos del proyecto.
• Pila de tecnología back-end: asp.net core 3.1, cap, swag, ef core code first, autofac, automapper, nlog, aop
• Pila de tecnología front-end: vue-element-admin, componentes básicos del módulo de desarrollo rápido, simulacro
• Funciones implementadas: control de permisos basado en roles, acuerdo jerárquico del proyecto, generación automática de código, registro, monitoreo del rendimiento, aop, etc.

Cómo ejecutar el proyecto

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

Demostración del proyecto

El siguiente es un diagrama de demostración basado en la versión v1.0.

• 1. Descargue y ejecute el proyecto.
• 2. Generar automáticamente proyectos basados ​​en archivos de configuración.
• 3. Ejecute el proyecto

Introducción al directorio de proyectos

--ApplicationCore // La capa de abstracción central adopta un modo de arquitectura clara y no depende de otras capas. Los otros tres proyectos dependen de este tipo de biblioteca y son responsables de definiciones públicas como interfaces, constantes, enumeraciones, dto, entidades. etc.
----Const // Definición de constantes, como constantes de configuración, constantes de nombre de evento
----Dtos // todos los dtos
----Entidades // Todas las entidades
----Enums // enumeración
----IServices //Definición abstracta de capa de servicio
----Utilidades // Clase de ayuda

--Infraestructura // La capa de infraestructura proporciona servicios de datos para las capas superiores (como la capa de servicio y la capa de aplicación).
----Data/config // Configuración fluida de la API del marco de entidad de la base de datos
----EFValueConverter // Conversión entre el tipo de base de datos de entidad y el tipo clr, como la conversión de enumeración
----Migraciones //Generar primero el directorio para la migración del código del marco de entidad

--Service // Capa de servicio, utilizada para implementar la interfaz de servicio en ApplicationCore, la capa principal para la implementación de la lógica de la aplicación
----Caché // Implementación de caché, que se eliminará y extraerá al proyecto Snail más adelante.
----Interceptor //Interceptor implementado por defecto
----BaseService.cs // La clase base de cada servicio contiene los métodos comunes de cada servicio, como CRUD
----InitDatabaseService.cs // Responsable de la inicialización de los datos de la base de datos
----InterceptorService.cs //Clase base del interceptor

--Web // Responsable de todo el procesamiento relacionado de entrada y salida de parámetros de interfaz (como verificación de parámetros, reserva de formato de salida, etc.)
----AutoFacModule // configuración de inyección autofac
----AutoMapperProfiles // configuración del mapeador automático
----ClientApp // Proyecto front-end
------build // Directorio de salida generado por la compilación front-end
------mock // simulacro de front-end
------src // Código central de front-end
----CodeGenerater //Módulo T4 y lógica relacionada para la generación de código
----ConfigureServicesExtensions // Extensiones de inyección de ServiceProvider para evitar escribirlas en el archivo de inicio
----Controladores //Controladores
----docs // Conjunto de documentos
----Dto // La clase dto solo se usará en la capa web
----Filtro // filtro
----Hubs // señalizador
----Permiso //Implementación predeterminada de permisos
----staticFile // Se utiliza para almacenar archivos cargados

Diseño estructural general del proyecto.

Se utiliza DDD, pero se deben aplicar diferentes tecnologías de DDD según el tamaño del proyecto. En términos generales, se divide en los siguientes proyectos.

• Servicio: capa de servicio, utilizada para implementar la interfaz de servicio en ApplicationCore, la capa principal para la implementación de la lógica de la aplicación.
• Capa de infraestructura: capa básica. Esta capa se reutiliza en diferentes proyectos. Se basa en la convención de interfaz de la capa ApplicationCore para proporcionar servicios de datos para las capas superiores (como la capa de servicio y la capa de aplicación). Al mismo tiempo, se implementa la interfaz universal de acceso a datos de IDAL.
• Capa ApplicationCore: capa lógica de aplicación, modo DDD, contiene toda la lógica empresarial y no depende de otras capas
• Capa web: responsable de todo el procesamiento relacionado de entrada y salida de parámetros de interfaz (como verificación de parámetros, reserva de formato de salida, etc.) y llamadas a la capa Aplicación/DAL.

Permisos y verificación de datos universales

capa WEB

• Responsable del procesamiento de parámetros de entrada y salida, interceptación de excepciones y almacenamiento en caché web.
• Para operaciones de datos del tipo de consulta de estadísticas, se puede llamar directamente a la capa DAL.
• La configuración de los entornos de desarrollo y prueba se puede separar.

Verificación de parámetros : implementada

• Usando la interfaz de Microsoft : implementado

Convención de salida : implementada

• El código de estado HTTP sigue la convención del código de estado, 20x es éxito (la interfaz se ha llamado exitosamente), 40x es error de solicitud (excepción comercial, no autorizada, etc.), 50x es error del servidor (excepción del servidor) - implementado
• El contenido del resultado devuelto está principalmente en el formato de datos real requerido por la interfaz, que es un objeto json, si es un mensaje de error, se devuelve el contenido del error; --Logrado

Manejo de excepciones: implementado

• El manejo de excepciones utiliza tecnología de Microsoft; consulte https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/error-handling?view=aspnetcore-2.2
• No se detectarán todas las excepciones.
• Las excepciones comerciales se envían al exterior. Las excepciones del servidor se interceptan y se envían al exterior. El formato de salida del aviso sigue la convención de salida.

arrogancia - implementado

• Utilice NSwagger

AplicaciónCapa central

• Este proyecto no depende de ningún otro proyecto, utilice una arquitectura limpia, consulte: https://docs.microsoft.com/zh-cn/dotnet/standard/modern-web-apps-azure-architecture/common-web- arquitecturas de aplicaciones

cache

• La interfaz ICache implementa redis, memcached, MemoryCache, etc. Puede considerar usar easycaching.
• Utilice AOP para el almacenamiento en caché para evitar escribir lógica de almacenamiento en caché en cada método. fácil almacenamiento en caché + autofac
• Las actualizaciones de la caché se basan en eventos y se introducen componentes de terceros. tapa+caching fácil

Impulsado por dominio

Impulsado por el dominio, si depende de otras capas, depende de la interfaz de la capa correspondiente en lugar de la implementación.

AOP - implementado

• Para la entrada de AOP en registros y cachés, considere usar autofac

COI - implementado

• Usar autofac

Tabla de memoria: implementada

• Almacene tablas que cambien con poca frecuencia y que tengan cantidades relativamente pequeñas de datos en la memoria (no cachés, sino objetos) y utilice el pensamiento basado en eventos para sincronizar los datos más recientes.

evento

• publica y suscríbete
• Utilice cap para cambiar entre aplicaciones distribuidas y únicas

Procesamiento de registros : implementado

• utilizar nlog

bus de comando --implementado

• Utilice Mediatr

capa DAL

• Responsable de todas las operaciones relacionadas con los datos.
• Encapsule interfaces e implementaciones de acceso a datos comunes, como el uso de EF para implementar las siguientes funciones
• Utilice la idea de programación orientada a interfaz para expandir la capa DAL utilizando tecnologías distintas a EF en el futuro.
• Usando el modo Repositorio, de hecho, EF en sí es un modo Repositorio, pero para unificar la interceptación y aplicación de su propia lógica en el nivel de las operaciones de acceso a la base de datos, luego usa su propio Repositorio para encapsular EF.
• Consulta de tabla única, paginación
• Consulta relacional simple de múltiples tablas, paginación.
• CRUD simple

mapeador automático

• Automateper de referencia para asignación y conversión de objetos.
• Implemente la clase objectmapper basada en expresiones para una asignación de objetos simple, compensando las deficiencias de la configuración compleja del automapper y el bajo rendimiento mediante la reflexión.

Uso de FE

• Registro de lenguaje SQL de ejecución de EF**--implementado**
• Para los tipos de enumeración, utilice la tecnología ValueConverter de EF para convertir automáticamente y se acuerda que el tipo almacenado en la base de datos es tipo cadena en lugar de tipo Int, lo cual es conveniente para la comprensión ** - Implementado **

mensajería en tiempo real

• Usar señalizador

Selección de tecnología

procesamiento de transacciones

Utilice los modos de repositorio y unidad de trabajo, pero utilice el modo de repositorio que viene con EF.

Método de procesamiento de base de datos

• Utilice EF para el procesamiento de datos y no considere otros métodos.

Interfaz frontal

• Ponlo en el proyecto web y usa el método spa.

necesito hacer

• Inyección de prueba unitaria
• La capa de servicio no debe estar en la capa web, sino en el núcleo de aplicación.

plurilingüe

Varios detalles técnicos

TAPA

• La implementación original de CAP no es muy compatible con autofac. En este proyecto, SnailCapConsumerServiceSelector está escrito para manejarlo.
• CAP trata de forma nativa a los controladores y a los no controladores de manera diferente. Los controladores solo necesitan agregar el atributo CapSubscribe al método, mientras que los controladores deben implementar la interfaz ICapSubscribe en la clase y agregar el atributo CapSubscribe al método.

como usar

1. git clone este proyecto 2. Configure codeGenerate.json 3. Ejecute este proyecto y, después de iniciar sesión en swagger, ejecute la interfaz codeGenerate 4. Ejecute add-migration 5. Inicie el proyecto

Publicación de blog tutorial

Blog de la serie de marcos SnailAspNetCoreFramework
1. Introducción e ideas generales de diseño de cada proyecto y directorio dentro del marco: marco de desarrollo rápido SnailAspNetCoreFramework
2. Verificación de entrada de interfaz, formato de salida y manejo de excepciones: diseño de back-end del marco de desarrollo rápido SnailAspNetCoreFramework
3. Diseño de permisos universales: diseño back-end del marco de desarrollo rápido SnailAspNetCoreFramework
4. Cómo proporcionar buenos documentos de interfaz (Swagger) al front-end: diseño de back-end del marco de desarrollo rápido SnailAspNetCoreFramework
5. Uso de caché en varios escenarios: diseño de backend del marco de desarrollo rápido SnailAspNetCoreFramework
6. Diseño AOP basado en Castle e implementación común de caché, rendimiento e interceptor de registros: diseño de back-end del marco de desarrollo rápido SnailAspNetCoreFramework
7. Introducción a la inyección de dependencias - autofac - Diseño back-end del marco de desarrollo rápido SnailAspNetCoreFramework
8. Por qué usar Eventbus y cómo usarlo: diseño back-end del marco de desarrollo rápido SnailAspNetCoreFramework
9. Introducción a Nlog, el componente de registro: diseño back-end del marco de desarrollo rápido SnailAspNetCoreFramework
10.Introducción a Mediatr: diseño de back-end del marco de desarrollo rápido SnailAspNetCoreFramework
11. Diseño CRUD universal para capas de controlador, servicio y dal: diseño de backend del marco de desarrollo rápido SnailAspNetCoreFramework
12. Herramienta de mapeo de objetos Automatapper: diseño de back-end del marco de desarrollo rápido SnailAspNetCoreFramework
13. Cómo monitorear las declaraciones SQL generadas por EF: diseño de back-end del marco de desarrollo rápido SnailAspNetCoreFramework
14. Introducción a varios métodos de implementación de .net core: diseño de back-end del marco de desarrollo rápido SnailAspNetCoreFramework
15. Señalizador de comunicación en tiempo real: diseño de back-end del marco de desarrollo rápido SnailAspNetCoreFramework
16. Cómo utilizar el código ef primero para iterar continuamente la versión de la base de datos del proyecto: diseño back-end del marco de desarrollo rápido SnailAspNetCoreFramework
17. Introducción a la función de generación automática de código: diseño back-end del marco de desarrollo rápido SnailAspNetCoreFramework
18. Cómo monitorear si cada función del proyecto es normal (HealthCheck): diseño de back-end del marco de desarrollo rápido SnailAspNetCoreFramework
19. Introducción a Hangfire para tareas programadas: diseño de backend del marco de desarrollo rápido SnailAspNetCoreFramework
20. Introducción general al front-end: diseño del front-end del marco de desarrollo rápido SnailAspNetCoreFramework
21. No más ruegos por interfaces de back-end (uso de MOCK): diseño de front-end del marco de desarrollo rápido SnailAspNetCoreFramework
22. Control de permisos de front-end: diseño de front-end del marco de desarrollo rápido SnailAspNetCoreFramework
23. Cómo evitar escribir repetidamente código CRUD de front-end (introducción y uso de varios componentes SnailXXX en el front-end) -Diseño de front-end del marco de desarrollo rápido SnailAspNetCoreFramework
24. Introducción a la solicitud de proxy: diseño frontal del marco de desarrollo rápido SnailAspNetCoreFramework