GenericEntity 0.1.0

Generic Entity

A library to manage EF Core entity easier without adding DbSet<T> of every single entity into database context

Features

• No need to write each entity field on DbContext
• Support multiple database
• Cleaner query invoke

Setup

First, create interface that represent entity of database, then implement IEntity<br>

public interface ISampleEntity : IEntity { }

Second, create interface that represent db context that implement IAppDbContext<TEntity>, where T is interface of entity that created before

public interface ISampleDbContext : IAppDbContext<ISampleEntity> { }

Third, create entity class that impelement interface entity above

public class Blog : ISampleEntity
{
    public string Id { get; set; }
    public string Title { get; set; }
    public string Content { get; set; }
}

Forth, create db context class that inherit from AppDbContext<TContext> and implement interface db context that created before, where TContext is db context itself

public class SampleDbContext : AppDbContext<SampleDbContext>, ISampleDbContext
{
    public SampleDbContext() : base() { }
    public SampleDbContext(DbContextOptions<SampleDbContext> options) : base(options) { }
    
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.ApplyEntityRegistration();
    }

    DbSet<UEntity> IAppDbContext<ISampleEntity>.Entity<UEntity>()
    {
        return Set<UEntity>();
    }
}

Note: You need to override OnModelCreating and Entity method like above to make this library work

ApplyEntityRegistration() will make sure each class that implement interface entity (first step) is migrated into database, and Set<T> is to return field entity on db context.

Lastly (optional), register interface db context and db context into service container

services.AddScoped<ISampleDbContext, SampleDbContext>();

Usage

Instead of inject db context instance (when using DI), you can inject interface db context (second step) into constructor

public class BlogController : Controller
{
    private readonly ISampleDbContext _dbContext;

    public BlogController(ISampleDbContext dbContext)
    {
        _dbContext = dbContext;
    }

    ...
}

And then invoke method Entity<TEntity> when query to some entity

public class BlogController : Controller
{
    ...

    [HttpGet("{id}")]
    public async Task<IActionResult> ReadDetail(string id, CancellationToken ct)
    {
        var blog = await _dbContext.Entity<Blog>()
            .Where(x => x.Id == id)
            .FirstOrDefaultAsync(ct);

        return new OkObjectResult(blog);
    }
}