Вопрос о создании репозитория C#

Question

Я пишу Eatal4 для создания веб-приложения MVC 2, и мне нужны предложения по выбору классов наследования и абстрактных базовых классов. Мой репозиторий хорошо работал после структуры «generic repo», но теперь я хочу добавить функциональность «Аудит», которая записывает каждый раз, когда выполняется операция CRUD.

Это контракт я использовал до сих пор:

public interface IRepository<T> 
{ 
    void Create(T entity); 
    void Update(T entity); 
    void Delete(Func<T, bool> predicate); 
    T Get(Func<T, bool> predicate); 
    IQueryable<T> Query(); 
} 

Мой репо. реализация выглядит следующим образом:

sealed class EFRepository<TEntity> : IRepository<TEntity> 
    where TEntity : EntityObject 
{ 
    ObjectContext _context; 
    ObjectSet<TEntity> _entitySet; 

    public EFRepository(ObjectContext context) 
    { 
     _context = context; 
     _entitySet = _context.CreateObjectSet<TEntity>(); 
    } 

    public void Create(TEntity entity) 
    { 
     _entitySet.AddObject(entity); 
     _context.SaveChanges(); 
    } 

    public void Update(TEntity entity) 
    { 
     _entitySet.UpdateObject(entity); 
     _context.SaveChanges(); 
    } 

    public void Delete(Func<TEntity, bool> predicate) 
    { 
     TEntity entity = _entitySet.Single(predicate); 
     _entitySet.DeleteObject(entity); 
     _context.SaveChanges(); 
    } 

    public TEntity Get(Func<TEntity, bool> predicate) 
    { 
     return _entitySet.SingleOrDefault(predicate); 
    } 

    public IQueryable<TEntity> Query() 
    { 
     return _entitySet; 
    } 
} 

Я хочу создать концепцию AuditableRepository<T>. Должен ли я создать его так:

interface IAuditable<T> 
interface IRepository<T> 
AuditableRepository<T> : IRepository<T>, IAuditable<T> 
EFRepository<T> : AuditableRepository<T> 

или лучше иметь это так:

interface IAuditable<T> 
interface IRepository<T> 
EFRepository<T> : IRepository<T>, IAuditable<T> 

или даже:

interface IAuditable<T> 
interface IRepository<T> 
AuditableRepository<T> : IRepository<T>, IAuditable<T> 
EFRepository<T> : IRepository<T> 
AuditableEFRepository<T> : AuditableRepository<T> 

Не все мои EFRepositories должны быть аудит. Как мне продолжить?

Answer 1

Вот еще одна возможность (с помощью объекта декоратор добавить дополнительную функциональность существующего хранилища):

public sealed class Auditor<T> : IRepository<T> 
{ 
    private readonly IRepository<T> _repository; 

    public Auditor(IRepository<T> repository) 
    { 
     _repository = repository;  
    } 

    public void Create(T entity) 
    { 
     //Auditing here... 
     _repository.Create(entity); 
    } 

    //And so on for other methods... 
} 

Преимущество использования декоратора, чтобы добавить дополнительные функции, в том, что она позволяет избежать комбинаторного взрыва вы начали см., когда вы рассматривали некоторые репозитории с аудитом, некоторые без, некоторые используют EF, некоторые - нет. Это становится все хуже с каждой новой функцией, которая может или не может применяться, часто в конечном итоге превращаясь в флаги конфигурации и беспорядочное внутреннее ветвление.

Answer 2

Ничто не кажется идеальным решением, поскольку Дэн говорит, что может столкнуться с проблемой с различными комбинациями интерфейсов. Функции аудита не звучат так, как будто это действительно должно быть частью класса. Я думаю, вместо того, чтобы идти с подходом Дэна, хотя я бы объявил и пожаловал события вообще в репозитории. Таким образом, вы могли бы подключить к нему много разных вещей, гораздо более гибкие. Поэтому объявляйте такие события, как «Создано», «Удалено» и т. Д.

В будущем он также позволяет некоторым действительно приятным функциям с помощью таких реактивных расширений.

Answer 3

Прежде всего, если ваш Repository<T> не имеет общих функций (у вас есть только абстрактные методы и нет реализации там), первое, что я хотел бы сделать, это избавиться от него. Лучше всего, чтобы все остальные части вашей программы обращались к репозиторию только через интерфейс IRepository<T>, что даст вам большую свободу позже.

Вторая вещь, имеющая класс EFRepository, подразумевает, что вы хотите оставить возможность переключаться на другую ORM один день. Мое мнение - не делай этого. Если вы выбрали EF, придерживайтесь EF. Если вы действительно думаете, что это вариант, по крайней мере, создайте отдельную сборку с пространством имен MyApp.EntityORM или любым другим, поместите все свои классы репозитория и избавитесь от префикса EF. Затем, если это когда-либо дойдет до этого, вы, возможно, однажды загрузите правильный ORM через инъекцию зависимости, не изменяя остальную часть вашего кода.

Из моего опыта: между ORM могут быть тонкие различия, которые мешают вам перевязать их по-настоящему прозрачным способом, и мало шансов, что вам нужно будет когда-либо изменить ORM для одного проекта.

Во-вторых, я также предпочитаю использовать базовую функциональность базового репозитория в другом классе (шаблон Decorator, как уже сказал Дэн Брайант), в отличие от переопределения уже существующего класса. Причина в том, что переопределение часто приводит к тому, что приходится иметь дело с внутренними элементами базового класса, и иногда это может стать немного беспорядочным.

Из Вашего вопроса, то не совсем ясно, как «проверяемым репозиторий» должен вести себя, но если это просто обычный IRepository<T> (это аудит всех методы, реализованные в IRepository<T>), то вам не нужен отдельный интерфейс :

interface IRepository<T> 
class Repository<T> : IRepository<T> 
class AuditableRepository<T> : IRepository<T> 

Добавление к тому, что сказал Дэн, вы могли бы иметь фабричный метод, который позволит создать соответствующую обертку:

class AuditableRepository<T> : IRepository<T> 
{ 
    public static IRepository<T> CreateFrom(IRepository<T> baseRepo) 
    { 
      // wrap base repo in an auditable repository 
      // and return it 
      return new AuditableRepository<T>(baseRepo); 
    } 
} 

Answer 4

будет ли это важно, является ли проверяемым хранилище или нет? Значит, вам нужно знать, является ли репозиторий IAuditableRepository или просто IRepository? Если нет, вы можете использовать DI и добавить конструктор, который принимает IAuditor. Затем в ваших методах репозитория, если доступно IAuditor, вы можете его использовать.

sealed class EFRepository<TEntity> : Repository<TEntity> 
    where TEntity : EntityObject 
{ 
    ObjectContext _context; 
    ObjectSet<TEntity> _entitySet; 
    IAuditor _auditor; 

    public EFRepository(ObjectContext context) : this(context, null) 
    { 
    } 
    public EFRepository(ObjectContext context, IAuditor auditor) 
    { 
     _context = context; 
     _entitySet = _context.CreateObjectSet<TEntity>(); 
     _auditor = auditor; 
    } 
    public override void Create(TEntity entity) 
    { 
     _entitySet.AddObject(entity); 
     _context.SaveChanges(); 

     if (_auditor != null) 
     { 
      // audit 
     } 
    } 

    // etc. 
}