This project provides a simple, attribute-based hooking system for all projects using all versions of Microsoft's Entity Framework Core 2.1 and above.
Make sure you have Nuget installed, the run
PM> Install-Package EFCoreHooks
First you must edit your ConfigureServices(IServiceCollection) so the hooking system can have access
to the Dependency Injection Container
using EFCoreHooks;
/* ... */
public void ConfigureServices(IServiceColleciton services) {
/* ... */
services.ConfigureDbHooks();
/* ... */
}In most cases the only other thing you need to do is to have any dbcontext that you want to have hooks
extends from HookedDbContext or HookedIdentityDbContext. Both classes are designed to be drop-in
replacements for DbContext and IdentityDbContext respectively.
In cases where you need a base class other than DbContext or IdentityDbContext, you can use the
extension methods directly by implementing IHookedDbContext, and overriding the SaveChanges and
SaveChagnesAsync methods to call the extension methods instead of the base class.
public override int SaveChanges(bool acceptAllChangesOnSuccess)
{
return this.HookedSaveChanges(acceptAllChangesOnSuccess);
}
public override Task<int> SaveChangesAsync(bool acceptAllChangesOnSuccess,
CancellationToken cancellationToken = default(CancellationToken))
{
return this.HookedSaveChangesAsync(acceptAllChangesOnSuccess, cancellationToken);
}Implementing the IHookedDbContext interface is quite simple:
public class HookedDbContext : DbContext, IHookedDbContext
{
public HookedDbContext(DbContextOptions options, HookManagerContainer hooks) : base(options)
{
Hooks = hooks;
Hooks.InitializeForAll(this);
}
public HookManagerContainer Hooks { get; }
public int SaveChangesBase(bool acceptAllChanges)
{
// Mirror the base classes saved changes so the extension methods can access them
return base.SaveChanges(acceptAllChanges);
}
public Task<int> SaveChangesBaseAsync(bool acceptAllChanges,
CancellationToken cancellationToken = default(CancellationToken))
{
// Mirror the base classes saved changes so the extension methods can access them
return base.SaveChangesAsync(acceptAllChanges, cancellationToken);
}
public override int SaveChanges(bool acceptAllChangesOnSuccess)
{
// Run the extension method instead of the base class's method
return this.HookedSaveChanges(acceptAllChangesOnSuccess);
}
public override Task<int> SaveChangesAsync(bool acceptAllChangesOnSuccess,
CancellationToken cancellationToken = default(CancellationToken))
{
// Run the extension method instead of the base class's method
return this.HookedSaveChangesAsync(acceptAllChangesOnSuccess, cancellationToken);
}
}The following hooks are available via attributes attached to static methods:
[OnBeforeCreate]- Before Model Created[OnBeforeUpdate]- Before Model Modified[OnBeforeSave]- Before Model Created or Modified[OnBeforeDelete]- Before Model Delete[OnAfterCreate]- Before Model Created[OnAfterUpdate]- Before Model Modified[OnAfterSave]- Before Model Created or Modified[OnAfterDelete]- Before Model Delete
Each hook has a simple dependency injection container with the following types:
| Type | Value |
|---|---|
EntityType |
The EntityType provided by the ChangeTracker |
<Your DbContext> |
The DbContext the entity is part of. You may use DbContext if you just need the common properties |
<Model Type> |
The entity object that trigger this hook. |
IServiceProvider |
The main DI container your app is running in (useful for grabbing things like ILogger<>) |
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent