Skip to main content

Filters In ASP.NET MVC Core.





Introduction.

Filters in ASP.NET Core MVC allow you to run code before or after specific stages in the request processing pipeline. In ASP.net Core MVC user will be routed to appropriate contoller and action if there is need to execute some logic before executing and after executing
MVC Filters are used.

There are many built-in filters available with ASP.NET Core MVC, and we can create custom filters as well.Filters can avoid duplicating code across actions

The following are the list of filter types, interface which must be implemented to create a custom filter class.


Filter types



Each filter type is executed at a different stage in the filter pipeline. below are list of different filters.

Authorization filters:
The Authorization filter will run first and are used to determine whether the current user is authorized or unauthorized for the current request.
we can also create custom authorization filter.

Resource filters:
the Resource filter is the first to handle a request after authorization.
it can run code before and after the rest of the filters executed. it can be run before model binding
it can be used for implementing cache and also crypto filter we see in another article.

Action filters:
the Action filter can run code immediately before and after an individual action method is called.
this can be execute before and after any contoller action execution. We can also manipulate the model property value binding.

Exception filters:
the Exception filters are used to unhandled exceptions that occur before anything has been written to the response body.
this filter is generally used to handle exceptions at global, class or contoller action level.

Result filters:
the Result filters can run code before and after the execution of individual action results.

this filter is  executed when the action method has executed successfully.


Filter Order:

As mentioned above, Asp.Net MVC Core includes different types of filters and multiple filters can be applied to a single controller class or action method.
So, filters run in the following order.

1. Authorization filters
2. Resource filters
3. Action filters
4. Exception filters
5. Result filters

Register Filter Scope:

We can register filter into three level in ASP .Net core Mvc application.

1. Global Level.
2. Class level.
3. Method Level.

Global Level.

You can register filter global level into Startup.cs file as startup file is global file same as global.asax file in .net application.
Global filters will be applied to all the controller and action methods of an application.

Code Sample:

public void ConfigureServices(IServiceCollection services)
        {
           services.AddMvc(
                config =>
                {
                    config.Filters.Add(typeof(MvcExceptionHandler)); - add you filter which you need to register globally
                }
               );
        }

Class level.

You can implement filter at class level or controller level so, filters will be applicable to all methods of that particular class or controller.

Code Sample:

[MvcAuthentication]
public class HomeController : Controller
{
    public ActionResult Index()
    {
        return View();
    }
}

Method Level.

You can implement filter at method level so, filters will be applicable to that particular method only.

Code Sample:

public class HomeController : Controller
{
 [MvcAuthentication]
    public ActionResult Index()
    {
        return View();
    }
}

Same way we can use multiple built-in in filters at different level.








Comments

Post a comment

Popular posts from this blog

Custom AuthorizeAttribute in ASP.NET Core.

Introduction. Filter in MVC are attribute which can be apply to controller and action method. filters allow us to write our custom code before and after method execution. filters can be implemented into different level of scope Global, Class, and Method level. MVC provides different types of filters. The Authorization filter will run first and are used to determine whether the current user is authorized or unauthorized for the current request. In this article we will learn how to create custom authorization filter, were you can write your own authorization framework. Description. For creating Authorization filter IAuthorizationFilter interface must be inherited. For example, the following code demonstrate custom Authorization below CustomAuthorization attribute allow only Home controller to access the particular method under home controller class else it will return "error" in response if it is called via ajaxcall, otherwise it will be redirect to Sessi

How to use Log4Net in .Net Core 2.0 Application.

1. Introduction Logging frameworks are important because they make it easy to write your logs to different places by simply changing your configuration. You can write your .NET logs to a file on disk, a database, a log management system 2. Install Nuget Package For nlog  To use Nlog logging you need to first add Nlog pluging for adding pluging you can do it by different way. 1) Manage Nuget Packages. 2) Nuget command. you can find nuget command for Log4Net below. PM> Install-Package log4net -Version 2.0.8 3. Add log4net.config file We need to Add New to your project with name log4net.config Refer below code for log4net.config for logging log into file. Root is neccesary in log4net.config, in which we can define log level and appender-ref in which we can define appender for eg. FileAppender, ConsoleAppender. Layout : In layout we can define custom parameter sh

Enabling FxCop Code Analysis on .NET Core

Enabling FxCop Code Analysis on .NET Core. Description :- Code Analysis is important Because it is helpful from many aspects like Code Quality, Code Correctness, Code maintainability will remain great code for long time. Step 1.  Install Nuget Package : Microsoft.CodeAnalysis.FxCopAnalyzers   Click Here  to install Nuget. Refer Below screen shot additional packages will be installed after installing. Step 2. File with name FxCop.ruleset will be created in solution when you try to change action by right clicking on rule in visual studio as shown below. where you can find list of rule to be configured. If you have multi layer Architecture and you want to use similar ruleset for all layers then move ruleset file at parent level of project and add reference of that ruleset file to each project were we need to add FxCop rules. Ruleset path can be set at csproj level as below. I have added CodeAnalysisRuleSet within PropertyGroup with relevant path of code analysis r