Управляем зависимостями в iOS-приложениях правильно: Устройство Typhoon

Цикл «Управляем зависимостями в iOS-приложениях правильно»

• Знакомство с Typhoon
• Устройство Typhoon
• Модульность Typhoon
• Typhoon Tips & Tricks
• Альтернативы Typhoon
• (Дополнительно) Rambler.iOS #3. Dependency Injection в iOS. Слайды
• (Дополнительно) Rambler.iOS #3. Dependency Injection в iOS. Видео

Введение

• Assembly (читается как [эссэмбли]). Ближайший русский эквивалент — сборка, конструкция. В Typhoon — это объекты, содержащие в себе конфигурации всех зависимостей приложения, по сути своей являются костяком всей архитектуры. Для внешнего мира, будучи активированными, ведут себя как обычные фабрики.
• Definition. Что касается перевода на русский язык — мне больше всего импонирует конфигурация, как наиболее близкий к оригиналу вариант. TyphoonDefinition — это объекты, являющиеся своеобразной моделью зависимостей, содержат в себе такую информацию, как класс создаваемого объекта, его свойства, тип жизненного цикла. Большинство примеров из предыдущей статьи касались как раз таки различных вариантов настройки TyphoonDefinition.
• Scope. Здесь все просто — это тип жизненного цикла объекта, созданного при помощи Typhoon.
• Активация. Процесс, в результате которого все объекты-наследники TyphoonAssemby начинают вместо TyphoonDefinition отдавать реальные инстансы классов. Суть и принцип работы активации рассмотрим чуть ниже.

Инициализация

• Вызов main.m
• Создание UIApplication — [UIApplication init]
• Создание UIAppDelegate — [UIAppDelegate init]
• Вызов метода setDelegate: у созданного инстанса UIApplication
• Вызов засвиззленной в классе TyphoonStartup имплементации setDelegate:
• Вызов метода -applicationDidFinishLaunching:withOptions: у инстанса UIAppDelegate

+ (id)factoryFromPlistInBundle:(NSBundle *)bundle
{
    TyphoonComponentFactory *result = nil;

    NSArray *assemblyNames = [self plistAssemblyNames:bundle];
    NSAssert(!assemblyNames || [assemblyNames isKindOfClass:[NSArray class]],
            @"Value for 'TyphoonInitialAssemblies' key must be array");

	if ([assemblyNames count] > 0) {
        NSMutableArray *assemblies = [[NSMutableArray alloc] initWithCapacity:[assemblyNames count]];
    	for (NSString *assemblyName in assemblyNames) {
        	Class cls = TyphoonClassFromString(assemblyName);
        	if (!cls) {
            	[NSException raise:NSInvalidArgumentException format:@"Can't resolve assembly for name %@",
                                                                 	assemblyName];
        	}
        	[assemblies addObject:[cls assembly]];
    	}
    	result = [TyphoonBlockComponentFactory factoryWithAssemblies:assemblies];
	}

	return result;
}

+ (TyphoonComponentFactory *)factoryFromAppDelegate:(id)appDelegate
{
    TyphoonComponentFactory *result = nil;

	if ([appDelegate respondsToSelector:@selector(initialFactory)]) {
    	result = [appDelegate initialFactory];
	}

	return result;
}

• TyphoonStartup.m
• TyphoonComponentFactory.m

Активация

1. У TyphoonBlockComponentFactory вызывается инициализатор -initWithAssemblies:, на вход которому передается массив assembly, которые нужно активировать.
2. Каждому из definition'ов, создаваемых активируемыми assembly, назначается свой уникальный ключ (рандомная строка + имя метода).
3. Все TyphoonDefinition добавляются в массив registry только что созданного TyphoonBlockComponentFactory.

- (void)forwardInvocation:(NSInvocation *)anInvocation {
    if (_factory) {
    	[_factory forwardInvocation:anInvocation];
	}
       ...
}

- (id)componentForKey:(NSString *)key args:(TyphoonRuntimeArguments *)args
{
    if (!key) {
        return nil;
	}

	[self loadIfNeeded];

    TyphoonDefinition *definition = [self definitionForKey:key];
    if (!definition) {
    	[NSException raise:NSInvalidArgumentException format:@"No component matching id '%@'.", key];
	}

    return [self newOrScopeCachedInstanceForDefinition:definition args:args];
}

• TyphoonAssembly.m
• TyphoonBlockComponentFactory.m
• TyphoonTypeDescriptor.m
• TyphoonAssemblyDefinitionBuilder.m
• TyphoonStackElement.m

Работа со Storyboard

+ (TyphoonStoryboard *)storyboardWithName:(NSString *)name 
                               factory:(id<TyphoonComponentFactory>)factory 
                               bundle:(NSBundle *)bundleOrNil;

1. В первую очередь мы попадаем в метод -instantiateViewControllerWithIdentifier:, переопределенный в TyphoonStoryboard.
2. Создается инстанс нужного контроллера путем вызова super'a.
3. Инициируется инжекция всех зависимостей текущего контроллера и его дочерних контроллеров:
   
   - (void)injectPropertiesForViewController:(UIViewController *)viewController

   - (void)injectPropertiesForViewController:(UIViewController *)viewController
   {
       if (viewController.typhoonKey.length > 0) {
       	[self.factory inject:viewController withSelector:NSSelectorFromString(viewController.typhoonKey)];
   	}
       else {
       	[self.factory inject:viewController];
   	}
   
       for (UIViewController *controller in viewController.childViewControllers) {
       	[self injectPropertiesForViewController:controller];
   	}
   }

4. В TyphoonBlockComponentFactory происходит уже знакомая нам процедура — ищется соответствующий текущему классу TyphoonDefinition и инициируется процесс инжекции в нее графа зависимостей.
   

• TyphoonStoryboard.m
• TyphoonBlockComponentFactory.m

TyphoonDefinition

• Class _type — класс создаваемой зависимости
• NSString *_key — уникальный ключ, генерируемый при активации Typhoon,
• TyphoonMethod *_initializer — объект, создаваемый при initializer injection, содержащий в себе сигнатуру нужного инициализатора и коллекцию его параметров,
• TyphoonMethod *_beforeInjections — метод, который будет вызван до проведения инъекции зависимостей,
• TyphoonMethod *_afterInjections — метод, который будет вызван после проведения инъекции зависимостей,
• NSMutableSet *_injectedProperties — коллекция зависимостей, устанавливаемых через property injection,
• NSMutableOrderedSet *_injectedMethods — коллекция методов, в которые передаются определенные зависимости (method injection),
• TyphoonScope scope — тип жизненного цикла создаваемого объекта,
• TyphoonDefinition *_parent — базовый TyphoonDefinition, все свойства которой будут унаследованы текущей,
• BOOL abstract — флаг, указывающий на то, что текущая конфигурация может использоваться только для реализации наследования, и представляемый ею объект никогда не должен создаваться напрямую.

• TyphoonDefinition.m
• TyphoonAssemblyDefinitionBuilder.m
• TyphoonFactoryDefinition.m
• TyphoonInjectionByReference.m
• TyphoonMethod.m

TyphoonScope

• TyphoonScopeObjectGraph
  В процессе построения графа зависимостей объект с таким scope будет создан только один раз. Технически это выглядит так: перед созданием инстанса (какого-либо definition), создается пул для object graph scoped объектов, в процессе построения графа зависимостей, все object-graph-scoped уходят в этот пул, а после того, как инстанс создан, этот пул очищается.
• TyphoonScopePrototype
  При каждом обращении к TyphoonDefinition с таким scope будет создаваться новый инстанс класса.
• TyphoonScopeSingleton
  Объект с таким жизненным циклом будет жить на всем протяжении жизни TyphoonComponentFactory.
• TyphoonScopeLazySingleton
  Как видно из названия — это синглтон, который будет создан в момент первого обращения к нему.
• TyphoonScopeWeakSingleton
  Синглтон, создаваемый при использовании такого TyphoonDefinition, находится в памяти ровно до тех пор, пока на него ссылается хотя бы один объект — в противном случае, он будет освобожден.

• TyphoonComponentFactory.m
• TyphoonWeakComponentPool.m
• TyphoonCallStack.m

Заключение

Цикл «Управляем зависимостями в iOS-приложениях правильно»

• Знакомство с Typhoon
• Устройство Typhoon
• Модульность Typhoon
• Typhoon Tips & Tricks
• Альтернативы Typhoon
• (Дополнительно) Rambler.iOS #3. Dependency Injection в iOS. Слайды
• (Дополнительно) Rambler.iOS #3. Dependency Injection в iOS. Видео

Полезные ссылки

• Официальный сайт Typhoon Framework
• Typhoon Framework Wiki
• Wikipedia: Aspects-Oriented programming
• An Aspect Oriented Programming Approach to iOS Analytics
• DI Паттерны. Constructor Injection
• DI Паттерны. Property Injection
• DI Паттерны. Method Injection