Best and Recommended – ASP.NET 5 configuration in regular .NET applications

Rate this post

BestASPNETHostingReview.com | Best and recommended ASP.NET 5 Hosting. ASP.NET 5 is Microsoft’s latest web framework and the new big thing on the .NET landscape. It comes with a whole lot of new features and other changes which makes it very distinctive from previous ASP.NET versions. It is basically a complete re-write of the framework, optimized for the cloud and cross platform compatible. If you haven’t checked it out yet then you are definitely missing out!

working-with-laptop_23-2147502958Some of the newly introduced features are the new configuration options, which come as part of the Microsoft.Extensions.Configuration NuGet packages. They allow you a more flexible way of loading configuration values into an application and make it significantly easier to move an application across different environments without having to change configuration files or run through nasty configuration transformations as part of the process. Scott Hanselman has nicely summarized this topic in one of his recent blog posts.

It is needless to say that a lot of people are hugely excited about the new framework and many projects are being written in ASP.NET 5 right now, but there is also a significant amount of people who cannot easily migrate their existing projects to the new framework yet. This might be for various reasons but essentially means they are stuck on an older version of ASP.NET at least for a while.

However, it doesn’t mean that those people cannot already benefit from some of the new ideas which have been publicly introduced in ASP.NET 5 such as the new configuration options.

Implementing ASP.NET 5 like configuration options

The idea is to provide multiple sources from where an app can load configuration values. Additionally we want to put those sources into an order of precedence, where one source overrules another.

While ASP.NET 5 implementes a Builder pattern, you can easily achieve the same thing with a good old Decorator.

First we need an interface which provides a method to retrieve a config value:

Next I implement a simple class which loads a value from an app- or web.config file:

This is trivial and probably the same as what you have in your current application, just that it has been wrapped in a class which is behind an interface.

Finally we can provide an additional implementation which loads a value from the environment variables:

This particular implementation wraps another IConfiguration implementation. If the setting does not exist in the environment variables then it defers to the next implementation. This could be anything and in this particular example will be the AppConfigConfiguration:

It is really as simple as that. The order of precedence is determined by the order of the classes being put together.

This pattern can be extended as far as you like. For example I could add two more classes and compose something like this:

Now I can access configuration values from other classes through an IConfiguration dependency:

With this trick you can easily implement a “cloud optimized” configuration in any version of ASP.NET and follow good practice patterns no matter where you code!