Where Should AddEntityCache Be Registered #10389

2 Answer(s)

• 

  0

  AI-Bot created 19 hours ago

  Support Team ABP Agent

  • AddEntityCache<TEntity, TKey>() is just a DI registration for IEntityCache<,>, so it should be placed in the module that defines/owns the entity (the bounded context/module where TEntity lives) and that is always included in your application.

    • In a typical layered solution, that means: YourProjectDomainModule (or a dedicated YourProjectDomainCachingModule if you prefer to keep registrations separated).
    • Reason: the cache is part of the domain’s read model optimization for that entity and should be available wherever the domain is used (HTTP API host, workers, tests, etc.) without duplicating registrations.

  • Do not put it into the EntityFrameworkCore module unless you have a very specific reason.

    • The entity cache is not an EF Core mapping/DbContext concern; it’s an application-wide service.
    • Registering it in the EFCore module can also lead to “it works only when EFCore module is referenced” coupling.

  • Do not put it into the Host module as the primary place.

    • Host is composition root; keeping the registration there makes the cache unavailable in other hosts (e.g., a background worker host) unless you remember to duplicate it.

  • If you consume IEntityCache<TEntity, TKey> from the Domain layer, registering it in the Domain module is the right choice (so the domain package guarantees that the cache service exists when the domain is used). The consuming layer doesn’t need to care where it’s registered as long as the module dependency chain includes the module that registers it.

  Example placement:

  using Microsoft.Extensions.DependencyInjection;
  using Volo.Abp.Modularity;
  
  namespace MyCompany.MyProject;
  
  public class MyProjectDomainModule : AbpModule
  {
      public override void ConfigureServices(ServiceConfigurationContext context)
      {
          context.Services.AddEntityCache<Product, Guid>();
          // context.Services.AddEntityCache<OtherEntity, int>();
      }
  }
  

  • Sources:
    • https://abp.io/docs/latest/framework/infrastructure/entity-cache
    • https://abp.io/docs/10.0//framework/infrastructure/entity-cache

  ---

  This response was generated by AI. If it didn’t solve your problem, feel free to post a new answer — our support team will jump in to help you soon.

  Save Cancel
• 

  0

  maliming created 19 hours ago

  Support Team Fullstack Developer

  hi

  Register and use entity cache in Domain layer.

  Thanks.

  Save Cancel