extending_factory

Aedi, a dependency injection library.

Aedi is a dependency injection library. It does provide a set of containers that do IoC, and an interface to configure application components (structs, objects, etc.)

Aim:

The aim of library is to provide a dependency injection solution that is feature rich, easy to use, easy to learn, and easy to extend up to your needs.

Usage:

For an end consumer of Aedi library, it is rarely needed to extend it's logic with something new. But for a developer that wants to integrate Aedi library with his/her framework, sometimes it is required to extend library to integrate it with rest of framework. Aedi was designed with purpose of extending it in two directions:

  1. Containers -> responsible for created components.
  2. Component factories -> responsible for creating components

A component factory, as name states is responsible for creation and assembly of components registered in container, as well as destroying them. Containers are using them to instantiate components, that are requested. In all tutorials up to this registering a component, was equivalent to creating a factory for it, and registering it in container. Afterwards factory was returned to the client code, were it was further configured, with construction and setter injections by code.

When the default features of framework are not enough, it is possible to extend it, in several directions mentioned above. For defining a new way of creating components, a factory interface in listing below is shown, which is minimal requirement for having the custom factories useable by containers. A factory encapsulates the logic required as to create and destroy a component.

1 interface Factory(T) : LocatorAware!(), AllocatorAware!() {
2 
3 	public {
4 
5 		T factory();
6         void destruct(ref T component);
7 
8 		@property {
9     		TypeInfo type();
10 		}
11 	}
12 }

For example purposes, during development of car simulation app, logging of car assembly should be done. Example below shows a simple logging component factory that creates components using zero argument constructor, and logs the construction using default logging facilities present in D programming language.

1 class LoggingFactory(T) : Factory!T {
2     private {
3         Locator!() locator_;
4         RCIAllocator allocator_;
5     }
6 
7     public {
8         @property {
9             typeof(this) allocator(RCIAllocator allocator) @safe nothrow pure {
10                 this.allocator_ = allocator;
11 
12                 return this;
13             }
14 
15             RCIAllocator allocator() @safe nothrow pure {
16                 return this.allocator_;
17             }
18         }
19 
20         T factory() {
21             import std.experimental.logger;
22 
23             info("Creating component");
24             static if (is(T : Object)) {
25                 auto t = this.allocator.make!T;
26             } else {
27                 auto t = T();
28             }
29             info("Ended component creation");
30 
31             return t;
32         }
33 
34         void destruct(ref T component) {
35             import std.experimental.logger;
36 
37             info("Destroying component");
38             static if (is(T : Object)) {
39                 this.allocator.dispose(component);
40                 info("Done destroying component");
41             } else {
42                 info("Value component nothing to destroy");
43             }
44         }
45 
46         TypeInfo type() {
47             return typeid(T);
48         }
49 
50         LoggingFactory!T locator(Locator!() locator) @safe nothrow {
51         	this.locator_ = locator;
52 
53         	return this;
54         }
55     }
56 }

A design decision in framework was made, that all containers must store only objects rooted in Object class. Since the language in which framework is developed supports not only object, but structs, unions and a multitude of value based types, those types should be wrapped into an object to be stored into containers. By convention, it is assumed that value based data is wrapped in an implementation of Wrapper interface which roots into Object class. Knowing this, factories that attempt to supply value based dependencies to components, fetch the wrapped components from container, extracts the component from wrapper and pass it to the component.

From the constraint that containers apply on accepted types (rooted in Object), the same requirements are propagated to component factories which are stored in containers. To leverage this problem, framework provides a decorating factory, that wraps up another factory, and exposes an compatible interface for containers. It will automatically wrap any component that is not rooted in Object class into a Wrapper implementation and give it further to container.

For aesthetic purposes it is recommended any creation of a factory to be wrapped in a function, which itself can serve as a facade to implementation, and be integrated seamlessly in code api. Example below shows an example of such a wrapper, that handles creation of a component factory and wrapping it in a compatible interface for containers.

1 auto registerLogged(Type)(Storage!(ObjectFactory, string) container, string identity) {
2     auto factory = new LoggingFactory!Type;
3     container.set(new WrappingFactory!(LoggingFactory!Type)(factory), identity);
4 
5     return factory;
6 }

To test custom component factory example below shows how it can be used seamlessly and unknowingly from the point of view of a user of library.

1 void main() {
2 
3     SingletonContainer container = singleton();
4 
5     container.registerLogged!Tire("logging.tire");
6     container.registerLogged!int("logging.int");
7 
8     container.instantiate();
9 
10     container.locate!Tire("logging.tire").writeln;
11     container.locate!int("logging.int").writeln;
12 }

Running the container we will get following result:

1 2017-03-04T00:34:33.401:app.d:factory:161 Creating our little component
2 2017-03-04T00:34:33.401:app.d:factory:167 Ended creation of component
3 2017-03-04T00:34:33.401:app.d:factory:161 Creating our little component
4 2017-03-04T00:34:33.401:app.d:factory:167 Ended creation of component
5 Tire(0 inch, nan atm, )
6 0

As we can see our logging factory is doing designed job. Try to implement your own factory, to understand how Aedi works behind the scenes.

Members

Classes

LoggingFactory
class LoggingFactory(T)

Meta

Authors

aermicioi

License

Boost Software License - Version 1.0 - August 17th, 2003

Permission is hereby granted, free of charge, to any person or organization obtaining a copy of the software and accompanying documentation covered by this license (the "Software") to use, reproduce, display, distribute, execute, and transmit the Software, and to prepare derivative works of the Software, and to permit third-parties to whom the Software is furnished to do so, all subject to the following:

The copyright notices in the Software and this entire statement, including the above license grant, this restriction and the following disclaimer, must be included in all copies of the Software, in whole or in part, and all derivative works of the Software, unless such copies or derivative works are solely in the form of machine-executable object code generated by a source language processor.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.