QDev.CSharp.EFCore.RepositoryPattern 1.0.1

Database Manager EFCore Repository Pattern

A library for implementing generic repositories and unit of work with Entity Framework Core. This implementation uses a single instance of the DbContext for all repositories to avoid concurrency issues.

Table of Contents

• Installation
• Creating the DbContext
• Injecting the Repository Pattern
• Creating the Service
• IUnitOfWork methods
• IRepository methods

Installation

Using the NuGet package manager console within Visual Studio run the following command:

Install-Package QDev.CSharp.EFCore.RepositoryPattern

Or using the .NET Core CLI from a terminal window:

dotnet add package QDev.CSharp.EFCore.RepositoryPattern

Creating the DbContext

Create your DbContext inheriting from Microsoft.EntityFrameworkCore.DbContext:

public class MyDbContext : DbContext
{
    public DbSet<Product> Products { get; set; }  

    protected override void OnModelCreating(ModelBuilder modelBuilder)
	{
		modelBuilder.ApplyConfigurationsFromAssembly(Assembly.GetExecutingAssembly());
		base.OnModelCreating(modelBuilder);
	}
}

Configure your DbContext in the Program class:

builder.Services.AddDbContext<DbContext, SuinQShopModuleDbContext>(opt =>
    {
        opt.UseSqlServer(builder.Configuration.GetConnectionString("ConnectionString"));
    });

Injecting the RepositoryPattern's Services

Add the RepositoryPattern services to the Service Collection:

builder.Services.AddRepositoryPattern();

Creating the Service

To keep it simple, consider using the Service<TEntity> form. This approach allows you to create a generic Service<TEntity> class where you implement fundamental CRUD functionalities, reducing code repetition. As a result, specific services for each table can inherit CRUD functionalities from Service<TEntity> and focus solely on their unique implementations.

Here's an example of how you should implement the Service class:

public class MyService
{
    private readonly IUnitOfWork _unitOfWork;

	public MyService(IServiceProvider services) 
	{ 
	    var scoped = provider.CreateScope();
	    _unitOfWork = scoped.ServiceProvider.GetRequiredService<IUnitOfWork>();
	}

	public async Task<MyEntity> CreateMyEntity(MyEntity entity, CancellationToken cancellationToke = default) 
	{
		var newEntity await _unitOfWork.Repository<TEntity>().InsertOneAsync(entity, cancellationToken);
		await _unitOfWork.SaveAsync(cancellationToken);
		return newEntity;
	}

	// and more methods as needed
}

UnitOfWork

Key Aspects

• IUnitOfWork represents a unit of work for coordinating and managing database operations using Entity Framework Core.
• It serves as a central hub for working with the database context, repositories, and transactions.

Functions

Repository methods

Here's the markdown documentation for the second interface:

Description

IRepository<TEntity> represents a repository for managing entities of type TEntity within an Entity Framework Core context.

Type Parameter

• TEntity: The type of entities managed by this repository.

Functions

Please note that some functions include optional parameters, and there are exception descriptions for error handling.

Type Parameters

• TEntity: The type of entities managed by this repository.