An Autofac based implementation of Dependency Injection based on Boris Wilhelms Azure Function Dependency Injection Project
Switch branches/tags
Nothing to show
Clone or download
vandersmissenc Updated Microsoft.Data.OData per GitHub security alert (#34)
* Updated Microsoft.Data.OData per GitHub security alert

* updated nuspec
Latest commit aad1bec Nov 5, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Update issue templates Jun 19, 2018
AzureFunctions.Autofac.NetFramework.Tests Updated Microsoft.Data.OData per GitHub security alert (#34) Nov 5, 2018
AzureFunctions.Autofac.NetFramework Updated Microsoft.Data.OData per GitHub security alert (#34) Nov 5, 2018
AzureFunctions.Autofac.NetStandard.Tests Fixed code to work with new update to azure functions v2 (#24) Aug 31, 2018
AzureFunctions.Autofac.NetStandard Per invocation resolution (#1) (#33) Nov 5, 2018
AzureFunctions.Autofac.Shared Per invocation resolution (#1) (#33) Nov 5, 2018
DurableFunctionsNetFrameworkExample.Tests Fixed code to work with new update to azure functions v2 (#24) Aug 31, 2018
DurableFunctionsNetFrameworkExample Fixed code to work with new update to azure functions v2 (#24) Aug 31, 2018
NetCoreExample Upgrade of Microsoft.Azure.WebJobs to fix build-time error with Micro… Sep 18, 2018
NetFrameworkExample Fixed code to work with new update to azure functions v2 (#24) Aug 31, 2018
.gitattributes Add .gitignore and .gitattributes. Oct 28, 2017
.gitignore Add .gitignore and .gitattributes. Oct 28, 2017
AutofacDIExample.sln Fixed code to work with new update to azure functions v2 (#24) Aug 31, 2018
AzureFunctions.Autofac.nuspec Updated Microsoft.Data.OData per GitHub security alert (#34) Nov 5, 2018
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Jun 19, 2018
CONTRIBUTING.md Create CONTRIBUTING.md Jun 19, 2018
LICENSE Update LICENSE Oct 12, 2018
PULL_REQUEST_TEMPLATE.md Create PULL_REQUEST_TEMPLATE.md Jun 19, 2018
README.md Fixed typo in README.md (#22) Aug 31, 2018

README.md

Autofac Dependency Injection in Azure Functions

An Autofac based implementation of Dependency Injection based on Boris Wilhelm's azure-function-dependency-injection and Scott Holden's WebJobs.ContextResolver available on NuGet as AzureFunctions.Autofac

Build status

Usage

In order to implement the dependency injection you have to create a class to configure DependencyInjection and add an attribute on your function class.

Configuration

Create a class and add a constructor that takes 1 string argument. The string argument will automatically be passed and runtime and simply needs to be passed through to the initialize method. In the constructor call the DependencyInjection.Initialize method. Perform the registrations as you normally would with Autofac.

    public class DIConfig
    {
        public DIConfig(string functionName)
        {
            DependencyInjection.Initialize(builder =>
            {
                //Implicity registration
                builder.RegisterType<Sample>().As<ISample>();
                //Explicit registration
                builder.Register<Example>(c => new Example(c.Resolve<ISample>())).As<IExample>();
                //Registration by autofac module
                builder.RegisterModule(new TestModule());
                //Named Instances are supported
                builder.RegisterType<Thing1>().Named<IThing>("OptionA");
                builder.RegisterType<Thing2>().Named<IThing>("OptionB");
            }, functionName);
        }
    }

Function Attribute and Inject Attribute

Once you have created your config class you need to annotate your function class indicating which config to use and annotate any parameters that are being injected. Note: All injected parameters must be registered with the autofac container in your resolver in order for this to work.

    [DependencyInjectionConfig(typeof(DIConfig))]
    public class GreeterFunction
    {
        [FunctionName("GreeterFunction")]
        public static HttpResponseMessage Run([HttpTrigger(AuthorizationLevel.Function, "get", Route = null)]HttpRequestMessage request, 
                                              TraceWriter log, 
                                              [Inject]IGreeter greeter, 
                                              [Inject]IGoodbyer goodbye)
        {
            log.Info("C# HTTP trigger function processed a request.");
            return request.CreateResponse(HttpStatusCode.OK, $"{greeter.Greet()} {goodbye.Goodbye()}");
        }
    }

Using Named Dependencies

Support has been added to use named dependencies. Simple add a name parameter to the Inject attribute to specify which instance to use.

    [DependencyInjectionConfig(typeof(DIConfig))]
    public class GreeterFunction
    {
        [FunctionName("GreeterFunction")]
        public static HttpResponseMessage Run([HttpTrigger(AuthorizationLevel.Function, "get", Route = null)]HttpRequestMessage request, 
                                              TraceWriter log, 
                                              [Inject]IGreeter greeter, 
                                              [Inject("Main")]IGoodbyer goodbye, 
                                              [Inject("Secondary")]IGoodbyer alternateGoodbye)
        {
            log.Info("C# HTTP trigger function processed a request.");
            return request.CreateResponse(HttpStatusCode.OK, $"{greeter.Greet()} {goodbye.Goodbye()} or {alternateGoodbye.Goodbye()}");
        }
    }

Multiple Dependency Injection Configurations

In some cases you may wish to have different dependency injection configs for different classes. This is supported by simply annotating the other class with a different dependency injection config.

    [DependencyInjectionConfig(typeof(DIConfig))]
    public class GreeterFunction
    {
        [FunctionName("GreeterFunction")]
        public static HttpResponseMessage Run([HttpTrigger(AuthorizationLevel.Function, "get", Route = null)]HttpRequestMessage request, 
                                              TraceWriter log, 
                                              [Inject]IGreeter greeter, 
                                              [Inject]IGoodbyer goodbye)
        {
            log.Info("C# HTTP trigger function processed a request.");
            return request.CreateResponse(HttpStatusCode.OK, $"{greeter.Greet()} {goodbye.Goodbye()}");
        }
    }

    [DependencyInjectionConfig(typeof(SecondaryConfig))]
    public class SecondaryGreeterFunction
    {
        [FunctionName("SecondaryGreeterFunction")]
        public static HttpResponseMessage Run([HttpTrigger(AuthorizationLevel.Function, "get", Route = null)]HttpRequestMessage request, 
                                              TraceWriter log, 
                                              [Inject]IGreeter greeter, 
                                              [Inject]IGoodbyer goodbye)
        {
            log.Info("C# HTTP trigger function processed a request.");
            return request.CreateResponse(HttpStatusCode.OK, $"{greeter.Greet()} {goodbye.Goodbye()}");
        }
    }

Verifying dependency injection configuration

Dependency injection is a great tool for creating unit tests. But with manual configuration of the dependency injection, there is a risk of mis-configuration that will not show up in unit tests. For this purpose, there is the DependencyInjection.VerifyConfiguration method.

It is not recommended to call VerifyConfiguration unless done so in a test-scenario.

VerifyConfiguration verifies the following rules:

  1. That an InjectAttribute is preceeded by a DependencyInjectionConfigAttribute.
  2. That the configuration can be instantiated.
  3. That all injected dependencies in the given type can be resolved with the defined configuration.
  4. Optionally that no redundant configurations exist, i.e. a DependencyInjectionConfigAttribute with no corresponding InjectAttribute.

Simple example of verification

Below is a very simple example of verifying the dependency injection configuration for a specific class:

    DependencyInjection.VerifyConfiguration(typeof(MyCustomClassThatUsesDependencyInjection));

Ignoring redundant configurations

If you don't want to verify rule 4, pass in false as the second parameter to VerifyConfiguration:

    DependencyInjection.VerifyConfiguration(typeof(MyCustomClassThatUsesDependencyInjection), false);

Example unit test to verify an entire project/assembly

For instance, you can use it in a unit test to verify that all classes in your project has dependency injection set up correctly:

    [TestMethod]
    public void TestDependencyInjectionConfigurationInAssembly() {
        var assembly = typeof(SomeClassInYouProject).Assembly;
        var types = assembly.GetTypes();
        foreach (var type in types) {
            DependencyInjection.VerifyConfiguration(type);
        }
    }