Extenso.Data.Entity 9.4.0

<img src="https://github.com/gordon-matt/Extenso/blob/master/_Misc/ExtensoLogo.png" alt="Logo" width="250" />

Extenso.Data.Entity

Intro

This package contains a generic IRepository<TEntity> and IMappedRepository<TModel, TEntity> implementations for Entity Framework, as well as other data-related extension methods and helper classes.

Getting Started

The first thing you're going to need to do is have an IDbContextFactory implementation. Example:

public class ApplicationDbContextFactory : IDbContextFactory
{
    private readonly IConfiguration configuration;

    public ApplicationDbContextFactory(IConfiguration configuration)
    {
        this.configuration = configuration;
    }

    private DbContextOptions<ApplicationDbContext> options;

    private DbContextOptions<ApplicationDbContext> Options
    {
        get
        {
            if (options == null)
            {
                var optionsBuilder = new DbContextOptionsBuilder<ApplicationDbContext>();
                optionsBuilder.UseSqlServer(configuration.GetConnectionString("DefaultConnection"));
                options = optionsBuilder.Options;
            }
            return options;
        }
    }

    public DbContext GetContext() => new ApplicationDbContext(Options);

    public DbContext GetContext(string connectionString)
    {
        var optionsBuilder = new DbContextOptionsBuilder<ApplicationDbContext>();
        optionsBuilder.UseInMemoryDatabase(connectionString);
        return new ApplicationDbContext(optionsBuilder.Options);
    }
}

Next, you can register the EntityFrameworkRepository in your dependency injection container. An example:

// Regular direct to entity repository:
services.AddScoped(typeof(IRepository<>), typeof(EntityFrameworkRepository<>));

// Mapped repository, which maps between entities and models:
services.AddScoped(typeof(IMappedRepository<,>), typeof(ExtensoMapperEntityFrameworkRepository<,>));

// Or using the Extenso.Data.Entity.AutoMapper package, you could do this:
services.AddScoped(typeof(IMappedRepository<,>), typeof(AutoMapperEntityFrameworkRepository<,>));

Now just inject the repository into your classes and use it:

public class BlogService
{
    private readonly IRepository<BlogCategory> blogCategoryService;
    private readonly IRepository<BlogPost> blogPostService;
    private readonly IRepository<BlogTag> blogTagService;
    
    public BlogCategoryService(
        IRepository<BlogCategory> blogCategoryService,
        IRepository<BlogPost> blogPostService,
        IRepository<BlogTag> blogTagService)
    {
        this.blogCategoryService = blogCategoryService;
        this.blogPostService = blogPostService;
        this.blogTagService = blogTagService;
    }

    public async Task<IEnumerable<BlogCategory>> GetCategoriesAsync(int tenantId) =>
        await blogCategoryService.FindAsync(new SearchOptions<BlogCategory>
        {
            Query = x =>
                x.TenantId == tenantId,

            Include = query => query
                .Include(x => x.Posts)
                .ThenInclude(x => x.Tags),

            OrderBy = query => query.OrderBy(x => x.Name),

            SplitQuery = true, // Optional, defaults to false
        });

    // etc...
}

All CRUD operations are supported, including paging, searching, and sorting. Even projections are supported via method overloads of Find(), FindAsync(), FindOne(), and FindOneAsync().

Limitations

The mapped repositories are currently unable to support filtered includes. Either use the normal IRepository<> which does support that, or cast your IMappedRepository<,> to the relevant implementation and use GetContext() to run your own advanced queries that way. Example:

var efRepository = repository as ExtensoMapperEntityFrameworkRepository<ProductModelViewModel, ProductModel>;
using var context = efRepository.GetContext();
var advancedQuery = context.Set<ProductModel>()
    .Include(x => x.Products)
        .ThenInclude(x => x.ProductSubcategory)
    .Include(x => x.ProductModelIllustrations)
    .AsSplitQuery()
    .IgnoreAutoIncludes()
    .TagWith("My advanced query!")
    .Where(x => x.ModifiedDate >= DateTime.UtcNow.AddYears(-10))
    .ToList()
    .Select(x => x.MapTo<ProductModelViewModel>())
    .ToList();

Or simply just use your DbContext without any repository for those situations.