Skip to main content

Strongly typed configuration through database

We usually save most of application setting under app.config or web.config with key and value pair under appSetting element. The big problem with those are whenever you need value, typecasting need to be done and also need to be called through key. The other problem I find is with hierarchy of settings like download related setting present should under download element for easy accessing.

To solve strongly typed configuration and hierarchy, ConfigurationManager (http://msdn.microsoft.com/en-us/library/system.configuration.configurationmanager(v=vs.110).aspx) class comes for rescue. You might have seen under web.config where we have sectionGroup and related configuration under elements. To implement it, lot of codes need to written to achieve simplification.

To reduce numbers of codes for implementing XML configuration a very good and free tool is available called "Configuration Section Designer" available on http://csd.codeplex.com/. There we do not have to write any line of code. All things could be managed in UI level only.

Now a days most of the projects are moving to cloud based and as a result we are loosing control to manipulate configuration. For example, Azure resets deployed builds after certain time. So, if you have changed anything in web.config it will get reset to depolyed version. We need to have certain permission to change configuration which creates problem on hosting server.

In my current approach, I have tried to check every drawbacks and simplify the items through database and T4 template. Strongly typed, hierarchy, zero maintenance and easy accessibility through class would be taken care.

First we need to have self relation table to create hierarchy which will result up in creation of classes with its different members.

Mandatory columns for table:
Id: Primary key
ParentId: This is a reference of Id to make relationship. Need to have 0 in case of root elements.
SettingName: Name of the setting. Through this property and classes would be created but we can put spaces between string.
SettingValue: Need to be NULL for parent members/classes and also proper value need to be put for others. Data type would be identified through this only.

That is all we need from table side to populate class. Clean and neat with few rules.

Example for table:
Id|ParentId|SettingName|SettingValue
1|0|System|NULL [NOTE: 0 as root element]
2|1|Application Name|Demo Setting [NOTE: ParantId is set to 1 (System)]
3|0|Password Policy|NULL [NOTE: Another root element]
4|3|Password Age In Days|3 [NOTE: SettingValue as 3 for generating int property]
5|3|Password Constraint|NULL [NOTE: Creating hierarchy under Password policy with NULL value under SettingValue]
6|5|Complex Password|true| [NOTE: SettingValue is set as true for bool]
7|5|Password Min Length|5

Result of above table into hierarchy
-- System [Root]
---- Application Name
-- Password Policy [Root]
---- Password Age In Days
---- Password Constraint [Root level 2]
-------- Complex Password
-------- Password Min Length

I am going to explain some key parts from T4 template codes so that it would be easy to modify and at last will put all codes from T4 code for implementation.

- Connection string: Modify according to your database
 var connectString = "datasource=.;initialcatalog=SettingDemo;integratedsecurity=True";

- DB query. I have not implemented regular expression in this tutorial but we can take advantage to generate data annotation for regular expression.
 var queryString = "SELECT Id,ParentId, SettingName, 'RegularExpression', SettingValue from SystemSetting";

-
 List<Tuple<int,int,string, string, string, string>> GetSettingsItems(string connectString)

through above function we will get tuple as
Item1= Id
Item2 = ParentId
Item3 = Property/Class name
Item4 = Name or Description that could be used for XML comment. [Not used in this example]
Item5 = Regular Expression reserved [Not used in this example]

Item6 = Setting value

- Codes for T4
 <#@ template debug="true" hostSpecific="true" #>  
 <#@ output extension=".cs" #>  
 <#@ Assembly Name="System" #>  
 <#@ Assembly Name="System.Globalization" #>  
 <#@ Assembly Name="System.Data" #>  
 <#@ assembly name="System.Core" #>  
 <#@ import namespace="System" #>  
 <#@ import namespace="System.Text" #>  
 <#@ import namespace="System.Text.RegularExpressions" #>  
 <#@ import namespace="System.IO" #>  
 <#@ import namespace="System.Diagnostics" #>  
 <#@ import namespace="System.Linq" #>  
 <#@ import namespace="System.Collections" #>  
 <#@ import namespace="System.Collections.Generic" #>   
 <#@ include file="EF.Utility.CS.ttinclude"#>  
 <#@ import namespace="System.Data.SqlClient" #>   
 <#  
      var code = new CodeGenerationTools(this);  
      var connectString = "data source=.;initial catalog=SettingDemo;integrated security=True";  
      var settings = GetSettingsItems(connectString);  
 #>  
 using System;  
 using System.Collections.Generic;  
 using System.Linq;  
 namespace <#= code.VsNamespaceSuggestion()#>  
 {    
      //------------------------------------------------------------------------------  
      // <auto-generated>  
      //   This code was generated from a template and will be overwritten as soon   
      //       as the template is executed.  
      //  
      //   Changes to this file may cause incorrect behavior and will be lost if  
      //   the code is regenerated.  
      // </auto-generated>  
      //------------------------------------------------------------------------------  
      /// <summary>  
      /// Application settings  
      /// </summary>  
      public class Setting  
      {  
      <#   
           var settingCreateMethod = new StringBuilder("public static Setting CreateSetting"  
           + "(Dictionary<string,string> settings)\n\t{\n\t var setting = new Setting();\n");  
      foreach (var setting in settings.Where(seting => seting.Item6 == null))  
      {#>  
      <#if(setting.Item2 == 0){  
        // method generation for root element  
           settingCreateMethod.Append("setting." + setting.Item3 + " = Setting"  
        + setting.Item3 +".Create" + setting.Item3 + "(settings);\n");  
      #>  
      public Setting<#= setting.Item3 #> <#= setting.Item3 #> { get; set; }  
      <#  
   }#>  
           public class Setting<#= setting.Item3 #>  
           {  
           <#   
   // String builder for parameter  
   var childCtor = new StringBuilder();  
   // String builder to put contents under constructor  
   var childCtorProrInit = new StringBuilder();  
   // String builder to create method parameters to use dictionary  
   var mthodDictionary = new StringBuilder();  
   childCtor.Append("public Setting" + setting.Item3 + "(" );  
   mthodDictionary.Append("public static Setting" + setting.Item3 + " Create" + setting.Item3   
   + "(Dictionary<string,string> settings)\n\t{\n\t"+  
   "return new Setting" + setting.Item3 + "(" );  
   #>  
   <#   
           foreach (var childSetting in settings  
            .Where(i=>i.Item2==setting.Item1)  
            .AsQueryable().OrderBy(value => value.Item3))  
     {  
                var dataType = GetType(childSetting.Item6);  
                // In case of class members  
                if(childSetting.Item6 != null)  
       {  
                     childCtor.Append("string " + code.CamelCase(childSetting.Item3) + ", ");  
                     if(dataType != "string")  
         {  
                          childCtorProrInit.Append(childSetting.Item3 + " = " + dataType + ".Parse("+code.CamelCase(childSetting.Item3)+");\n\t");  
         }  
                     else  
                     {  
                          childCtorProrInit.Append(childSetting.Item3 + " = "+code.CamelCase(childSetting.Item3)+";\n\t");  
         }  
                     mthodDictionary.Append("GetValue(settings, \"" + childSetting.Item4 + "\"), \n");  
                #>  
           public <#= dataType #> <#= childSetting.Item3 #> { get; set; }  
      <# }else{  
           // If type is class itself  
           // CTOR for class  
           childCtor.Append("Setting" + childSetting.Item3 + " " + code.CamelCase(childSetting.Item3) + ", ");  
           childCtorProrInit.Append(childSetting.Item3 + " = "+code.CamelCase(childSetting.Item3)+";\n\t");  
           // Get all values for the child class and add in method parameter  
           mthodDictionary.Append("new Setting" + childSetting.Item3 + "\n(\n");  
     foreach (var paramChildSetting in settings  
            .Where(i => childSetting.Item1 == i.Item2)  
            .AsQueryable().OrderBy(value => value.Item3))  
     {  
                mthodDictionary.Append("GetValue(settings, \"" + paramChildSetting.Item4 + "\"), \n");  
     }  
           var strWhole = mthodDictionary.ToString().Remove(mthodDictionary.ToString().Length -3, 3);  
           mthodDictionary.Clear();  
           mthodDictionary.Append(strWhole);  
           mthodDictionary.Append("), \n");  
      #>  
           public Setting<#= childSetting.Item3 #> <#= childSetting.Item3 #> { get; set;}   
                                    <# } #>  
                               <#  
            } ;#>  
            <#= childCtor.ToString().Remove(childCtor.ToString().Length -2, 2 ) + ")\n{\t" + childCtorProrInit + "}\n" #>  
           <#= mthodDictionary.ToString().Remove(mthodDictionary.ToString().Length -3, 3) + ");\n" #>  
                            }  
                            }  
                           <# } #>                       
           internal static string GetValue(Dictionary<string, string> settings, string settingKey)  
     {  
       return settings.FirstOrDefault(x => x.Key.ToLower() == settingKey.ToLower()).Value;  
     }  
 <#= settingCreateMethod.ToString() + "\nreturn setting;}\n"#>       
      }  
      /// <summary>  
   /// System settings key  
   /// </summary>  
      public enum SystemSettingKey  
      {  
      <#   
   foreach (var setting in settings)  
   {  
            #>  
           /// <summary>  
           /// <#= setting.Item4 #>  
           /// </summary>        
           <#= setting.Item3 #>,  
            <#  
   }       
      #>  
      }  
 }  
 <#+  
 private static List<Tuple<int,int,string, string, string, string>> GetSettingsItems(string connectString)  
 {  
   List<Tuple<int,int,string, string, string, string>> settings = new   
           List<Tuple<int,int,string, string, string, string>>();  
   var queryString = "SELECT Id,ParentId, SettingName, 'RegularExpression', SettingValue from SystemSetting";  
   using (SqlConnection connection = new SqlConnection(connectString))  
   {  
     var command = new SqlCommand(queryString, connection);  
     connection.Open();  
     var reader = command.ExecuteReader();  
     // Call Read before accessing data.  
     while (reader.Read())  
     {  
       settings.Add(new Tuple<int,int,string, string, string, string>  
         (int.Parse(reader[0].ToString()),int.Parse(reader[1].ToString()),  
                     GetPascalCase(Convert.ToString(reader[2])),Convert.ToString(reader[2]),   
         Convert.ToString(reader[3]),   
                     (Convert.IsDBNull(reader[4])?null:reader[4].ToString())));  
     }  
     reader.Close();  
   }  
   return settings.AsQueryable().OrderBy(value => value.Item3).ToList();  
 }  
 private string GetType(string value)  
 {  
      string settingType=null;  
      int i; bool b; decimal d;  
      if (int.TryParse(value, out i))  
           settingType = "int";  
      else if (bool.TryParse(value, out b))  
           settingType = "bool";  
      else if (decimal.TryParse(value, NumberStyles.Any, CultureInfo.InvariantCulture, out d))  
           settingType = "decimal";  
      else  
           settingType = "string";  
      return settingType;  
 }  
 private static string GetPascalCase(string name)  
 {  
      return new CultureInfo("en").TextInfo.ToTitleCase(name.ToLower()).Replace(" ", "");  
 }  
 #>

The above code will generate classes for setting. It is also having a static method to generate "Setting" object based on dictionary value.

To generate setting object:

       var settings = new Dictionary<string, string>();  
       var queryString = "SELECT SettingName, SettingValue from SystemSetting";  
       using (SqlConnection connection = new SqlConnection("data source=.;initial catalog=TestDB;integrated security=True"))  
       {  
         var command = new SqlCommand(queryString, connection);  
         connection.Open();  
         var reader = command.ExecuteReader();  
         // Call Read before accessing data.  
         while (reader.Read())  
         {  
           settings.Add(reader[0].ToString(), reader[1].ToString());  
         }  
         reader.Close();  
       }  
       // That is all needed to populate  
       // NOTE: Much easy if we are using ORM to populate dictionary object  
       Setting setting = Setting.CreateSetting(settings);

This approach is not just restricted to generate settings only but to generate classes based on table with different level of hierarchy.


NOTE: The generated code from T4 template will not be properly formatted.

Labels:

Comments

Post a Comment

Popular posts from this blog

Elegantly dealing with TimeZones in MVC Core / WebApi

In any new application handling TimeZone/DateTime is mostly least priority and generally, if someone is concerned then it would be handled by using DateTime.UtcNow on codes while creating current dates and converting incoming Date to UTC to save on servers. Basically, the process is followed by saving DateTime to UTC format in a database and keep converting data to native format based on user region or single region in the application's presentation layer. The above is tedious work and have to be followed religiously. If any developer misses out the manual conversion, then that area of code/view would not work. With newer frameworks, there are flexible ways to deal/intercept incoming or outgoing calls to simplify conversion of TimeZones. These are steps/process to achieve it. 1. Central code for storing user's state about TimeZone. Also, central code for conversion logic based on TimeZones. 2. Dependency injection for the above class to ...
4 comments
Read more

Trim text in MVC Core through Model Binder

Trimming text can be done on client side codes, but I believe it is most suitable on MVC Model Binder since it would be at one place on infrastructure level which would be free from any manual intervention of developer. This would allow every post request to be processed and converted to a trimmed string. Let us start by creating Model binder using Microsoft.AspNetCore.Mvc.ModelBinding; using System; using System.Threading.Tasks; public class TrimmingModelBinder : IModelBinder { private readonly IModelBinder FallbackBinder; public TrimmingModelBinder(IModelBinder fallbackBinder) { FallbackBinder = fallbackBinder ?? throw new ArgumentNullException(nameof(fallbackBinder)); } public Task BindModelAsync(ModelBindingContext bindingContext) { if (bindingContext == null) { throw new ArgumentNullException(nameof(bindingContext)); } var valueProviderResult = bindingContext.ValueProvider.GetValue(bin...
2 comments
Read more

Handling JSON DateTime format on Asp.Net Core

This is a very simple trick to handle JSON date format on AspNet Core by global settings. This can be applicable for the older version as well. In a newer version by default, .Net depends upon Newtonsoft to process any JSON data. Newtonsoft depends upon Newtonsoft.Json.Converters.IsoDateTimeConverter class for processing date which in turns adds timezone for JSON data format. There is a global setting available for same that can be adjusted according to requirement. So, for example, we want to set default formatting to US format, we just need this code. services.AddMvc() .AddJsonOptions(options => { options.SerializerSettings.DateTimeZoneHandling = "MM/dd/yyyy HH:mm:ss"; });
1 comment
Read more

Centralized model validation both for MVC/WebApi and SPA client-side validation using FluentValidation

Validation is one of the crucial parts of any application. It has to validate on both client side and server side requests. What are target features or implementation from this article? Model validation for any given model. Centralized/One code for validation on both server-side and client-side. Automatic validation of model without writing any extra codes on/under actions for validation.  NO EXTRA/ANY codes on client-side to validate any form. Compatible with SPA. Can be compatible with any client-side validation framework/library. Like Angular Reactive form validation or any jquery validation libraries. Tools used in the implementation? FluentValidation : I feel DataAnnotation validation are excellent and simple to use, but in case of complex validation or writing any custom validations are always tricker and need to write a lot of codes to achieve whereas FluentValidations are simple even in case of complex validation. Generally, we need to validate inc...
1 comment
Read more

Architecture solution composting Repository Pattern, Unit Of Work, Dependency Injection, Factory Pattern and others

Project architecture is like garden, we plant the things in certain order and eventually they grow in similar manner. If things are planted well then they will all look(work) great and easier to manage. If they grow as cumbersome it would difficult to maintain and with time more problems would be happening in maintenance. There is no any fixed or known approach to decide project architecture and specially with Agile Methodology. In Agile Methodology, we cannot predict how our end products will look like similarly we cannot say a certain architecture will fit well for entire development lifespan for project. So, the best thing is to modify the architecture as per our application growth. I understand that it sounds good but will be far more problematic with actual development. If it is left as it is then more problems will arise with time. Just think about moving plant vs a full grown tree. Coming to technical side, In this article, I will be explaining about the various techniques ...
Post a Comment
Read more

LDAP with ASP.Net Identity Core in MVC with project.json

Lightweight Directory Access Protocol (LDAP), the name itself explain it. An application protocol used over an IP network to access the distributed directory information service. The first and foremost thing is to add references for consuming LDAP. This has to be done by adding reference from Global Assembly Cache (GAC) into project.json "frameworks": { "net461": { "frameworkAssemblies": { "System.DirectoryServices": "4.0.0.0", "System.DirectoryServices.AccountManagement": "4.0.0.0" } } }, These  System.DirectoryServices  and  System.DirectoryServices.AccountManagement  references are used to consume LDAP functionality. It is always better to have an abstraction for irrelevant items in consuming part. For an example, the application does not need to know about PrincipalContext or any other dependent items from those two references to make it extensible. So, we can begin wi...
Post a Comment
Read more

Blazor 0.5.0 Interop JavaScript from C# and C# to JavaScript call

Blazor provides two-way communication from JS to C# and C# to JS which is called Interop. The version upgrade to Blazor 0.5.0 changed the approach in interactions between cshtml and JS files. The newer version simplifies JS calling by avoiding pre-registration of JS function. In this article, we would see how to call a JS method by passing multiple parameters from cshtml and parameterized call from JS to cshtml. The scenario that is used in this article has a Kendo AutoComplete to search book and populate information based on the selection. An example of a call to JS from cshtml await JSRuntime.Current.InvokeAsync<string>( "searchBook.Init", "#SearchTitle", new DotNetObjectRef(this)); Takeaways from the above example: - JSRuntime.Current give environment to execute out-process JS. - InvokeAsync is a function that would allow executing the JS function. - The searchBook.Init is a JS function call, we would see it in details in the second sec...
Post a Comment
Read more

Global exception handling and custom logging in AspNet Core with MongoDB

In this, we would be looking into logging and global exception handling in the AspNet Core application with proper registration of logger and global exception handling. Custom logging The first step is to create a data model that we want to save into DB. Error log Data model These are few properties to do logging which could be extended or reduced based on need. public class ErrorLog { /// <summary> /// Gets or sets the Error log identifier. /// </summary> /// <value> /// The Error log identifier. /// </value> [BsonRepresentation(BsonType.ObjectId)] public ObjectId Id { get; set; /// <summary> /// Gets or sets the date. /// </summary> /// <value> /// The date. /// </value> public DateTime Date { get; set; } /// <summary> /// Gets or sets the thread. /// </summary> ...
1 comment
Read more

Channel, ChannelReader and ChannelWriter to manage data streams in multi-threading environment

I came across Channel class while working with SignalR which looks really interesting. By looking into NuGet packages ( https://www.nuget.org/packages/System.Threading.Channels ), it seems just 4 months old. The Channel class provides infrastructure to have multiple reads and write simuletensely through it's Reader and Writer properties. This is where it is handy in case of SignalR where data streaming needs to be done but is not just limited to that but wherever something needs to be read/write/combination of both in a multi-threading environment. In my case with SignalR, I had to stream stock data at a regular interval of time. public ChannelReader<StockData> StreamStock() { var channel = Channel.CreateUnbounded<StockData>(); _stockManager.OnStockData = stockData => { channel.Writer.TryWrite(stockData); }; return channel.Reader; } The SignalR keeps return type of ChannelReader<StockData> open so that whatev...
Post a Comment
Read more

A wrapper implementation for Kendo Grid usage

A wrapper implementation for any heavily used item is always a good practice. Whatever is not written by us and used at a lot of places should be wrapped within specific functionality to keep it future proof and easily changeable. This also encourages DRY principle to keep our common setting at a central place. Kendo UI items are enormous in configuration, one of an issue I find people keep repeating codes for Kendo Grid configuration. They have built very flexible system to have any configuration, but in most of the cases, we do not need all of those complicated configuration. We would try to see a simpler configuration of same. The actual core implementation is bit complex, but we do not have to bother about it once done since the focus is just on usage only. I recommend doing this practice for as simple as jQuery events, form handling or as simple as any notification system. This just won't make things simple but makes codes much more manageable, easy understand, read or open f...
Post a Comment
Read more