Basics Of ASP.NET Core Using Visual Studio 2017 - Part Two

Introduction

This article explains about ASP.NET Core using Visual Studio 2017 and how to create ASP.NET Core applications in simple ways. Before reading this article, please read the previous part of this article at the below link.

Summary of the previous article

The previous part explained Kestrel, Content Root, Startup class, Application Insights, and Dependencies. This article continues that information and will explain about Configure method in a detailed way and how to develop a simple application with a simple example page.

Configure Method

This is a void method and it is called at run time. We use this method to configure the HTTP request pipeline. The configured class contains three parameters and these three parameters are an interface.

1.public void Configure(IApplicationBuilder app,IHostingEnvironment env,ILoggerFactory loggerfactory)  
2.{  
3.    //Codings  
4.}

 

IApplicationBuilder

IApplicationBuilder is an interface. It's name space is “Microsoft.AspNetCore.Builder”. It defines a class that provides the mechanisms to configure an application's request pipeline. IApplicationBuilder contains properties and methods.

01.namespace Microsoft.AspNetCore.Builder  
02.{  
03.       
04.    public interface IApplicationBuilder  
05.    {  
06.        IServiceProvider ApplicationServices { get; set; }  
07.        IFeatureCollection ServerFeatures { get; }  
08.        IDictionary<string, object> Properties { get; }  
09.        RequestDelegate Build();  
10.        IApplicationBuilder New();  
11.        IApplicationBuilder Use(Func<RequestDelegate, RequestDelegate> middleware);  
12.    }  
13.}

IHostingEnvironment

IHostingEnvironment is an interface and it's name space is **“**Microsoft.AspNetCore.Hosting”. It provides information about the web hosting environment an application is running on. It contains many properties; we can see the properties in the below code.

01.namespace Microsoft.AspNetCore.Hosting  
02.{  
03.    public interface IHostingEnvironment  
04.    {  
05.           
06.        string EnvironmentName { get; set; }  
07.        string ApplicationName { get; set; }  
08.        string WebRootPath { get; set; }  
09.        IFileProvider WebRootFileProvider { get; set; }  
10.        string ContentRootPath { get; set; }  
11.        IFileProvider ContentRootFileProvider { get; set; }  
12.    }  
13.}

ILoggerFactory

ILoggerFactory is another one of the interfaces. It's name space is “Microsoft.Extensions.Logging”.  It represents a type used to configure the logging system and create instances of ILogger from the registered ILoggerProviders.

01.namespace Microsoft.Extensions.Logging  
02.{  
03.    public interface ILoggerFactory : IDisposable  
04.    {  
05.           
06.        void AddProvider(ILoggerProvider provider);  
07.        ILogger CreateLogger(string categoryName);  
08.    }  
09.}

Run Application

We will simply build and run our demo ASP.NET Core application. Our demo application does not have any simple code right now. We are going to add some set of coding at Configure method in the Startup class, then run our application.

01.namespace DemoASP.NETCore  
02.{  
03.    public class Startup  
04.    {  
05.          
06.        public void ConfigureServices(IServiceCollection services)  
07.        {  
08.        }  
09.   
10.        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.  
11.        public void Configure(  
12.            IApplicationBuilder app,  
13.            IHostingEnvironment env,  
14.            ILoggerFactory loggerFactory  
15.            )  
16.        {  
17.              //Run application using interface parameter app  
18.app.Run(async (context) =>  
19.            {  
20.                await context.Response.WriteAsync("Hello World!");  
21.            });  
22.        }  
23.    }  
24.}

Here, configure the middle-ware compound using the Run method in Configure static method. We add some text to identify whether the middleware component responds or not. Now, we run the application in Internet Explorer or Microsoft Edge. After running the application, we can see that it looks like the below screenshot.

http://csharpcorner.mindcrackerinc.netdna-cdn.com/article/basics-in-asp-net-core-using-visual-studio-2017-part-two/Images/image001.jpg
Now, use this code to configure middlewere compounded in Configure method.

  1. public void Configure(  
  2.             IApplicationBuilder app,  
  3.             IHostingEnvironment env,  
  4.             ILoggerFactory loggerFactory  
  5.             )  
  6.         {  
  7.               
  8.             //app.Run(async (context) =>  
  9.             //{  
  10.             //    await context.Response.WriteAsync("Hello World!");  
  11.             //});  
  12.         }  

Now, build and run the demo application. We are getting "HTTP 404 Not Found" error because we did not configure any middleware in the pipeline. We can see the error in the below screenshot.

http://csharpcorner.mindcrackerinc.netdna-cdn.com/article/basics-in-asp-net-core-using-visual-studio-2017-part-two/Images/image002.jpg

Exception

We can easily handle the exceptions in ASP.NET Core. Whenever we get an exception, we can get more details to find the exceptions. For example, we add the following code in static Configure method.

01.public void Configure(  
02.            IApplicationBuilder app,  
03.            IHostingEnvironment env,  
04.            ILoggerFactory loggerFactory  
05.            )  
06.        {  
07.             
08.            app.Run((context) =>  
09.            {  
10.                //await context.Response.WriteAsync("Hello World!");  
11.                //below line force to throw exception  
12.                throw new Exception();  
13.            });  
14.        }

Now, build and run the demo core applications. We are getting "HTTP 500 Internal Server Error" but here, we did not get an exact error message or do not have any way to find it.

http://csharpcorner.mindcrackerinc.netdna-cdn.com/article/basics-in-asp-net-core-using-visual-studio-2017-part-two/Images/image003.jpg

We are adding Use Developer Exception Page in the middleware compound in configure method. The below code is adding the developer exception page.

01.public void Configure(  
02.            IApplicationBuilder app,  
03.            IHostingEnvironment env,  
04.            ILoggerFactory loggerFactory  
05.            )  
06.        {  
07.   
08.            if (env.IsDevelopment())  
09.            {  
10.                app.UseDeveloperExceptionPage();  
11.            }  
12.   
13.            app.Run((context) =>  
14.            {  
15.                //await context.Response.WriteAsync("Hello World!");  
16.                throw new Exception();  
17.            });  
18.        }

Using interface parameter env, it checks that  current application is developed and it makes sure it is not a production. Now, build and run the application. We can see the detailed message of exception; it helps to find errors. The below error page contains Stack, Query, Cookies, and headers.

http://csharpcorner.mindcrackerinc.netdna-cdn.com/article/basics-in-asp-net-core-using-visual-studio-2017-part-two/Images/image004.jpg

We can see the Stacks, Query, Cookies and Header tabs in the below screenshots.

Stacks

http://csharpcorner.mindcrackerinc.netdna-cdn.com/article/basics-in-asp-net-core-using-visual-studio-2017-part-two/Images/image005.jpg

Query

**http://csharpcorner.mindcrackerinc.netdna-cdn.com/article/basics-in-asp-net-core-using-visual-studio-2017-part-two/Images/image006.jpg
**

Cookies

**http://csharpcorner.mindcrackerinc.netdna-cdn.com/article/basics-in-asp-net-core-using-visual-studio-2017-part-two/Images/image007.jpg
**

Headers

**http://csharpcorner.mindcrackerinc.netdna-cdn.com/article/basics-in-asp-net-core-using-visual-studio-2017-part-two/Images/image008.jpg
**

Conclusion

This article explained about the basic of the ASP.NET Core. The above-mentioned basics can really help the developers at all levels.