OfX-EFCore 3.1.0

OfX.EntityFrameworkCore

OfX.EntityFrameworkCore is an extension package for OfX that integrates with Entity Framework Core to simplify data fetching by leveraging attribute-based data mapping. This extension streamlines data retrieval using EF Core, reducing boilerplate code and improving maintainability.

Demo Project!

Introduction

OfX.EntityFrameworkCore extends the core OfX library by providing seamless integration with Entity Framework Core. This enables developers to automatically map and retrieve data directly from a database, leveraging the power of EF Core along with attribute-based data mapping.

For example, suppose you have a UserId property in your model, and you want to fetch the corresponding UserName and Email fields from the database. By using OfX.EntityFrameworkCore, you can annotate your model with attributes, and the library will handle data fetching for you.

Installation

To install the OfX.EntityFrameworkCore package, use the following NuGet command:

dotnet add package OfX-EFCore

Or via the NuGet Package Manager:

Install-Package OfX-EFCore

How to Use

1. Register OfX.EntityFrameworkCore

Add OfX.EntityFrameworkCore to your service configuration during application startup:

builder.Services.AddOfXEntityFrameworkCore(cfg =>
{
    cfg.AddAttributesContainNamespaces(typeof(WhereTheAttributeDefined).Assembly);
    cfg.AddHandlersFromNamespaceContaining<SomeHandlerAssemblyMarker>();
})
.AddOfXEFCore(options =>
{
    options.AddDbContexts(typeof(TestDbContext));
    options.AddModelConfigurationsFromNamespaceContaining<SomeModelAssemblyMarker>();
});

After installing the package OfX-EFCore, you can use the method AddDbContexts(), which takes DbContext(s) to executing.

2. Mark the model you want to use with OfXAttribute

Example:

[OfXConfigFor<UserOfAttribute>(nameof(Id), nameof(Name))]
public class User
{
    public string Id { get; set; }
    public string Name { get; set; }
    public string Email { get; set; }
}

That all! Let go to the moon!

Note: Currently, the Id type is supported for primitive type, in the next version. The strongly-type should be supported!