SnailAspNetCoreFramework

Project introduction

• This project is positioned as a rapid development framework for small and medium-sized enterprises based on asp.net core, including complete back-end and front-end code.
• The v2.0 version is currently under development. The v1.0 version can be run directly after switching in the branch. For tutorials, please refer to my series of blogs or the docs in the project.
• Back-end technology stack: asp.net core 3.1, cap, swag, ef core code first, autofac, automapper, nlog, aop
• Front-end technology stack: vue-element-admin, crud rapid development module components, mock
• Implemented functions: role-based permission control, project hierarchical agreement, automatic code generation, logging, performance monitoring, aop, etc.

How to run the project

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

Project demonstration

The following is a demonstration diagram based on the v1.0 version

• 1. Download and run the project
• 2. Automatically generate projects based on configuration files
• 3. Run the project

Project directory introduction

--ApplicationCore // The core abstraction layer adopts clear architecture mode and does not depend on other layers. The other three projects all rely on this type of library and are responsible for public definitions of interfaces, constants, enumerations, dtos, entities, etc.
----Const // Constant definition, such as configuration constants, event name constants
----Dtos // all dtos
----Entities // All entities
----Enums // enumeration
----IServices //Abstract definition of Service layer
----Utilities // Help class

--Infrastructure //The infrastructure layer provides data services to the upper layers (such as service layer and application layer).
----Data/config // Database entityframework fluent api configuration
----EFValueConverter // Conversion between entityframework database type and clr type, such as enumeration conversion
----Migrations //Generate directory for migration of entityframework code first

--Service // Service layer, used to implement the service interface in ApplicationCore, the main layer for the application logic implementation
----Cache // Cache implementation, which will be removed and extracted to the Snail project later.
----Interceptor //Interceptor implemented by default
----BaseService.cs //The base class of each service contains the common methods of each service, such as CRUD
----InitDatabaseService.cs // Responsible for database data initialization
----InterceptorService.cs //Interceptor base class

--Web // Responsible for all related processing of input and output of interface parameters (such as parameter verification, output format reservation, etc.)
----AutoFacModule // autofac injection configuration
----AutoMapperProfiles // automapper configuration
----ClientApp // Front-end project
------build // Output directory generated by front-end compilation
------mock // Front-end mock
------src // Front-end core code
----CodeGenerater //T4 module and related logic for code generation
----ConfigureServicesExtensions // ServiceProvider injection extensions to avoid writing them in the startup file
----Controllers //Controllers
----docs // Document set
----Dto // The dto class will only be used in the web layer
----Filter // filter
----Hubs // signalr
----Permission //Default implementation of permissions
----staticFile // Used to store uploaded files

Overall structural design of the project

DDD is used, but different technologies of DDD must be applied according to the size of the project. Generally speaking, it is divided into the following projects

• Service: Service layer, used to implement the service interface in ApplicationCore, the main layer for the application logic implementation
• Infrastructure layer: Basic layer. This layer is reused in different projects. It relies on the interface convention of the ApplicationCore layer to provide data services for the upper layers (such as the service layer and application layer). At the same time, the universal data access interface of IDAL is implemented.
• ApplicationCore layer: application logic layer, DDD mode, contains all business logic and does not depend on other layers
• Web layer: Responsible for all related processing of input and output of interface parameters (such as parameter verification, output format reservation, etc.), and calls to the Application/DAL layer.

Universal data permissions and verification

WEB layer

• Responsible for input and output parameter processing, exception interception, and web caching
• For data operations of query statistics type, the DAL layer can be directly called.
• Configuration of development and test environments can be separated

Parameter verification --implemented

• Using Microsoft's interface --implemented

Output convention --implemented

• HTTP Status Code follows the status code convention, 20x is success (the interface has been called successfully), 40x is request error (business exception, unauthorized, etc.), 50x is server error (server exception) -- implemented
• The returned result content is mainly in the actual data format required by the front end, which is a json object; if it is an error message, the error content is returned. --Achieved

Exception handling --implemented

• Exception handling uses Microsoft technology, refer to https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/error-handling?view=aspnetcore-2.2
• All exceptions will not be caught
• Business exceptions are prompted to the outside. Server exceptions are intercepted and prompted to the outside. The prompt output format follows the output convention.

swagger -- implemented

• Use NSwagger

ApplicationCore layer

• This project does not depend on any other projects, use a clean architecture, refer to: https://docs.microsoft.com/zh-cn/dotnet/standard/modern-web-apps-azure-architecture/common-web-application- architectures

cache

• ICache interface implements redis, memcached, memoryCache, etc. You can consider using easycaching.
• Use AOP for caching to avoid writing caching logic in each method. easycaching+autofac
• Cache updates are event-driven and third-party components are introduced. easycaching+cap

Domain driven

Domain driven, if it depends on other layers, it depends on the interface of the corresponding layer rather than the implementation.

AOP -- implemented

• For AOP entry into logs and caches, consider using autofac

IOC -- implemented

• Use autofac

Memory table --implemented

• Store tables that change infrequently and have relatively small amounts of data in memory (not caches, but objects), and use event-driven thinking to synchronize the latest data.

event

• publish and subscribe
• Use cap to switch between distributed and single applications

Log processing --implemented

• Use nlog

command bus --implemented

• Use Mediatr

DAL layer

• Responsible for all data-related operations
• Encapsulate common data access interfaces and implementations, such as using EF to implement the following functions
• Use the idea of ​​interface-oriented programming to expand the DAL layer using technologies other than EF in the future.
• Using the Repository mode, in fact, EF itself is a Repository mode, but in order to uniformly intercept and apply its own logic at the level of database access operations, it then uses its own Repository to encapsulate EF
• Single table query, paging
• Simple relational query of multiple tables, paging
• Simple CRUD

automapper

• Reference automapper for object assignment and conversion
• Implement the expression-based objectmapper class for simple object assignment, making up for the shortcomings of automapper's complex configuration and low performance using reflection.

Use of EF

• EF execution sql language log**--implemented**
• For enumeration types, use EF's ValueConverter technology to automatically convert them. It is agreed that the type stored in the database is string type instead of Int type, which is convenient for understanding**--Implemented**

real time communication

• Use signalr

Technology selection

transaction processing

Use repository and unit of work modes, but use the repository mode that comes with EF.

Database processing method

• Use EF for data processing and do not consider other methods.

Front-end interface

• Put it into the web project and use spa method

need to do

• Unit test injection
• The service layer should not be in the web layer, but applicationcore

multilingual

Various technical details

CAP

• The original implementation of CAP does not support autofac very well. In this project, SnailCapConsumerServiceSelector is written to handle it.
• CAP natively treats Controllers and non-Controllers differently. Controllers only need to add the CapSubscribe attribute to the method, while Controllers need to implement the ICapSubscribe interface on the class and add the CapSubscribe attribute to the method.

How to use

1. git clone this project 2. Configure codeGenerate.json 3. Run this project, and after logging in to swagger, run the codeGenerate interface 4. Run add-migration 5. Start the project

Tutorial blog post

SnailAspNetCoreFramework Framework Series Blog
1. Introduction and general design ideas of each project and directory within the framework - SnailAspNetCoreFramework rapid development framework
2. Interface input verification, output format, and exception handling—SnailAspNetCoreFramework rapid development framework backend design
3. Universal permission design - SnailAspNetCoreFramework rapid development framework back-end design
4. How to provide good interface documents (Swagger) to the front-end - SnailAspNetCoreFramework rapid development framework back-end design
5. Cache usage in various scenarios—SnailAspNetCoreFramework rapid development framework backend design
6. Castle-based AOP design and common cache, performance, log interceptor implementation - SnailAspNetCoreFramework rapid development framework back-end design
7. Introduction to dependency injection - autofac - SnailAspNetCoreFramework rapid development framework back-end design
8. Why use Eventbus and how to use it - SnailAspNetCoreFramework rapid development framework back-end design
9. Introduction to Nlog, the log component - SnailAspNetCoreFramework rapid development framework back-end design
10.Mediatr introduction - SnailAspNetCoreFramework rapid development framework back-end design
11. Universal CRUD design for controller, service, and dal layers—SnailAspNetCoreFramework rapid development framework backend design
12. Object mapping tool automapper - SnailAspNetCoreFramework rapid development framework back-end design
13. How to monitor the sql statements generated by EF - SnailAspNetCoreFramework rapid development framework back-end design
14. Introduction to several deployment methods of .net core - SnailAspNetCoreFramework rapid development framework back-end design
15. real-time communication signalr - SnailAspNetCoreFramework rapid development framework back-end design
16. How to use ef code first to continuously iterate the database version of the project - SnailAspNetCoreFramework rapid development framework back-end design
17. Introduction to the automatic code generation function—SnailAspNetCoreFramework rapid development framework back-end design
18. How to monitor whether each function of the project is normal (HealthCheck) - SnailAspNetCoreFramework rapid development framework back-end design
19. Introduction to hangfire for scheduled tasks—SnailAspNetCoreFramework rapid development framework backend design
20. Overall introduction to the front-end—SnailAspNetCoreFramework rapid development framework front-end design
21. No more begging for back-end interfaces (use of MOCK) - SnailAspNetCoreFramework rapid development framework front-end design
22. Front-end permission control - SnailAspNetCoreFramework rapid development framework front-end design
23. How to avoid repeatedly writing front-end CRUD code (introduction and use of various SnailXXX components in the front-end) - SnailAspNetCoreFramework rapid development framework front-end design
24. Introduction to request proxy - SnailAspNetCoreFramework rapid development framework front-end design