configuration.getValue 或 configuration.getsection 总是返回 null

Question

我是 .Net Core 的新手，并试图从 appsettings.json 文件中获取值，但我错过了一些非常基本的东西。请让我知道我做错了什么...... 这是代码...

Program.cs

 WebHost.CreateDefaultBuilder(args)
 .ConfigureAppConfiguration((hostingContext, config) =>
 {
      config.SetBasePath(Directory.GetCurrentDirectory());
 })

Startup.cs

public IConfiguration Configuration { get; private set; }
public Startup(IConfiguration configuration)
{
    Configuration = configuration;
}
public void ConfigureServices(IServiceCollection services)
{
    services.Configure<EmailSettings>(Configuration.GetSection("EmailSettings"));
}

Web API 控制器

private readonly IConfiguration config;

public EmailController(IConfiguration configuration)
{
    if (configuration != null)
    {
        config = configuration;
    }
}

动作方法

var emailTemplatesRelativePath = config.GetSection("EmailSettings");
var email = config.GetValue<string>("Email");

以上两行都为GetSection 和GetValue 返回空值

appsettings.json

{
  "Logging": {
    "LogLevel": {
      "Default": "Trace",
      "Microsoft": "Information"
    }
  },
  "ConnectionStrings": {
    "FCRContext": "server=xxx;database=xxx;user id=xxx;password=xxx"
  },
  "AllowedHosts": "*",
  "EmailSettings": {
    "EmailTemplatesPath": "EmailTemplates"
  },
  "Email": "aa@aa.com"
}

Answer 1

在 Controller 中访问配置与在 Startup.cs 中的工作方式略有不同。我之前做过这个，只需按照以下步骤操作：

Nuget：Microsoft.Extensions.Configuration.Binder

将您想要访问的所有配置放在控制器中的一个部分中，例如“电子邮件设置”：

appsettings.json

{
  "EmailSettings": {
    "EmailTemplatesPath": "EmailTemplates",
    "Email": "aa@aa.com"
  }
}

然后在您的 Web API 项目中创建一个名为 EmailSettings.cs 的类：

EmailSettings.cs

public class EmailSettings
{
    public string EmailTemplatesPath { get; set; }
    public string Email { get; set; }
}

然后将您的配置值绑定到Startup.cs 中的EmailSettings 类的实例，并将该对象添加到依赖注入容器：

Startup.cs

public void ConfigureServices(IServiceCollection services)
{
    ...
    EmailSettings emailSettings = new EmailSettings();
    Configuration.GetSection("EmailSettings").Bind(emailSettings);
    services.AddSingleton(emailSettings);
}

现在您可以在 Api 控制器中请求您的配置，只需将其添加到构造函数中，如下所示：

Web API 控制器

[Route("api/[controller]")]
[ApiController]
public class ValuesController : ControllerBase
{
    EmailSettings _emailSettings;

    public ValuesController(EmailSettings emailSettings)
    {
        _emailSettings = emailSettings;
    }
....
}

刚刚在我当前的项目（.NET Core 2.2 Web Api）中再次尝试，它成功了。我在 ValuesController 构造函数中放置了一个断点，_emailSettings 对象包含来自appsettings.json 文件的值。你应该可以复制和粘贴这个！玩得开心！ :)

Answer 2

在 IIS（或 IIS Express）内托管 in-process 时，Directory.GetCurrentDirectory() 将返回与运行 out-of-process 时返回的路径不同的路径。在 ASP.NET Core 2.1 之前，基于 IIS 的托管始终是进程外的，但 ASP.NET Core 2.2 引入了进程内运行的能力（这是创建新项目时的默认设置）。

在进程外运行时，Directory.GetCurrentDirectory() 将返回您的 ASP.NET Core 应用程序本身的路径，而在进程内运行时，它将返回到 IIS（或 IIS Express，例如“C: \Program Files\IIS Express")。

从你的问题来看，相关代码是这样的：

WebHost.CreateDefaultBuilder(args)
    .ConfigureAppConfiguration((hostingContext, config) =>
    {
        config.SetBasePath(Directory.GetCurrentDirectory());
    })

在这里，在您调用SetBasePath 之前，IConfigurationBuilder 已经设置为使用正确的路径。您的调用本身会覆盖此路径，将其设置为例如“C:\Program Files\IIS Express”。使用此 覆盖 基本路径，您的 appsettings.json 等文件将不再存在，因为它们不存在于例如“C:\Program Files\IIS Express”，因此不会从这些文件中加载配置。

解决方案只是删除您对ConfigureAppConfiguration 的调用，这样基本路径就不会被覆盖。我知道你已经发现了这一点，但我想确保你对这里出了什么问题有一个解释。

Answer 3

您犯了一个简单的错误，忘记在“EmailSettings”中添加“Email”。如下所示更新您的 json 并使用config.GetSection("EmailSettings")["Email"]; 获取电子邮件

"EmailSettings": {
    "EmailTemplatesPath": "EmailTemplates",
    "Email": "aa@aa.com"
  },

希望这能解决您的问题。

编辑：

如果您想从 appsettings 中获取这些值，而不是启动，您应该将这些配置值加载到设置类中，然后将适当的 IOptions 实例注入您要在其中使用这些设置的方法构造函数。为此，请看我的回答here。

Answer 4

Program.cs

public class Program
    {
        public static void Main(string[] args)
        {
            CreateWebHostBuilder(args).Build().Run();

        }

        public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
            WebHost.CreateDefaultBuilder(args)
             .UseStartup<Startup>();
    }

Startup.cs：

public partial class Startup
    {
        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc();
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IAntiforgery antiforgery)
        {
            app.UseMvcWithDefaultRoute();
        }
    }

控制器类

您需要使用 Bind() 方法从 section 中获取值。

EmailSetting option = new EmailSetting();
            //You need to bind the section with data model, 
            //it will automatically map config key to property of model having same name
            config.GetSection("EmailSettings").Bind(option);

            //Alternative to this you can read nested key using below syntax
            var emailTemplatesPath = config["EmailSettings:EmailTemplatesPath"];
            var emailInEmailSettings = config["EmailSettings:Email"];
            // If email key is not nested then you can access it as below
            var email = config.GetValue<string>("EmailOutside");

电子邮件设置模型：-（属性名称应与配置键匹配）

public class EmailSetting
    {
        public string EmailTemplatesPath { get; set; }
        public string Email { get; set; }
    }

Appsetting.json:-

    {
       "AllowedHosts": "*",
        "EmailSettings": {
            "EmailTemplatesPath": "EmailTemplates",
            "Email": "aa@aa.com"
          },
          "EmailOutside": "aa@aa.com"
        }

Answer 5

虽然其他人已经解决了这个问题，但如果您想保持启动服务代码不变，只需将您的 Web API 控制器更改为以下内容：

private readonly EmailSettings _emailSettings;

public EmailController(IOptions<EmailSettings> emailSettings)
{
    _emailSettings = emailSettings.Value;
}

重点是.Value。这就是您的代码返回 null 的原因。我还建议将 program.cs 更改回默认值。要在操作方法中使用它，只需执行以下操作：

_email.settings.EmailTemplatesPath

最后一件事 - 确保您的 EmailSettings 类结构与您的 json 完全相同。

Answer 6

你可以这样做

services.Configure<EmailSettings>(Configuration.GetSection("EmailSettings"));
services.AddTransient(p => p.GetRequiredService<IOptions<EmailSettings>>().Value);

并通过构造函数 DI 初始化 EmailSettings 对象。