This .NET project Flexc demonstrates concept of separation of concerns (SOC) and is a simple implementation of the Clean Architecture. When installed and used to create a new project, all references to Flexc will be replaced with the name of your project.
The Core project contains all domain entities and service layer interfaces and has no dependencies.
Password hashing functionality added via the Flexc.Core.Security.Hasher class. This is used in the Data project UserService to hash the user password before storing in database.
The Data project encapsulates all data related concerns. It provides an implementation of Flexc.Core.Services.IUserService using EntityFramework to handle data storage/retrieval. It defaults to using Sqlite for portability across platforms.
The Service is the only element exposed from this project and consumers of this project simply need reference it to access its functionalty.
The Test project references the Core and Data projects and should implement unit tests to test any service implementations created in the Data project. A flexc test is provided for implementation of IUserService and the tests should be extended to fully exercise the functionality of your Service.
The Web project uses the MVC pattern to implement a web application. It references the Core and Data projects and uses the exposed services and models to access data management functionality. This allows the Web project to be completely independent of the persistence framework used in the Data project.
The project provides extension methods to enable:
- User Identity using cookie authentication is enabled without using the boilerplate flexc used in the standard web projects (mvc,web). This allows the developer to gain a better appreciation of how Identity is implemented. The core project implements a User model and the data project UserService implementation provides user management functionality such as Authenticate, Register, Change Password, Update Profile etc.
The Web project implements a UserController with actions for Login/Register/NotAuthorized/NotAuthenticated etc. The AuthBuilder helper class defined in Flexc.Web.Helpers provides a BuildClaimsPrinciple method to build a set of user claims for User Login action when using cookie authentication and this can be modified to amend the claims added to the cookie.
To enable cookie Authentication the following statement is included in Program.cs.
builder.Services.AddCookieAuthentication();Then Authentication/Authorisation are then turned on in the Application via the following statements in Program.cs
app.UseAuthentication();
app.UseAuthorization();-
Any Controller that inherits from the Web project BaseController, can utilise:
a. The Alert functionality. Alerts can be used to display alert messages following controller actions. Review the UserController for an example using alerts.
Alert("The User Was Registered Successfully", AlertType.info); -
A ClaimsPrincipal authentication extension method
User.GetSignedInUserId()- returns Id of current logged in user or 0 if not logged in
-
Two custom TagHelpers are included that provide
a. Authentication and authorisation Tags
-
<p asp-authorized>Only displayed if the user is authenticated</p> -
<p asp-roles="admin,manager">Only displayed if the user has one of specified roles</p>
Note: to enable these tag helpers Program.cs needs following service added to DI container
builder.Services.AddHttpContextAccessor();b. Conditional Display Tag
<p asp-condtion="@some_boolean_expression">Only displayed if the condition is true</p>
-
To install this solution as a flexc (flexc name is termonclean)
-
Download current version of the flexc
$ git clone https://github.com/termon/DotNetFlexc.git -
Install the flexc so it can be used by
dotnet newcommand. Use the path (i.e the directory location)to the cloned flexc directory without trailing '/'
Linux/macOS
$ dotnet new -i /path/DotNetFlexc
Windows
c: dotnet new -i c:\path\DotNetFlexc
-
Once installed you can create a new project using this flexc
dotnet new termonclean -o SolutionName