Franz.Common.EntityFramework 1.4.4

Franz.Common.EntityFramework

A comprehensive library within the Franz Framework, designed to extend and simplify the integration of Entity Framework Core in .NET applications. It provides clean abstractions, auditing, soft deletes, repositories, and seamless integration with Franz Business and Mediator packages.

Features

• Database Configurations*

  • Flexible options for Cosmos DB (CosmosDBConfig) and MongoDB (MongoDBConfig).
  • Centralized management of connection settings (DatabaseOptions).

• Repositories (Separation of Entity and Aggregate Repositories)

  • EntityRepository<TEntity>: CRUD operations for standalone entities.
  • AggregateRepository<TAggregateRoot>: For event-sourced aggregates.
  • ReadRepository<T>: Optimized read-only data access.

• DbContextBase (🆕 canonical context)

  • Built-in auditing (CreatedBy, CreatedOn, LastModifiedBy, LastModifiedOn).
  • Soft deletes (IsDeleted, DeletedBy, DeletedOn) with global query filters.
  • Domain event dispatching via Franz Mediator.
  • Removes the need for SaveEntitiesAsync – now everything happens in SaveChangesAsync.

• Conversions

  • EnumerationConverter: Easily map domain enumerations to EF Core-friendly values.

• Extensions

  • ModelBuilderExtensions: Simplify entity configuration.
  • ServiceCollectionExtensions: Wire up repositories and context with DI.

Version Information

• Current Version: 1.4.3
• Part of the private Franz Framework ecosystem.

🆕 DbContextBase Example

public class AppDbContext : DbContextBase
{
    public AppDbContext(DbContextOptions<AppDbContext> options, IDispatcher dispatcher, ICurrentUserService currentUser)
        : base(options, dispatcher, currentUser)
    {
    }

    public DbSet<Order> Orders => Set<Order>();

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

Key behaviors

• Automatically sets CreatedBy / CreatedOn when entities are added.
• Automatically sets LastModifiedBy / LastModifiedOn when entities are updated.
• Marks IsDeleted / DeletedOn / DeletedBy instead of physical deletes.
• Dispatches domain events after each save.

Repositories

1️⃣ Entity Repository (CRUD Operations)

public class OrderRepository : EntityRepository<AppDbContext, Order>
{
    public OrderRepository(AppDbContext dbContext) : base(dbContext) { }
}

✅ Best for:

• Entities that don’t require aggregate consistency.
• Simple CRUD operations.

2️⃣ Aggregate Repository (Event-Sourced Aggregates)

public class ProductRepository : AggregateRepository<AppDbContext, Product, ProductEvent>
{
    public ProductRepository(AppDbContext dbContext, IEventStore eventStore)
        : base(dbContext, eventStore) { }
}

✅ Best for:

• Aggregates requiring event sourcing.
• Complex domain rules.
• Systems that replay history for consistency.

3️⃣ Choosing the Right Repository

Auditing & Soft Deletes

All entities deriving from Franz’s Entity<TId> automatically get:

• CreatedOn, CreatedBy
• LastModifiedOn, LastModifiedBy
• IsDeleted, DeletedOn, DeletedBy

Example Entity

public class Order : Entity<Guid>
{
    public string CustomerName { get; private set; } = string.Empty;
    public decimal TotalAmount { get; private set; }

    // Domain behavior...
}

EF Core automatically filters out IsDeleted entities via a global query filter.

Installation

From Private Azure Feed

dotnet nuget add source "https://your-private-feed-url" \
  --name "AzurePrivateFeed" \
  --username "YourAzureUsername" \
  --password "YourAzurePassword" \
  --store-password-in-clear-text

Install the package:

dotnet add package Franz.Common.EntityFramework

Integration with Franz Framework

• Franz.Common.Business → DDD & CQRS building blocks.
• Franz.Common.Mediator → Pipeline behaviors & domain event dispatching.
• Franz.Common.Errors → Standardized error handling.

Contributing

This package is part of a private framework. Contributions are limited to the internal team.

1. Clone the repository: GitHub - Franz.Common
2. Create a feature branch.
3. Submit a pull request.

License

Licensed under the MIT License.

Changelog

1.4.2

• 🗑️ Removed DbContextMultiDatabase (use DbContextBase instead).
• 🗑️ Removed SaveEntitiesAsync (merged into SaveChangesAsync).
• ✅ Unified auditing, soft deletes, and domain events under DbContextBase.

1.4.1

• Patch bump (package cleanup & docs).

1.4.0

• Migrated to C# 12 typing rules.
• Introduced auditing and soft delete handling in DbContextBase.
• Aligned EnumerationConverter with stricter typing constraints.

1.2.65

• Split repositories into EntityRepository and AggregateRepository.
• Upgraded to .NET 9.

1.3

• Upgraded to .NET 9.0.8.
• Added new features and improvements.
• Separated business from mediator concepts.
• Compatible with Franz mediator and MediatR.