nvdnkpr / nioc

IOC container for Node.js

#NIoc (node ioc)

A simple to use IOC container for Node.js.

License

Released under [MIT License] (https://github.com/psmithiv/nioc/blob/master/LICENSE).

Highlights

• Beans are defined via a simple JSON file.
• All beans are created at application launch.
• In the event that a bean injects a bean that has not yet been created, it will be created on demand.
• Ability to pass config objects to beans on creation and/or call bean methods post construction.
• Injection available via global 'inject' method.
• Ability to inject both complete beans as well as individual bean properties.

Installation

From within your project, execute 'npm install nioc' from the command line. Npm will create a nioc folder within the standard node_modules folder. The module it's self will be located in 'node_modules/nioc/lib'.

Getting Started

Initializing NIoc

In your applications index.js/server.js file simply require the NIoc module and instantiate the returned method as a new object passing in the path to your bean definitions json file. If no bean definitions file is specified when calling 'nioc()', NIoc will automatically look for a beans.json file one level up from 'node_modules'.

var nioc = require('nioc');
new nioc('path to beans.json file');

NOTE: Since nioc.js is requiring/loading the definitions file. The path is relative to 'node_modules/nioc/lib'. It is recommended that you set the NODE_PATH environmental variable to the root of your application and reference your bean definitions json file from there.

Defining Beans

In your beans.json file, beans are defined as objects and reqire a single 'path' property which references the node.js module to be made available for injection.

{
  "beanC": {
    "path": "path to module to be made available for injection (BeanC.js)"
  }
}

NOTE: Since nioc.js is requiring/loading the definitions file. The path is relative to 'node_modules/nioc/lib'. It is recommended that you set the NODE_PATH environmental variable to the root of your application and reference your bean/module file from there.

Additionally, there are three other properties that may also be specified on the bean object: 'config', 'postConstruct', and 'singleton'.

"config"

NIoc will create a new instance of the module and pass the value of the config property as an attribute to the method specified.

{
    "beanC" : {
        "path": "path to module to be made available for injection (BeanC.js)"
    },

    "beanAA": {
        "path": "path to module to be made available for injection (BeanA.js)",
        "config": {
            "configProp1": "foo2",
            "configProp2": "bar2"
        }
    }
}

"postConstruct"

A 'postConstruct' array may be defined on the bean object. This property consists of an array of objects containing a 'method' property (required) and an additional 'arguments' property. The 'methods' property defines what method to call on the bean post construction, while the 'arguments' array is a list of values to be passed as attributes to the specified method.

{
    "beanC" : {
        "path": "path to module to be made available for injection (BeanC.js)"
    },

    "beanAA": {
        "path": "path to module to be made available for injection (BeanA.js)",
        "config": {
            "configProp1": "foo2",
            "configProp2": "bar2"
        }
    },

    "beanA": {
        "path": "path to module to be made available for injection (BeanA.js)",
        "config": {
            "configProp1": "foo",
            "configProp2": "bar"
        },
        "postConstruct": [{
            "method": "postConstructA",
            "arguments": [
                "postConstructParamString",
                100
            ]
        }]
    }
}

"singleton"

Lastly, beans may be tagged with "singleton": false. This will instruct nioc to create a new instance of the bean every time it is injected.

{
    "beanC" : {
        "path": "path to module to be made available for injection (BeanC.js)"
    },

    "beanAA": {
        "path": "path to module to be made available for injection (BeanA.js)",
        "config": {
            "configProp1": "foo2",
            "configProp2": "bar2"
        }
    },

    "beanA": {
        "path": "path to module to be made available for injection (BeanA.js)",
        "config": {
            "configProp1": "foo",
            "configProp2": "bar"
        },
        "postConstruct": [{
            "method": "postConstructA",
            "arguments": [
                "postConstructParamString",
                100
            ]
        }]
    },
    
    "beanD": {
        "path": "path to module to be made available for injection (BeanD.js)",
        "singleton": false
    }
}

Creating Beans

The recommended approach to creating beans for NIoc is to define class based node.js modules as seen below. When creating the bean, NIoc will automatically create a new instance of the method specified by exports/module.exports. This will allow for the same node.js module to be defined more than once using different id's as well as allow for specifying "singleton": false so that a new instance of a bean is created every time inject('bean id') is called.

//wire up module
exports = module.exports = init;

/**
 * Example BeanA.js
 *
 * @class
 */
function init(config) {
    /**
     * @private
     * @type {*}
     */
    var me = this;

    /**
     * @public
     * @type {String}
     */
    me.configProp1 = '';

    /**
     * @public
     * @type {String}
     */
    me.configProp2 = '';

    /**
     * @constructor
     */
    function constructor() {
        me.configProp1 = config.configProp1;
        me.configProp2 = config.configProp2;
    };

    /**
    * @public
    * @param {String} stringArgument
    * @param {Number} numberArgument
    */
    me.postConstructA = function(stringArgument, numberArgument) {
        console.log('INFO: BeanA.postConstructA  -  stringArgument: ' + stringArgument + '  -  numberArgument: ' numberArgument);
    }

    /**
    * @public
    * @param {Array} arrayArgument
    */
    me.postConstructB = function(arrayArgument) {
        console.log('INFO: BeanA.postConstructB  -  arrayArgument: ' + arrayArgument);
    }

    //construct object
    constructor();
}

##Injection The last part of the equation is injecting beans. This can be done from any module in one of two ways.

First is to inject an entire bean:

var bean = inject('bean id');

Second is to inject a specific bean property:

var beanProp = inject('bean id', 'bean property');

##Examples An example of using NIoc can be found in the 'example' folder of this project. To run the example execute 'npm install nioc' from the command line in the example folder and launch server.js via Node.js.

• MEN Stack (mongoose, express, nioc) - Using NIoc with express and mongoose to create REST services (coming soon)

##Roadmap

• Features:
  * Add ability to specify more than one bean definitions file.
• Unit Tests
• Proper logging that can be disabled in a production environment.

##Developers

• Paul C Smith IV (Creator): [email](mailto: [email protected]) - linkedin