Автообнаружение и регистрация классов в StructureMap

20.02.201211.05.2012 по koissakh kadderah

Уровень подготовки по шкале MS: 400

Некоторое время назад я рассказывал про чудесный IoC\DI контейнер StructureMap. На тот момент я описал основные приемы работы, скорее как справочник, показавший возможности, без углубления в конкретные темы. На этот раз я хочу рассказать о возможности автоматического обнаружения и регистрации классов средствами StructureMap.

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

Дальнейшие примеры покажут, как работать с обнаружением только по интерфейсу\базовому классу, а так же как работать при именовании классов по соглашениям (Convention over Configuration).

Вводная

Сначала достаточно простой пример. Пусть у нас есть множество классов для трансляции данных из базы, все они наследованы от базового класса. Т.е. что-то в духе:

public class ClientAdapter : ReadOnlyAdapter&lt;Client, vClient&gt; {
...
}

public class InvoiceAdapter : WriteAdapter&lt;Invoice, vInvoice&gt; {
...
}

public class ClientAdapter : ReadOnlyAdapter<Client, vClient> {

...

}

public class InvoiceAdapter : WriteAdapter<Invoice, vInvoice> {

...

}

И таких классов достаточно много, всех их регистрировать вручную не очень хочется, т.к. это выглядит ужасно в коде и писать долго. Регистрация таких адаптеров может занять экран, а то и два. Гораздо лучше поднапрячь извилины и записать это в несколько строк.

Итак, StructureMap предоставляет метод Scan, который пробегает по интересующим нас сборкам или папкам и регистрирует подходящие объекты. Для того чтобы метод Scan нашел и зарегистрировал типы необходимо соблюдение нескольких условий:

Тип должен быть явным, дженерик типы не регистрируются автоматически;
Тип должен иметь публичный конструктор;
Конструктор не может иметь аргументов примитивных типов;
Множественное регистрирование не допускается.

Указание сборки для сканирования можно задать несколькими способами:

Явно прописать имя сборки или же передать ее саму;
Обратиться к вызывающей сборке;
Найти сборку содержащую определенный тип;
Найти сборки по определенному пути.

Подробнее

StructureMap 3/3

16.06.201115.06.2011 по koissakh kadderah

Конструкторы

Свойства

Тесты

Перехватчики

С версии 2.5+ появилась возможность постобработки только что созданного объекта, либо полной его замены. В данном случае не ставится целью создать еще одни AOP фреймворк, так как их уже достаточно в мире, просто это может облегчить жизнь.

Для постобработки существует два+ метода:

OnCreation – принимает в качестве параметра Action, позволяет провести свою (custom) инициализацию объекта. Есть доступ к контексту SturctureMap.
EnrichWith – принимает в качестве параметра Function. Может возвращать любой тип совместимый с запрашиваемым.
Свои перехватчики

Честно сказать, в простых примерах не очень хорошо получается передать разницу и преимущества использования OnCreation перед EnrichWith и наоборот.

OnCreation

Для демонстрации можно воспользоваться следующим простым классом:

public class ClassS : IClassS {
    public int Counter { get; private set; }

    public void Init() {
        Counter = -100;
    }

    public void Init(IClass1 class1) {
        Counter = -50;
    }

    public void Increase() {
       Counter++;
    }
}

public class ClassS : IClassS {

public int Counter { get; private set; }

public void Init() {

Counter = -100;

}

public void Init(IClass1 class1) {

Counter = -50;

}

public void Increase() {

Counter++;

}

Подробнее

StructureMap 2/3

13.06.201109.06.2011 по koissakh kadderah

содержание

Краткий план последующего материала выглядит следующим образом:

Конструкторы

Свойства

Время жизни
Перехватчики
- OnCreation
- EnrichWith

Дженерик типы
Аттрибуты
- DefaultConstructor
- ValidationMethod
- Все остальные

Тесты

Конструкторы

Очень важный вопрос в реальном программировании применительно к разрешению зависимостей в IoC контейнерах, как быть с классами, у которых несколько конструкторов. Как их инициализировать, как задавать параметры, как дорабатывать и прочее и прочее. Надеюсь что на большинство вопросов ниже будет дан ответ. StructureMap действительно мощная и гибкая штука.

Перед тем как начать описывать возможности фреймворка, надо поговорить о тестовых классах. В этот раз они будут сложнее. Наследование, конструкторы с простыми типами, с составными.

Итак, пусть у нас будут следующие классы:

public interface IClassA : IClass {
     int A { get; set; }
}

public interface IClassB : IClass {}

public class ClassA : IClassA {
    public int A { get; set; }
    public int B { get; set; }
    public Class1 Class1 { get; set; }

    [DefaultConstructor]
    public ClassA() {}

    public ClassA(int a) {
         A = a;
    }
}

public class ClassB : IClassB {
     public IClassA ClassA;

     public ClassB(IClassA classA) {
         ClassA = classA;
     }
}

public class ClassM : IClassA {
    public int A { get; set; }

    public ClassM(int a) {
        A = a;
    }

    public ClassM(int a, int b) {
        A = a + b;
    }
}

public interface IClassA : IClass {

int A { get; set; }

}

public interface IClassB : IClass {}

public class ClassA : IClassA {

public int A { get; set; }

public int B { get; set; }

public Class1 Class1 { get; set; }

[DefaultConstructor]

public ClassA() {}

public ClassA(int a) {

A = a;

}

public class ClassB : IClassB {

public IClassA ClassA;

public ClassB(IClassA classA) {

ClassA = classA;

}

public class ClassM : IClassA {

public int A { get; set; }

public ClassM(int a) {

A = a;

}

public ClassM(int a, int b) {

A = a + b;

}

Они с некоторой избыточностью на данный момент, которая пригодиться чуть дальше в повествовании.

Итак, начнем с самых простых вариантов.

Подробнее

StructureMap 1/3

10.06.201109.06.2011 по koissakh kadderah

Сегодня я хочу рассказать о IoC контейнере StructureMap, который мне приглянулся гораздо больше чем Unity. Хотя, честно сказать, мои взаимоотношения с Unity не сложились с самого начала, когда я увидел километровые файлы конфигурации к нему или же двухсот знаковые строки конфигурации в коде. Не будем о грустном.

StructureMap не только мне показался более удобным чем другие реализации DI\IoC, достаточно набрать в гугле StructureMap vs Unity и получить кучу ссылок, где люди обсуждают и показывают наглядно, что в работе самым удобным, гибким и естественным является StructureMap.

Ссылка раз, два и три

Ко всему прочему StructureMap еще и достаточно быстрый.

Вот еще очень интересные подборки материалов по сравнению фреймворков http://www.sturmnet.org/blog/2010/03/04/poll-results-ioc-containers-for-net

Я думаю можно опустить рассуждения о том, стоит ли такие контейнеры использовать в своем проекте или нет, и стоит ли писать свою реализацию. Я могу сказать, что в моей практике сначала случилось так, что были самописные реализации, которые заметно уступали по возможностям и удобству, но они решали свои конкретные задачи и этого на тот момент хватало. С развитием проекта, как-то было недосуг переводить все на какую-то другую технологию. Потом был Unity, Unity, но в конце концов я пришел к тому, что надо попробовать StructureMap и не пожалел об этом ни разу.

В чем, на мой взгляд, плюсы StructureMap:

Настройка с помощью DSL
Очень гибкая настройка всего
Простота конечного использования
Возможности по проверки внутренних связей
Поддержка тестирования out-of-the-box

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

Краткий план последующего материала выглядит следующим образом:

Установка
Регистрация

Конструкторы
- Простые типы
- Конструктор по умолчанию
- Составные типы
- Приведение типов
- Задание аргументов

Свойства
- Простое задание свойств
- Встроенное задание свойств
- Задание свойств фреймворком
- Допостроение существующих классов

Время жизни
Перехватчики
- OnCreation
- EnrichWith

Дженерик типы
Аттрибуты
- DefaultConstructor
- ValidationMethod
- Все остальные

Тесты

Подробнее