Log4Net – Logging for .NET

May 16, 2012 2 comments

Before I was thinking of rewriting my own logging for my application but after having a careful thought, I decided just to get one from NuGet package instead of reinventing the wheel. I heard a lot about Log4Net and decided to try that out. It’s really simple to get this logging up and running on your application

This is what you need to do:

1. install Log4Net from NuGet

2. Modify your web.config to add a new section and new configuration – In this case, I decided to use FileLogger. but you can have different type logger if you want (e.g event log, console, etc) or you can even build your own one that implemented ILog, this configuration allow you to create a new log file when the log file already reached the limit

Code Snippet
  1. <configSections>
  2.     <section name=“log4net” type=“log4net.Config.Log4NetConfigurationSectionHandler, log4net“ />
  3.   </configSections>
  5.   <log4net>
  6.     <root>
  7.       <levelvalue=“DEBUG“ />
  8.       <appender-ref ref=“LogFileAppender“ />
  9.     </root>
  10.     <appender name=“LogFileAppender“ type=“log4net.Appender.RollingFileAppender“ >
  11.       <param name=“File” value=“C:\\log.txt“ />
  12.       <param name=“AppendToFile” value=“true“ />
  13.       <rollingStyle value=“Size“ />
  14.       <maxSizeRollBackups value=“10“ />
  15.       <maximumFileSize value=“10MB“ />
  16.       <staticLogFileName value=“true“ />
  17.       <layout type=“log4net.Layout.PatternLayout“>
  18.         <param name=“ConversionPattern“ value=“%-5p%d{yyyy-MM-dd hh:mm:ss} – %m%n“ />
  19.       </layout>
  20.     </appender>
  21.   </log4net>

3. Code implementation – in this case I decided to register it in my global container and retrieve it later. You need to call log4net.Config.XmlConfigurator.Configure in order for Log4Net to get the settings from web.config – This is very important otherwise you will find that there is no log being generated

Code Snippet
  1. protected void Application_Start()
  2.         {
  3.             AreaRegistration.RegisterAllAreas();
  5.             RegisterGlobalFilters(GlobalFilters.Filters);
  6.             RegisterRoutes(RouteTable.Routes);
  8.             BundleTable.Bundles.RegisterTemplateBundles();
  9.             RegisterDependency();
  11.         }
  13.         #region “Dependency Injection”
  15.         private static Container Container;
  17.         public static T GetInstance<T>() where T : class
  18.         {
  19.             return Container.GetInstance<T>();
  20.         }
  22.         protected void RegisterDependency()
  23.         {
  24.             //Create a main containers
  25.             var container = new Container();
  27.             // 2. Configure the container (register)
  28.             container.RegisterPerWebRequest<IUnitOfWork>(() => new UnitOfWork(new PosDataContext()));
  30.             //Register logger
  31.             log4net.Config.XmlConfigurator.Configure();
  32.             container.Register<ILog>(() => log4net.LogManager.GetLogger(typeof(MvcApplication)));
  34.             container.Verify();
  35.             Container = container;
  36.         }
  38.         #endregion

calling the logger from my code (controller in this context)

Code Snippet
  1. public ActionResult Index()
  2.         {
  3.             ViewBag.Message = “Menu”;
  5.             MvcApplication.GetInstance<ILog>().Info(“Test Info”);
  6.             MvcApplication.GetInstance<ILog>().Error(“Test Error”);
  7.             MvcApplication.GetInstance<ILog>().Debug(“Test Debug”);
  9.             return View();
  10.         }

PS: if you want to implement your own logger, then I’d recommend you to have your logger to implement ILog interface and change it through web.config but don’t wrap/call Log4Net inside your custom logger because you don’t want to limit the rich functionality of Log4Net with your custom logger

Another tips, is when you started to add logging in your application then there should be some performance overhead eventhough it is minor. In the example below MyFunctionOutput function will still be called eventhough you disabled the logging on the config, in order to make sure the debugging code only executed

Code Snippet
  1. MvcApplication.GetInstance<ILog>().Debug(“My Function Output:” + MyFunctionOutput());

When you want to have the debug/logging omitting the log whenever the logging is enabled then you can wrap around the logging with this property (there are another properties IsErrorEnabled, IsInfoEnabled, etc)

Code Snippet
  1. if (MvcApplication.GetInstance<ILog>().IsDebugEnabled)
  2.             {
  3.                 MvcApplication.GetInstance<ILog>().Debug(“My Function Output:” + MyFunctionOutput());
  4.             }
Categories: .NET Tags: ,

Pass Model from Javascript to MVC Controller

May 15, 2012 Leave a comment

Initially, I always pass individual object properties through JSON and form the model in the controller as I wasn’t sure how to pass/form a model from Javascript to controller

Controller

Code Snippet
  1. [AllowAnonymous]
  2.         public ActionResult JsonRegister(string username, string password, string confirmpassword,
  3.                                             string email, string confirmemail)
  4.         {
  5.             MemberModel.RegistrationModel model = new MemberModel.RegistrationModel() {
  6.                                                                                         UserName = username,
  7.                                                                                         Password = password,
  8.                                                                                         ConfirmPassword = confirmpassword,
  9.                                                                                         Email = email,
  10.                                                                                         ConfirmEmail = confirmemail };

Javascript

Code Snippet
  1. $.getJSON(‘@Url.Action(“JsonRegister”)‘, { UserName: $(“#UserName”).val(),
  2.                                                     Password: $(“#Password”).val(),
  3.                                                     ConfirmPassword: $(“#ConfirmPassword”).val(),
  4.                                                     Email: $(“#Email”).val(),
  5.                                                     ConfirmEmail: $(“#ConfirmEmail”).val()
  6.                                                 }, function (RegisterResult) {
  7.                                                         if (RegisterResult.success) {
  8.                                                             $(‘#RegistrationFields’).hide();
  9.                                                             $(‘#ErrorMessage’).text(”);
  10.                                                             $(‘#RegistrationMessage’).css(‘display’, ”);
  11.                                                         }
  12.                                                         else {
  13.                                                             $(‘#ErrorMessage’).css(‘display’, ”).text(RegisterResult.errors);
  14.                                                         }
  15.         });

the code above is working just fine but I still feel that there is room for improvement. Below is the code that shows how you can still have your controller accepting the model instead of expanding the properties in the model as the parameters to the controller. The solution is just to have the model being assigned to a variable (in this context called as data) before passing it to the JSON, my previous code was forming the actual object in the JSON code

Controller

Code Snippet
  1. [AllowAnonymous]
  2.         public ActionResult JsonRegister(MemberModel.RegistrationModel model)
  3.         {
  4.             string error = string.Empty;
  6.             if (ModelState.IsValid)

Javascript

Code Snippet
  1. var data = { UserName: $(“#UserName”).val(),
  2.             Password: $(“#Password”).val(),
  3.             ConfirmPassword: $(“#ConfirmPassword”).val(),
  4.             Email: $(“#Email”).val(),
  5.             ConfirmEmail: $(“#ConfirmEmail”).val()
  6.         };
  8.         $.getJSON(‘@Url.Action(“JsonRegister”)‘, data, function (RegisterResult) {
  9.             if (RegisterResult.success) {
  10.                 $(‘#RegistrationFields’).hide();
  11.                 $(‘#ErrorMessage’).text(”);
  12.                 $(‘#RegistrationMessage’).css(‘display’, ”);
  13.             }
  14.             else {
  15.                 $(‘#ErrorMessage’).css(‘display’, ”).text(RegisterResult.errors);
  16.             }
  17.         });
Categories: ASP.NET MVC, Javascript

ModelState Errors in MVC through JSON

May 15, 2012 Leave a comment

Normally, when you used HttpPost/Form submission to post the view through the controller then you can have the model validation applied automatically through @Html.ValidationSummary()

But how do you get the ModelState errors through Json? You can still use LINQ to get the model errors from the ModelState and pass it through JSON

Code Snippet
  1. public ActionResult JsonRegister(MemberModel.RegistrationModel model)
  2.         {
  3.             string error = string.Empty;
  5.             if (!ModelState.IsValid)
  6.             {
  7.                 IEnumerable<System.Web.Mvc.ModelError> modelerrors = ModelState.SelectMany(x => x.Value.Errors);
  8.                 foreach (var modelerror in modelerrors)
  9.                 {
  10.                     error += modelerror.ErrorMessage + “\n”;
  11.                 }
  12.             }
  13.             return Json(new { success = false, errors = error }, JsonRequestBehavior.AllowGet);
  14.         }
Categories: ASP.NET, ASP.NET MVC

SlideRocket – Cloud

May 14, 2012 Leave a comment

This is the cloud version of Microsoft Power Point. It is created by the company that I’m working for at the moment. I’m blogging this not because I’m working for them but I’m blogging this based on my personal opinion

It is a powerful web application and It really works as it allows you to use Slide Rocket to share and collaborate your presentation slides with everyone and you don’t need to carry your power point slides file or your laptop. It supports mobile device as well such as an iPad. You just need a connection to the internet

For the standard functionality (Create a presentation slides), it is FREE for life but when you want to use versioning for your presentation, or when you want to have more security control over your presentation, or even to analyse who has accessed your slide and when was it then you need to have monthly subscription. Check it out guys

http://www.sliderocket.com

ps: some guy is using this web application for their resume! and it’s impressive!

http://www.sliderocket.com/blog/2012/05/creative-resume-idea/?utm_source=feedburner&utm_medium=feed&utm_campaign=Feed%3A+SliderocketMissionControl+%28SlideRocket+Mission+Control%29

Categories: Uncategorized

Dependency Injection using Simple Injector Tutorial

May 14, 2012 Leave a comment

This is a simple tutorial in how to use Dependency Injection using SimpleInjector (You can get this package from NuGet)

In this case, I use SimpleInjector to manage my Data Context – I want my Data Context to be per request (Unit of Work per request). The concept of this dependency Injection is to have a global container where you can resolve your object from

1. Create an extension method to the Simple Injector

Code Snippet
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Web;
  5. using SimpleInjector;
  6. using System.Diagnostics;
  7. using System.Linq.Expressions;
  9. ///<summary>
  10. /// Extension methods for registering types on a per web request basis.
  11. ///</summary>
  12. public static partial class SimpleInjectorPerWebRequestExtensions
  13. {
  14.     [DebuggerStepThrough]
  15.     public static void RegisterPerWebRequest<TService, TImplementation>(
  16.         this Container container)
  17.         where TService : class
  18.         where TImplementation : class, TService
  19.     {
  20.         Func<TService> instanceCreator =
  21.             () => container.GetInstance<TImplementation>();
  23.         container.RegisterPerWebRequest<TService>(instanceCreator);
  24.     }
  26.     [DebuggerStepThrough]
  27.     public static void RegisterPerWebRequest<TService>(
  28.         this Container container,
  29.         Func<TService> instanceCreator) where TService : class
  30.     {
  31.         var creator =
  32.             new PerWebRequestInstanceCreator<TService>(instanceCreator);
  34.         container.Register<TService>(creator.GetInstance);
  35.     }
  37.     [DebuggerStepThrough]
  38.     public static void RegisterPerWebRequest<TConcrete>(this Container container)
  39.         where TConcrete : class
  40.     {
  41.         container.Register<TConcrete>();
  43.         container.ExpressionBuilt += (sender, e) =>
  44.         {
  45.             if (e.RegisteredServiceType == typeof(TConcrete))
  46.             {
  47.                 var transientInstanceCreator = Expression.Lambda<Func<TConcrete>>(
  48.                     e.Expression, new ParameterExpression[0]).Compile();
  50.                 var creator = new PerWebRequestInstanceCreator<TConcrete>(
  51.                     transientInstanceCreator);
  53.                 e.Expression = Expression.Call(Expression.Constant(creator),
  54.                     creator.GetType().GetMethod(“GetInstance”));
  55.             }
  56.         };
  57.     }
  59.     [DebuggerStepThrough]
  60.     public static void DisposeInstance<TService>() where TService : class
  61.     {
  62.         object key = typeof(PerWebRequestInstanceCreator<TService>);
  64.         var instance = HttpContext.Current.Items[key] as IDisposable;
  66.         if (instance != null)
  67.         {
  68.             instance.Dispose();
  69.         }
  70.     }
  72.     private sealed class PerWebRequestInstanceCreator<T> where T : class
  73.     {
  74.         private readonly Func<T> instanceCreator;
  76.         internal PerWebRequestInstanceCreator(Func<T> instanceCreator)
  77.         {
  78.             this.instanceCreator = instanceCreator;
  79.         }
  81.         [DebuggerStepThrough]
  82.         public T GetInstance()
  83.         {
  84.             var context = HttpContext.Current;
  86.             if (context == null)
  87.             {
  88.                 // No HttpContext: Let’s create a transient object.
  89.                 return this.instanceCreator();
  90.             }
  92.             object key = this.GetType();
  94.             T instance = (T)context.Items[key];
  96.             if (instance == null)
  97.             {
  98.                 context.Items[key] = instance = this.instanceCreator();
  99.             }
  101.             return instance;
  102.         }
  103.     }
  104. }

2. Modify Global.asax – The class name will be MvcApplication in MVC Project

Code Snippet
  1. #region “Dependency Injection”
  3.         private static Container Container;
  5.         public static T GetInstance<T>() where T : class
  6.         {
  7.             return Container.GetInstance<T>();
  8.         }
  10.         protected void RegisterDependency()
  11.         {
  12.             //Create a main containers
  13.             var container = new Container();
  15.             // 2. Configure the container (register)
  16.             container.RegisterPerWebRequest<IUnitOfWork>(() => new UnitOfWork(new PosDataContext()));
  17.             container.Register<ITableRepository, TableRepository>();
  18.             container.Verify();
  19.             Container = container;
  20.         }
  22.         #endregion
  24.         protected void Application_Start()
  25.         {
  26.             AreaRegistration.RegisterAllAreas();
  28.             RegisterGlobalFilters(GlobalFilters.Filters);
  29.             RegisterRoutes(RouteTable.Routes);
  31.             BundleTable.Bundles.RegisterTemplateBundles();
  32.             RegisterDependency();
  33.         }
  35.         protected void Application_EndRequest(object src, EventArgs e)
  36.         {
  37.             ServiceStack.MiniProfiler.Profiler.Stop();
  38.             SimpleInjectorPerWebRequestExtensions.DisposeInstance<IUnitOfWork>();
  39.         }

3. Consume it from the controller – Call the container in the Global.asax to resolve the object (GetInstance function)

Code Snippet
  1. public ActionResult Index()
  2.         {
  3.             ViewBag.Title = “Tables”;
  4.             return View(MvcApplication.GetInstance<IUnitOfWork>().TableRepository.Get(e => e.Active));
  5.         }
Categories: .NET

IoC Container Benchmarks

May 13, 2012 Leave a comment

I found this benchmark for different IoC in .NET. Personally I’ve been using Unity, Ninject and SimpleInjector. I like SimpleInjector because it is very simple and surprisingly it is quite fast compared with the rest. Performance is just one of the aspect of IoC but it doesn’t always mean everything

http://www.palmmedia.de/Blog/2011/8/30/ioc-container-benchmark-performance-comparison

http://www.iocbattle.com/

Categories: .NET

Debugging Knockout

May 10, 2012 Leave a comment

I’ve been learning Knockout recently and I found that sometimes it is hard to find out how your View Model is being formed especially when you create the view from Model in MVC

To inspect your view model, you can use firebug console and run below command, this will give you a full navigated View Model and allow you to drill down

console.group(“Dumping view model”);
console.dir(ko.toJS(new JobResultViewModel()));
console.groupEnd();

alternatively you can also put this code in your template

<div data-bind=”text: ko.toJSON($data)”></div>

Feel free to let me know if you have any other way to debug

Categories: Javascript
Follow

Get every new post delivered to your Inbox.

Join 225 other followers