ChatGPT解决这个技术问题 Extra ChatGPT

从 .net 核心中的 appsettings.json 获取价值

不确定我在这里遗漏了什么,但我无法从我的 .net 核心应用程序中的 appsettings.json 获取值。我的 appsettings.json 为:

{
    "AppSettings": {
        "Version": "One"
    }
}

启动:

public class Startup
{
    private IConfigurationRoot _configuration;
    public Startup(IHostingEnvironment env)
    {
        _configuration = new ConfigurationBuilder()
    }
    public void ConfigureServices(IServiceCollection services)
    {
      //Here I setup to read appsettings        
      services.Configure<AppSettings>(_configuration.GetSection("AppSettings"));
    }
}

模型:

public class AppSettings
{
    public string Version{ get; set; }
}

控制器:

public class HomeController : Controller
{
    private readonly AppSettings _mySettings;

    public HomeController(IOptions<AppSettings> settings)
    {
        //This is always null
        _mySettings = settings.Value;
    }
}

_mySettings 始终为空。我在这里缺少什么吗?

read the documentation了解如何使用配置。您在启动类中设置了不正确的配置。
这甚至可以通过使用 IConfiguration 的依赖注入来简化。此处解释coding-issues.com/2018/10/…
这个问题有这么多截然不同的答案,这一事实凸显了这个问题。几乎让我想知道读取设置文件并反序列化为使用在线 json -> c# 类生成器创建的对象是否更容易。拥有非强类型的设置对我来说似乎很原始。

K
Kirk Larkin

程序和启动类

.NET 核心 2.x

您不需要在 Startup 构造函数中新建 IConfiguration。它的实现将由 DI 系统注入。

// Program.cs
public class Program
{
    public static void Main(string[] args)
    {
        BuildWebHost(args).Run();
    }

    public static IWebHost BuildWebHost(string[] args) =>
        WebHost.CreateDefaultBuilder(args)
            .UseStartup<Startup>()
            .Build();            
}

// Startup.cs
public class Startup
{
    public IHostingEnvironment HostingEnvironment { get; private set; }
    public IConfiguration Configuration { get; private set; }

    public Startup(IConfiguration configuration, IHostingEnvironment env)
    {
        this.HostingEnvironment = env;
        this.Configuration = configuration;
    }
}

.NET 核心 1.x

您需要告诉 Startup 加载 appsettings 文件。

// Program.cs
public class Program
{
    public static void Main(string[] args)
    {
        var host = new WebHostBuilder()
            .UseKestrel()
            .UseContentRoot(Directory.GetCurrentDirectory())
            .UseIISIntegration()
            .UseStartup<Startup>()
            .UseApplicationInsights()
            .Build();

        host.Run();
    }
}

//Startup.cs
public class Startup
{
    public IConfigurationRoot Configuration { get; private set; }

    public Startup(IHostingEnvironment env)
    {
        var builder = new ConfigurationBuilder()
            .SetBasePath(env.ContentRootPath)
            .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
            .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true)
            .AddEnvironmentVariables();

        this.Configuration = builder.Build();
    }
    ...
}

获取价值

您可以通过多种方式获取从应用设置中配置的值:

使用 ConfigurationBuilder.GetValue 的简单方法

使用选项模式

假设您的 appsettings.json 如下所示:

{
    "ConnectionStrings": {
        ...
    },
    "AppIdentitySettings": {
        "User": {
            "RequireUniqueEmail": true
        },
        "Password": {
            "RequiredLength": 6,
            "RequireLowercase": true,
            "RequireUppercase": true,
            "RequireDigit": true,
            "RequireNonAlphanumeric": true
        },
        "Lockout": {
            "AllowedForNewUsers": true,
            "DefaultLockoutTimeSpanInMins": 30,
            "MaxFailedAccessAttempts": 5
        }
    },
    "Recaptcha": { 
        ...
    },
    ...
}

简单的方法

您可以将整个配置注入控制器/类的构造函数(通过 IConfiguration),并使用指定的键获取所需的值:

public class AccountController : Controller
{
    private readonly IConfiguration _config;

    public AccountController(IConfiguration config)
    {
        _config = config;
    }

    [AllowAnonymous]
    public IActionResult ResetPassword(int userId, string code)
    {
        var vm = new ResetPasswordViewModel
        {
            PasswordRequiredLength = _config.GetValue<int>(
                "AppIdentitySettings:Password:RequiredLength"),
            RequireUppercase = _config.GetValue<bool>(
                "AppIdentitySettings:Password:RequireUppercase")
        };

        return View(vm);
    }
}

期权模式

如果您只需要应用程序设置中的一两个值,则 ConfigurationBuilder.GetValue<T> 非常有用。但是,如果您想从应用设置中获取多个值,或者您不想在多个位置对这些键字符串进行硬编码,那么使用 Options Pattern 可能会更容易。选项模式使用类来表示层次结构/结构。

要使用选项模式:

定义类以表示结构将这些类绑定的配置实例注册到 Inject IOptions 到要获取值的控制器/类的构造函数中

1.定义配置类来表示结构

您可以定义具有需要与应用设置中的键完全匹配的属性的类。类的名称不必与应用设置中的部分名称匹配:

public class AppIdentitySettings
{
    public UserSettings User { get; set; }
    public PasswordSettings Password { get; set; }
    public LockoutSettings Lockout { get; set; }
}

public class UserSettings
{
    public bool RequireUniqueEmail { get; set; }
}

public class PasswordSettings
{
    public int RequiredLength { get; set; }
    public bool RequireLowercase { get; set; }
    public bool RequireUppercase { get; set; }
    public bool RequireDigit { get; set; }
    public bool RequireNonAlphanumeric { get; set; }
}

public class LockoutSettings
{
    public bool AllowedForNewUsers { get; set; }
    public int DefaultLockoutTimeSpanInMins { get; set; }
    public int MaxFailedAccessAttempts { get; set; }
}

2.注册配置实例

然后您需要在启动时在 ConfigureServices() 中注册此配置实例:

using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
...

namespace DL.SO.UI.Web
{
    public class Startup
    {
        ...
        public void ConfigureServices(IServiceCollection services)
        {
            ...
            var identitySettingsSection = 
                _configuration.GetSection("AppIdentitySettings");
            services.Configure<AppIdentitySettings>(identitySettingsSection);
            ...
        }
        ...
    }
}

3.注入IOptions

最后,在要获取值的控制器/类上,您需要通过构造函数注入 IOptions<AppIdentitySettings>

public class AccountController : Controller
{
    private readonly AppIdentitySettings _appIdentitySettings;

    public AccountController(IOptions<AppIdentitySettings> appIdentitySettingsAccessor)
    {
        _appIdentitySettings = appIdentitySettingsAccessor.Value;
    }

    [AllowAnonymous]
    public IActionResult ResetPassword(int userId, string code)
    {
        var vm = new ResetPasswordViewModel
        {
            PasswordRequiredLength = _appIdentitySettings.Password.RequiredLength,
            RequireUppercase = _appIdentitySettings.Password.RequireUppercase
        };

        return View(vm);
    }
}

@LukasHieronimusAdler:您可能想要使用 IOptionsSnapshot<T> 而不是 IOptions<T>。您可以看看这篇文章:offering.solutions/blog/articles/2017/02/17/…。不过我还没有机会亲自尝试。
从全栈 .net 倒退是多么可怕的一步
好的,所以对于 .NET Core 3,您需要 Microsoft.Extensions.Options.ConfigurationExtensions 包,它工作正常
我们需要这么多解释才能访问一个简单的应用程序设置,这太荒谬了……这曾经是 .NET Framework 中的一行。我知道依赖注入通常是一件好事,但在这种情况下,它是麻烦而不是帮助。有一次,感觉 C# 是在考虑代码,而不是开发人员——这一切都有点 Java
未来自我注意:GetValue<T> 方法在 Microsoft.Extensions.Configuration.Binder Nuget 包中
s
shajji

只需创建一个 AnyName.cs 文件并粘贴以下代码。

using System;
using System.IO;
using Microsoft.Extensions.Configuration;

namespace Custom
{
    static class ConfigurationManager
    {
        public static IConfiguration AppSetting { get; }
        static ConfigurationManager()
        {
            AppSetting = new ConfigurationBuilder()
                    .SetBasePath(Directory.GetCurrentDirectory())
                    .AddJsonFile("YouAppSettingFile.json")
                    .Build();
        }
    }
}

必须将 YouAppSettingFile.json 文件名替换为您的文件名。您的 .json 文件应如下所示。

{
    "GrandParent_Key" : {
        "Parent_Key" : {
            "Child_Key" : "value1"
        }
    },
    "Parent_Key" : {
        "Child_Key" : "value2"
    },
    "Child_Key" : "value3"
}

现在你可以使用它了。不要忘记在您要使用的类中添加参考。

using Custom;

检索值的代码。

string value1 = ConfigurationManager.AppSetting["GrandParent_Key:Parent_Key:Child_Key"];
string value2 = ConfigurationManager.AppSetting["Parent_Key:Child_Key"];
string value3 = ConfigurationManager.AppSetting["Child_Key"];

不要在生产中使用它。这种方法是导致我们的 web api 内存泄漏的原因。如果您使用的是 netcore,则可以在任何地方注入 IConfiguration,只需查看上述答案即可。
我不建议到处注入 IConfiguration,因为这可能会导致一些安全问题;相反,您可以做的是从该配置中创建一些您需要的抽象层,并在您需要的地方使用它们。通过这种方式,您的代码更加安全,并且您的代码将不依赖于 IConfiguration 或任何实现。
找不到我的ConfigurationBuilder。我正在使用 .NET Core 3.1
R
RAM

添加到 David Liang 对 Core 2.0 的回答 -

appsettings.json 文件链接到 ASPNETCORE_ENVIRONMENT 变量。

ASPNETCORE_ENVIRONMENT 可以设置为任何值,但框架支持三个值:DevelopmentStagingProduction。如果未设置 ASPNETCORE_ENVIRONMENT,它将默认为 Production

对于这三个值,这些 appsettings.ASPNETCORE_ENVIRONMENT.json 文件支持开箱即用 - appsettings.Staging.jsonappsettings.Development.jsonappsettings.Production.json

以上三个应用设置json文件可以用来配置多个环境。

示例 - appsettings.Staging.json

{
    "Logging": {
        "IncludeScopes": false,
        "LogLevel": {
            "System": "Information",
            "Microsoft": "Information"
        }
    },
    "MyConfig": "My Config Value for staging."
}

使用 Configuration["config_var"] 检索任何配置值。

public class Startup
{
    public Startup(IHostingEnvironment env, IConfiguration config)
    {
        Environment = env;
        Configuration = config;
        var myconfig = Configuration["MyConfig"];
    }

    public IConfiguration Configuration { get; }
    public IHostingEnvironment Environment { get; }
}

嵌套对象呢?
可以使用 Configuration["MyConfig:SomethingNested"] 获取嵌套对象
从第 167 行的文件 github.com/aspnet/AspNetCore/blob/master/src/DefaultBuilder/src/… 中可以看出,ASP.NET Core 当前加载 appsettings.json + appsettings.{env.EnvironmentName}.json。所以说 ASP.NET Core 只加载 Development、Staging 和 Production appsettings.json 文件的说法目前是不正确的。
那么我应该每次都设置 Windows 变量 ASPNETCORE_ENVIRONMENT 吗? .Net 4 中的事情要容易得多。这些 JSON 狂热分子确实把事情搞砸了
@Toolkit 您可以全局设置环境变量。 docs.microsoft.com/en-us/aspnet/core/fundamentals/…
S
Sith2021

我想最简单的方法是通过 DI。进入 Controller 的示例。

// StartUp.cs
public void ConfigureServices(IServiceCollection services)
{
    ...
    // for get appsettings from anywhere
    services.AddSingleton(Configuration);
}

public class ContactUsController : Controller
{
    readonly IConfiguration _configuration;

    public ContactUsController(
        IConfiguration configuration)
    {
        _configuration = configuration;

        // sample:
        var apiKey = _configuration.GetValue<string>("SendGrid:CAAO");
        ...
    }
}

阅读其他答案,这应该是最好的。
我错过了 services.AddSingleton(Configuration); ,现在它可以工作了
S
Shadi Alnamrouti

在 Startup 类的构造函数中,您可以使用注入的 IConfiguration 对象访问 appsettings.json 和许多其他设置:

Startup.cs 构造函数

    public Startup(IConfiguration configuration)
    {
        Configuration = configuration;

        //here you go
        var myvalue = Configuration["Grandfather:Father:Child"];

    }

public IConfiguration Configuration { get; }

appsettings.json 的内容

  {
  "Grandfather": {
    "Father": {
      "Child": "myvalue"
    }
  }

帮助我的是 'Configuration["Grandfather:Father:Child"]' 语法。
这是一个出色的答案,其结构、清晰和重点突出。良好的沟通
假设我更改了 json 文件中的值,那么我是否需要重新启动应用程序才能拉取最新值?
@variable 更改应用设置 json 文件将导致应用自动重启
A
Abhishek Pandey

假设您在 appsettings.json 中有这样的值。

  "MyValues": {
    "Value1": "Xyz"
  }

方法一:没有依赖注入

在 .cs 文件中:

static IConfiguration conf = (new ConfigurationBuilder().SetBasePath(Directory.GetCurrentDirectory()).AddJsonFile("appsettings.json").Build());
public static string myValue1= conf["MyValues:Value1"].ToString();

方法二:依赖注入(推荐)

在 Startup.cs 文件中:

public IConfiguration Configuration { get; }
public Startup(IConfiguration configuration)
{
     Configuration = configuration;
}
public void ConfigureServices(IServiceCollection services)
{
     ...
     services.AddServices(Configuration);
}

在您的控制器中:

public class TestController : ControllerBase
{
    private string myValue1 { get; set; }
    public TestController(IConfiguration configuration)
    {
         this.myValue1 = configuration.GetValue<string>("MyValues:Value1");
    }
}

s
sepideh dalirpour
    public static void GetSection()
    {
        Configuration = new ConfigurationBuilder()
            .SetBasePath(env.ContentRootPath)
            .AddJsonFile("appsettings.json")
            .Build();

        string BConfig = Configuration.GetSection("ConnectionStrings")["BConnection"];

    }

我不同意@CarlosABS,这是最好的答案:所有其他人 - 出于某种神秘的原因 - 假设您正在使用 DI 并依赖他们的答案。然而,这是答案的本质,至少对我来说:)除此之外我不需要任何东西,所以其他答案似乎有些臃肿。
尽管您需要 三个 该死的 NuGet 包才能使其工作,但应该添加它:Microsoft.Extensions.ConfigurationMicrosoft.Extensions.Configuration.FileExtensionsMicrosoft.Extensions.Configuration.Json。我在 .net Core 中得到了整个模块化的东西,但耶稣有时你真的需要为每一行代码提供另一个包......
J
Jorge Eduardo

.NET 核心 3.X

无需创建新模型并在 Startup.cs 中设置。

控制器添加新包 - 使用 Microsoft.Extensions.Configuration;

public class HomeController : Controller
{
    private readonly IConfiguration _mySettings;

    public HomeController (IConfiguration mySettings)
    {
         _mySettings= mySettings;
    }
 
    //ex: you can get value on below function 
    public IEnumerable<string> Get()
    {
        var result = _config.GetValue<string>("AppSettings:Version"); // "One"
        return new string[] { result.ToString() };
    }
}

什么是_config?
O
Ogglas

对于 ASP.NET Core 3.1,您可以遵循以下指南:

https://docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration/?view=aspnetcore-3.1

当您创建一个新的 ASP.NET Core 3.1 项目时,您将在 Program.cs 中拥有以下配置行:

Host.CreateDefaultBuilder(args)

这可以实现以下功能:

ChainedConfigurationProvider :将现有的 IConfiguration 添加为源。在默认配置情况下,添加主机配置并将其设置为应用配置的第一个来源。 appsettings.json 使用 JSON 配置提供程序。 appsettings.Environment.json 使用 JSON 配置提供程序。例如,appsettings.Production.json 和 appsettings.Development.json。应用程序在开发环境中运行时的应用程序机密。使用环境变量配置提供程序的环境变量。使用命令行配置提供程序的命令行参数。

这意味着您可以注入 IConfiguration 并使用字符串键获取值,甚至是嵌套值。喜欢IConfiguration["Parent:Child"];

例子:

应用设置.json

{
  "ApplicationInsights":
    {
        "Instrumentationkey":"putrealikeyhere"
    }
}

WeatherForecast.cs

[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
{
    private static readonly string[] Summaries = new[]
    {
        "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
    };

    private readonly ILogger<WeatherForecastController> _logger;
    private readonly IConfiguration _configuration;

    public WeatherForecastController(ILogger<WeatherForecastController> logger, IConfiguration configuration)
    {
        _logger = logger;
        _configuration = configuration;
    }

    [HttpGet]
    public IEnumerable<WeatherForecast> Get()
    {
        var key = _configuration["ApplicationInsights:InstrumentationKey"];

        var rng = new Random();
        return Enumerable.Range(1, 5).Select(index => new WeatherForecast
        {
            Date = DateTime.Now.AddDays(index),
            TemperatureC = rng.Next(-20, 55),
            Summary = Summaries[rng.Next(Summaries.Length)]
        })
        .ToArray();
    }
}

在哪里可以了解有关 IConfiguration["Parent:Child"] 语法的更多信息?
@xr280xr 您可以在此处 docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration/… 和此处 docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration/… 找到语法详细信息,但该页面通常包含详细信息。
@xr280xr 值得一提的是,使用选项模式是获取配置值的首选方法。 docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration/…
C
Chris Stillwell

就我而言,这很简单,就像在 Configuration 对象上使用 Bind() 方法一样。然后将对象作为单例添加到 DI 中。

var instructionSettings = new InstructionSettings();
Configuration.Bind("InstructionSettings", instructionSettings);
services.AddSingleton(typeof(IInstructionSettings), (serviceProvider) => instructionSettings);

指令对象可以任意复杂。

{  
 "InstructionSettings": {
    "Header": "uat_TEST",
    "SVSCode": "FICA",
    "CallBackUrl": "https://UATEnviro.companyName.co.za/suite/webapi/receiveCallback",
    "Username": "s_integrat",
    "Password": "X@nkmail6",
    "Defaults": {
    "Language": "ENG",
    "ContactDetails":{
       "StreetNumber": "9",
       "StreetName": "Nano Drive",
       "City": "Johannesburg",
       "Suburb": "Sandton",
       "Province": "Gauteng",
       "PostCode": "2196",
       "Email": "ourDefaultEmail@companyName.co.za",
       "CellNumber": "0833 468 378",
       "HomeNumber": "0833 468 378",
      }
      "CountryOfBirth": "710"
    }
  }

B
Brad Larson

从 Asp.net core 2.2 到更高版本,您可以编写如下代码:

步骤 1. 创建 AppSettings 类文件。

此文件包含一些方法来帮助从 appsettings.json 文件中按键获取值。看起来像下面的代码:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace ReadConfig.Bsl
{
  public class AppSettings
  {
      private static AppSettings _instance;
      private static readonly object ObjLocked = new object();
      private IConfiguration _configuration;

      protected AppSettings()
      {
      }

      public void SetConfiguration(IConfiguration configuration)
      {
          _configuration = configuration;
      }

      public static AppSettings Instance
      {
          get
          {
              if (null == _instance)
              {
                  lock (ObjLocked)
                  {
                      if (null == _instance)
                          _instance = new AppSettings();
                  }
              }
              return _instance;
          }
      }

      public string GetConnection(string key, string defaultValue = "")
      {
          try
          {
              return _configuration.GetConnectionString(key);
          }
          catch
          {
              return defaultValue;
          }
      }

      public T Get<T>(string key = null)
      {
          if (string.IsNullOrWhiteSpace(key))
              return _configuration.Get<T>();
          else
              return _configuration.GetSection(key).Get<T>();
      }

      public T Get<T>(string key, T defaultValue)
      {
          if (_configuration.GetSection(key) == null)
              return defaultValue;

          if (string.IsNullOrWhiteSpace(key))
              return _configuration.Get<T>();
          else
              return _configuration.GetSection(key).Get<T>();
      }

      public static T GetObject<T>(string key = null)
      {
          if (string.IsNullOrWhiteSpace(key))
              return Instance._configuration.Get<T>();
          else
          {
              var section = Instance._configuration.GetSection(key);
              return section.Get<T>();
          }
      }

      public static T GetObject<T>(string key, T defaultValue)
      {
          if (Instance._configuration.GetSection(key) == null)
              return defaultValue;

          if (string.IsNullOrWhiteSpace(key))
              return Instance._configuration.Get<T>();
          else
              return Instance._configuration.GetSection(key).Get<T>();
      }
  }
}

步骤 2. AppSettings 对象的初始配置

我们需要在应用启动时声明并加载appsettings.json文件,并加载AppSettings对象的配置信息。我们将在 Startup.cs 文件的构造函数中完成这项工作。请注意第 AppSettings.Instance.SetConfiguration(Configuration);

public Startup(IHostingEnvironment evm)
{
    var builder = new ConfigurationBuilder()
      .SetBasePath(evm.ContentRootPath)
      .AddJsonFile("appsettings.json", true, true)
      .AddJsonFile($"appsettings.{evm.EnvironmentName}.json", true)
      .AddEnvironmentVariables();
    Configuration = builder.Build(); // load all file config to Configuration property 
    AppSettings.Instance.SetConfiguration(Configuration);       
}

好的,现在我有一个 appsettings.json 文件,其中包含如下一些键:

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*",
  "ConnectionStrings": {
    "ConnectionString": "Data Source=localhost;Initial Catalog=ReadConfig;Persist Security Info=True;User ID=sa;Password=12345;"
  },
  "MailConfig": {
    "Servers": {
      "MailGun": {
        "Pass": "65-1B-C9-B9-27-00",
        "Port": "587",
        "Host": "smtp.gmail.com"
      }
    },
    "Sender": {
      "Email": "example@gmail.com",
      "Pass": "123456"
    }
  }
}

步骤 3. 从操作中读取配置值

我在 Home 控制器中进行演示,如下所示:

public class HomeController : Controller
{
    public IActionResult Index()
    {
        var connectionString = AppSettings.Instance.GetConnection("ConnectionString");
        var emailSender = AppSettings.Instance.Get<string>("MailConfig:Sender:Email");
        var emailHost = AppSettings.Instance.Get<string>("MailConfig:Servers:MailGun:Host");

        string returnText = " 1. Connection String \n";
        returnText += "  " +connectionString;
        returnText += "\n 2. Email info";
        returnText += "\n Sender : " + emailSender;
        returnText += "\n Host : " + emailHost;

        return Content(returnText);
    }
}

结果如下:

Click to see result


C
ChristianYami

像这样在此处添加所需的密钥。在这种情况下,它的 SecureCookies:

https://i.stack.imgur.com/xNLfD.jpg

在startup.cs中,添加构造函数 public Startup(IConfiguration configuration) { Configuration = configuration; } 公共 IConfiguration 配置 { 获取;使用 Configuration["SecureCookies"] 访问设置


I
Icad

我在 WPF (.NET Framework 5.0) 中遇到了类似的问题

我所要做的就是注册它。

services.AddSingleton<IConfiguration>(_configuration);

配置本身是这样配置的(在 App.xaml.cs 中):

var builder = new ConfigurationBuilder()
    .SetBasePath(Directory.GetCurrentDirectory())
    .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true);

_configuration = builder.Build();

N
Nae

正如我所假设的那样,这往往发生在 上,因为人们如何配置 launch.json

基于 this answer,我不得不将正在搜索的配置的基本路径重新配置为 DLL's path 的基本路径,并且由于默认设置是可选的,因此很难在 .net core 3.1 &净 5.0 应用程序。这是我重新配置的方式

Program.cs

using System;
using System.IO;
using System.Reflection;
using Microsoft.Extensions.Configuration;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Hosting;

namespace API
{
    public class Program
    {
        public static int Main(string[] args)
        {
            CreateHostBuilder(args).Build().Run();
            return 0;
        }

        public static IHostBuilder CreateHostBuilder(string[] args)
        {
            return Host.CreateDefaultBuilder(args)
            .ConfigureAppConfiguration(c =>
            {
                var codeBase = Assembly.GetExecutingAssembly().Location;
                var uri = new UriBuilder(codeBase);
                var path = Uri.UnescapeDataString(uri.Path);
                var assembyDirectory = Path.GetDirectoryName(path);
                c.SetBasePath(assembyDirectory);
            })
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            })
            ;
        }
    }
}

我可以在 Startup.cs 中正常访问配置:

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Model;

namespace API
{
    public class Startup
    {
        public IConfiguration Configuration { get; }

        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            var myOptions = Configuration.To<ApiConfig>();
            services.AddAuthentication(myOptions.Secret);
            services.AddControllers();
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            app.UseRouting();
            app.UseAuthentication();
            app.UseAuthorization();
            app.UseEndpoints(endpoints => { endpoints.MapControllers(); });
        }
    }
}

谢谢你的作品。当我运行 exe 扩展时,没有读取配置,当我将该代码添加到 Program.cs 时,它已修复。
N
NotoriousPyro

我发现使用 .NET Core 3+ 最容易做到以下几点。我发现使用 HostBuilders 等的所有其他方法都有些冗长且不可读。这不是专门针对 ASP.Net,但您可以对其进行调整...

这里有一个工作示例:https://github.com/NotoriousPyro/PyroNexusTradingAlertBot/blob/develop/PyroNexusTradingAlertBot/Program.cs

创建json:

{
"GlobalConfig": {
    "BlacklistedPairs": [ "USD", "USDT", "BUSD", "TUSD", "USDC", "DAI", "USDK" ]
},
"CoinTrackingConfig": {
    "Cookie1": "",
    "Cookie2": "",
    "ApiKey": "",
    "ApiSecret": "",
    "UpdateJobs": [
    {
        "Name": "Binance",
        "Path": "binance_api",
        "JobId": 42202
    },
    {
        "Name": "Bitfinex",
        "Path": "bitfinex_api",
        "JobId": 9708
    }
    ]
},
"DiscordConfig": {
    "BotToken": ""
}
}

为 json 对象创建类:

class GlobalConfig
{
    public string[] BlacklistedPairs { get; set; }
}
class CoinTrackingConfig
{
    public string Cookie1 { get; set; }
    public string Cookie2 { get; set; }
    public string ApiKey { get; set; }
    public string ApiSecret { get; set; }
    public List<CoinTrackingUpdateJobs> UpdateJobs { get; set; }
}

class CoinTrackingUpdateJobs
{
    public string Name { get; set; }
    public string Path { get; set; }
    public int JobId { get; set; }
}

class DiscordConfig
{
    public string BotToken { get; set; }
}

创建一个辅助类:

private class Config
{
    private IConfigurationRoot _configuration;
    public Config(string config) => _configuration = new ConfigurationBuilder()
            .AddJsonFile(config)
            .Build();

    public T Get<T>() where T : new()
    {
        var obj = new T();
        _configuration.GetSection(typeof(T).Name).Bind(obj);
        return obj;
    }
}

服务提供者选项和服务构造函数:

public class DiscordServiceOptions
{
    public string BotToken { get; set; }
}

public DiscordService(IOptions<DiscordServiceOptions> options, ILogger<DiscordService> logger)
{
    _logger = logger;
    _client = new DiscordSocketClient();
    _client.Log += Log;
    _client.Ready += OnReady;
    _client.Disconnected += OnDisconnected;
    _client.LoginAsync(TokenType.Bot, options.Value.BotToken);
    _client.StartAsync();
}

像这样初始化它(将配置传递给服务提供者 - IOptions 将在构建服务时传递):

static async Task Main(string[] args)
{
    var _config = new Config("config.json");

    var globalConfig = config.Get<GlobalConfig>();
    var coinTrackingConfig = config.Get<CoinTrackingConfig>();
    var discordConfig = config.Get<DiscordConfig>();

    _services = new ServiceCollection()
        .AddOptions()
        .Configure<DiscordServiceOptions>(options =>
        {
            options.BotToken = discordConfig.BotToken;
        })
        .AddSingleton<IDiscordService, DiscordService>()
        .AddLogging(logging =>
        {
            logging.SetMinimumLevel(LogLevel.Trace);
            logging.AddNLog(new NLogProviderOptions
            {
                CaptureMessageTemplates = true,
                CaptureMessageProperties = true
            });
        })
        .BuildServiceProvider();
}

如何访问控制器中的 globalConfig?
V
Victor

appsetting.json

{   
  "Settings": {      
    "ProjectName": "Sample Project"   
  }
}

定义一个具有相同属性名称的类:

 public class Settings
 {
     public string ProjectName { get; set; }  
 }

在 Startup.cs 中添加配置:

public void ConfigureServices(IServiceCollection services)
{
    services.Configure<Settings>(Configuration.GetSection("Settings")); 
}

注入控制器:

public class TestController : Controller
{
    private readonly Settings _settings;       
    
    public TestController(IOptions<Settings> settings)
    {
         _settings = settings.Value;
    }
       
    [AllowAnonymous]
    public async Task<IActionResult> test()
    {
        var _projectname = _settings.ProjectName;
                
        return View();
    }
}

您还需要在 Startup.cs 中声明和初始化配置。公共 IConfiguration 配置 { 获取; } 公共启动(IConfiguration 配置)=> 配置 = 配置;
M
Meghnath Das

我认为最好的选择是:

创建一个模型类作为配置模式在 DI 中注册: services.Configure(Configuration.GetSection("democonfig"));从控制器中的 DI 获取值作为模型对象: private readonly your_model myConfig;公共 DemoController(IOptions configOps) { this.myConfig = configOps.Value; }


K
Krzysztof Boduch

就我而言,我从头开始创建所有内容,并且 appsettings.json 也根本没有加载。经过一番调试,我发现该文件从未复制到“目标文件夹”。

要修复它,我只需要设置正确的文件属性。

它看起来像这样:

https://i.stack.imgur.com/IRGk0.png


S
Simon Fallai

我只是创建一个静态类并在 Startup.cs 中为其设置一个配置变量

public static class GlobalConfig { 
    public static IConfiguration config { get; set; } 
}

public class Startup
{
    public Startup(IConfiguration configuration)
    {
        GlobalConfig.config = configuration;

    }
}

然后在任何地方使用它:

var keyVal = GlobalConfig.config["key"];

似乎是访问配置文件并使其在任何地方可用的最简单方法。


您的答案可以通过额外的支持信息得到改进。请edit添加更多详细信息,例如引用或文档,以便其他人可以确认您的答案是正确的。您可以找到有关如何写出好答案的更多信息in the help center
S
Syed Rafay

添加到 Abishek 的答案:

如果要将值导入静态类,则只需使用(ReSharper 推荐):

static IConfiguration conf = (JsonConfigurationExtensions.AddJsonFile(new ConfigurationBuilder().SetBasePath(Directory.GetCurrentDirectory()), "appsettings.json").Build());

private static string AuthorizationServiceURL { get; } = conf["ServiceUrls:AuthorizationUrl"];

// appsettings.json
{
  "ServiceUrls": {
    "AuthorizationUrl": "https://example.com/authorize"
  } 
}

d
denisv

花了一个小时试图解决同样的问题,我的解决方案是在 csproj 中为 appconfig.json 添加 PreserveNewest/CopyAlways

<None Update="appsettings.json">
  <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>