#if DEBUG与env.IsDevelopment()的适用场景及选择依据

刚好前段时间做项目的时候也纠结过这个问题，结合实际开发经验给你梳理下这两种方式的适用场景和优先级判断：

一、#if DEBUG：编译阶段生效的条件指令 #

#if DEBUG是C#预处理器指令，代码是否被包含进最终程序集，完全取决于你编译时的配置（Debug/Release）——Release编译时，#if DEBUG包裹的代码会被直接剔除，不会出现在发布后的dll里。

适用场景： #

• 仅开发编译时需要的调试代码：比如注入只在本地调试用的辅助服务、输出极详细的调试日志（这些代码如果带到生产环境，要么没用还占体积，甚至可能泄露敏感信息）
• 调试专属工具/逻辑：比如给实体类加测试用的构造函数、开发阶段才触发的断言检查，或者引用一些只在Debug模式下才兼容的分析工具
• 避免Debug代码进入生产：如果某些代码绝对不能出现在生产环境里，用#if DEBUG是最保险的，因为编译后直接没了，不会有运行时误触发的可能

示例代码： #

public void ConfigureServices(IServiceCollection services)
{
    // 所有环境通用的服务注册
    services.AddControllersWithViews();

#if DEBUG
    // 仅Debug编译时才会注册的调试服务
    services.AddScoped<IDebugLogger, ConsoleDebugLogger>();
    // 开发编译阶段启用的性能分析工具
    services.AddMiniProfiler(options => options.RouteBasePath = "/profiler");
#endif
}

二、ASP.NET Core环境名称：运行时的环境判断 #

ASP.NET Core的环境名称（通过IWebHostEnvironment.IsDevelopment()/IsProduction()等方法判断）是运行时生效的——不管你编译的是Debug还是Release包，只要运行环境配置的是Development，就会执行对应的逻辑，反之亦然。

适用场景： #

• 运行时的差异化配置：比如开发环境连本地SQL Server，测试环境连测试库，生产环境连云数据库；开发环境用内存缓存，生产环境用Redis
• 中间件的条件启用：开发环境开开发者异常页（能看到详细错误堆栈），生产环境用友好的自定义错误页；开发环境启Swagger文档，生产环境关闭
• 依赖注入的动态替换：开发环境注入模拟的第三方服务实现（比如模拟支付回调），生产环境注入真实的服务
• 日志级别控制：开发环境输出Debug级别的日志方便排查问题，生产环境只输出Warning及以上的日志减少磁盘占用

示例代码： #

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        // 开发环境启用开发者异常页
        app.UseDeveloperExceptionPage();
        // 开发环境启用Swagger
        app.UseSwagger();
        app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1"));
    }
    else
    {
        // 生产环境启用全局错误处理和HSTS
        app.UseExceptionHandler("/Home/Error");
        app.UseHsts();
    }

    // 所有环境通用的中间件
    app.UseHttpsRedirection();
    app.UseStaticFiles();
    app.UseRouting();
    app.UseAuthorization();
    app.MapControllerRoute(
        name: "default",
        pattern: "{controller=Home}/{action=Index}/{id?}");
}

三、优先选择哪种方式？ #

• 如果是和运行环境相关的动态行为/配置，优先用ASP.NET Core的环境名称判断——它的灵活性更高：你可以把Debug编译的包部署到测试环境，也可以把Release编译的包在本地开发环境运行，运行时判断能完美适配这些场景
• 如果是纯粹的编译阶段调试代码，或者某些代码绝对不能出现在生产程序集里，就用#if DEBUG——这种方式能彻底把调试代码从发布包中移除，避免潜在的性能问题或信息泄露

内容的提问来源于stack exchange，提问作者webwake