从类库访问 Asp.net-core 中的 appsetting.json

Question

我正在尝试从类库访问appsetting.json 文件。到目前为止，我找到的解决方案是从Microsoft.Extensions.Configuration 创建一个实现接口IConfiguration 的配置类，并将json文件添加到类并从中读取。

var configuration = new Configuration();
configuration.AddJsonFile("appsetting.json");
var connectionString= configuration.Get("connectionString");

这似乎是一个不好的选择，因为我们每次必须访问 appsetting 配置时都​​必须添加 json 文件。我们在 ASP.NET 中没有像 ConfigurationManager 这样的替代方案吗？

Answer 1

我知道一个答案已经被接受，但这个问题是 Google 上的热门问题，OPs 问题是关于类库而不是 ASP.NET Web 应用程序或 WebApi，这是接受的答案使用的。

IMO，类库不应使用应用程序设置，并且应与此类设置无关。如果您需要类库中的应用程序设置，那么您应该从您的消费者那里提供这些设置。你可以看看这个On This SO Question的例子

Answer 2

我假设您想从 Web 应用程序访问 appsettings.json 文件，因为默认情况下类库没有 appsettings.json。

我创建了一个模型类，它的属性与appsettings.json 中某个部分的设置相匹配。

appsettings.json 中的部分

"ApplicationSettings": {
    "SmtpHost": "mydomain.smtp.com",
    "EmailRecipients": "me@mydomain.com;other@mydomain.com"
}   

匹配模型类

namespace MyApp.Models
{
    public class AppSettingsModel
    {
        public string SmtpHost { get; set; }
        public string EmailRecipients { get; set; }
    }
}

然后填充该模型类并将其添加到 DI 容器中的 IOptions 集合中（这是在 Startup 类的 Configure() 方法中完成的）。

services.Configure<AppSettingsModel>(Configuration.GetSection("ApplicationSettings"));

// Other configuration stuff

services.AddOptions();

然后，您可以从框架调用的任何方法访问该类，方法是将其添加为构造函数中的参数。框架负责查找类并将其提供给构造函数。

public class MyController: Controller
{
    private IOptions<AppSettingsModel> settings;

    public MyController(IOptions<AppSettingsModel> settings)
    {
        this.settings = settings;
    }
}

然后当类库中的方法需要设置时，我要么单独传递设置，要么传递整个对象。

Answer 3

除了问题有一个公认的答案之外，我相信没有任何一个问题只适用于一个没有启动项目或与 Asp.NetCore 堆栈或 IServiceCollection 有依赖关系的类库。

这就是我从类库中读取配置的方式：

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

public class ConfigSample
{
    public ConfigSample
    {
            IConfigurationBuilder builder = new ConfigurationBuilder();
            builder.AddJsonFile(Path.Combine(Directory.GetCurrentDirectory(), "appsettings.json"));

            var root = builder.Build();
            var sampleConnectionString = root.GetConnectionString("your-connection-string");
    }
}

需要以下 nuget 包：

• Microsoft.Extensions.Configuration
• Microsoft.Extensions.Configuration.FileExtensions
• Microsoft.Extensions.FileProviders.Abstractions
• Newtonsoft.Json
• Microsoft.Extensions.Configuration.Json

Answer 4

我知道这个问题有一个可接受的答案，但问题是关于类库的，从类库中读取 appsettings.json 的方法如下：

创建一个具有与您的设置文件中的属性相匹配的属性的模型：

public class ConfigurationManager
{
    public string BaseUrl { get; set; }
}

在您的 appsettings.json 中添加实际设置

  "ConfigurationManager": {
    "BaseUrl": "myValue"
  }

现在在 startup.cs 中使用您的模型注册 appsettings.json 部分：

 services.Configure<ConfigurationManager>(Configuration.GetSection("ConfigurationManager"));

在你的类库中创建一个正在使用的类

using Microsoft.Extensions.Options;

并获取您的配置设置：

using Microsoft.Extensions.Options;


public class KeyUrls: IKeyUrls
{
    public string BaseUrl = "";
    private readonly IOptions<ConfigurationManager> _configurationService;

    public KeyUrls(IOptions<ConfigurationManager> configurationservice)
    {
        _configurationService = configurationservice;
        BaseUrl = _configurationService.Value.BaseUrl;
    }

    public  string GetAllKeyTypes()
    {
        return $"{BaseUrl}/something";
    }

    public  string GetFilteredKeys()
    {
        return $"{BaseUrl}/something2";
    }
}

更多详情请查看This

Answer 5

这很容易做到

string c = Directory.GetCurrentDirectory();
IConfigurationRoot configuration = 
newConfigurationBuilder().SetBasePath(c).AddJsonFile("appsettings.json").Build();
string connectionStringIs = configuration.GetConnectionString("MyConnection"); 

从最后一行可以得到连接字符串

如果要配置上下文，请额外编写以下代码：

optionsBuilder.UseSqlServer(connectionStringIs); //inside protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)

别忘了安装和使用这些包：-

using Microsoft.Extensions.Configuration; 
using Microsoft.Extensions.Configuration.FileExtensions; 
using Newtonsoft.Json; 
using Microsoft.Extensions.Configuration.Json; 
using System.IO;

Answer 6

在类构造函数 DI 中工作。 微软文档Here

Answer 7

Directory.SetCurrentDirectory(AppContext.BaseDirectory);
var builder = new ConfigurationBuilder().SetBasePath (  Path.Combine(Directory.GetCurrentDirectory())   )
.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true);