This article describes error handling using global filters for all controllers. To learn other error handling method, you can see following articles:
- Using HandleError() attribute at the method level
- Using HandleError() attribute at the controller level
Step 1
Create a MVC project from the "Empty" template. Right-click on "Controllers" and select "Add" >> "Controller...".
Step 2
Select "MVC 5 Controller - Empty" to add an empty controller. Click on the "Add" button.
Step 3
Name the controller "HomeController". The Index() action result method will be added.
Step 4
To add a view, right-click on "Index" and select "Add View...".
Step 5
Name the view and select "Empty (without model)" as the template. Click on the "Add" button.
Step 6
Now we need to create a custom error page so that when an error occurrs, this custom error page is displayed. This error page is common for all kinds of errors generated through any page. So we create it under the shared folder. Right-click on “Views”, select “Add” >> “New Folder”.
Step 7
Name the folder "Shared", this will create a "Shared" folder under the view.
Step 8
Right-click on the "Shared" folder and select "Add" >> "View…".
Step 9
Name the view "Error" and select "Empty (without model)" as the template.
Step 10
Design your desired custom error page in Error.cshtml.
Step 11
Open the web.config file, set the customErrors mode=”On” under system.web. If you do not want to display a custom error page then you can set it to “Off”.
Step 12
Generate an exception inside the index action method.
Step 13
Right-click on “App_Start”, select “Add” >> “Class…”.
Step 14
Select “Class” from the installed templates and provide an appropriate name like "ErrorConfig".
Step 15
In the following code snippet you can see the static method that accepts a GlobalFilterCollection and adds our HandleErrorAttribute into the filter collection or we can say the register global filter. Without any additional modification in the controllers and their action methods we add a HandleErrorAttribute for all the controllers.
Step 16
Now call this static method inside the Application_Start event of Global.asax.cs, so that it will be implemented as soon as the application starts.
Step 17
Now run the project and you will get a NullReferenceException since the session "temp" is not available.
Step 18
Press "F5" and our custom error page is displayed.
