ASP.Net Core, detecting debugging vs. not debugging in a controller
It's not IHostingEnvironment
nowadays, it's IWebHostEnvironment
.
In ASP.NET Core 3.1, IHostingEnvironment
causes a warning
CS0618 'IHostingEnvironment' is obsolete: 'This type is obsolete
and will be removed in a future version.
The recommended alternative is
Microsoft.AspNetCore.Hosting.IWebHostEnvironment.'
Consequently, the accepted answer should be updated as follows:
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Hosting;
public class TestController : Controller
{
protected readonly IWebHostEnvironment HostEnvironment;
public TestController(IWebHostEnvironment hostEnv) {
this.HostEnvironment = hostEnv;
}
[HttpGet]
public IActionResult Test(){
if (this.HostEnvironment.IsDevelopment()){
// Do something
}
return View();
}
}
Update: @Pradeep Kumar's post below is the more correct answer here. This answer only indicates how to access the IsDevelopment() environment flag via dependency injection in a controller.
Update: IHostingEnvironment is obsolete in .Net Core 3.1 see the following for .Net Core 3.1+ https://stackoverflow.com/a/61703339/2525561
You should be able to just inject IHostingEnvironment into your controller constructor.
protected readonly IHostingEnvironment HostingEnvironment;
public TestController(IConfiguration configuration, IHostingEnvironment hostingEnv){
this.Configuration = configuration;
this.HostingEnvironment = hostingEnv;
}
[HttpGet]
public IActionResult Test(){
if(this.HostingEnvironment.IsDevelopment()){
// Do something
}
return View();
}
IHostingEnvironment
lets you know the environment in which the application is running. Looks like what you need is the build configuration used to build the application i.e Debug/Release. In an ASP.NET Core web application, In order to get this information at compile time, there is no straight forward way, however you can have a property with conditional compilation using compiler directives, something like
public static bool IsDebug
{
get
{
bool isDebug = false;
#if DEBUG
isDebug = true;
#endif
return isDebug;
}
}
At runtime, you can check the value of IsDebug property to determine the build configuration. I would suggest to add this property to a common static or utility class which can be accessible from all your controllers.