如何在Core 2.0中的ConfigurationBuilder中设置基路径（SetBasePath）

Question

如何在Core 2.0的ConfigurationBuilder中设置基本路径？

我已经使用谷歌搜索并找到了这个问题，这篇来自微软文档和2.0在线文档，但它们似乎都在使用Microsoft.Extension.Configuration的版本1.0.0-beta8。

我想读取appsettings.json。在Core 2.0中有没有新的方法来实现这一点？

using System;
using System.IO;
using Microsoft.Extensions.Configuration;
namespace ConsoleApp2
{
    class Program
    {
        public static IConfigurationRoot Configuration { get; set; }

        static void Main(string[] args)
        {
            var builder = new ConfigurationBuilder()
                .SetBasePath(Directory.GetCurrentDirectory()) // <== compile failing here
                .AddJsonFile("appsettings.json");

            Configuration = builder.Build();

            Console.WriteLine(Configuration.GetConnectionString("con"));
            Console.WriteLine("Press a key...");
            Console.ReadKey();
        }
    }
}

appsetting.json

{
  "ConnectionStrings": {
    "con": "connection string"
  }
}

更新： 除了按照下面Set所示添加Microsoft.Extensions.Configuration.FileExtensions之外，我还需要添加Microsoft.Extensions.Configuration.Json才能获取AddJsonFile扩展。

- Padhraic

---

更新起作用了！ - Chris Rosete

Microsoft.Extensions.Configuration.Json 依赖于 Microsoft.Extensions.Configuration.FileExtensions，因此您只需使用前者。 - Johan B

请注意，朋友们，“AddJsonFile（“ appsettings.json”）”方法不能意识到您的托管环境！请使用“.AddJsonFile（$”appsettings.{_hostingEnvironment.EnvironmentName}.json”）”代替。 :D - Jess

Answer 1

SetBasePath 扩展方法定义在 Config.FileExtensions 中。

您需要添加对 Microsoft.Extensions.Configuration.FileExtensions 包的引用。

要解决AddJsonFile问题，请添加对Microsoft.Extensions.Configuration.Json包的引用。

- Set

---

但是现在找不到"AddJsonFile"方法。:D 我不得不添加这个包："Microsoft.Extensions.Configuration.Json"。 - tedi

Microsoft.Extensions.Configuration.Json 依赖 Microsoft.Extensions.Configuration.FileExtensions，所以你只需要使用前者。 - Johan B

请在解决方案级别而非项目级别上管理NuGet包。 - Mahmoud Hboubati

Answer 2

我正在使用Visual Studio 2017 v15.5开发一个.NET Core 2控制台应用程序。正如其他人所指出的那样，在添加了Microsoft.Extensions.Configuration后，我需要添加Microsoft.Extensions.Configuration.Json才能让AddJsonFile()方法工作。这也使得SetBasePath()方法工作；因此，我不需要添加Configuration.FileExtensions。（我的代码可以编译和运行，无论是否添加了它。）

我还调用了AddEnvironmentVariables()方法，为此我需要添加Configuration.EnvironmentVariables。我的代码如下：

  var builder = new ConfigurationBuilder()
                    .SetBasePath(Directory.GetCurrentDirectory()) // requires Microsoft.Extensions.Configuration.Json
                    .AddJsonFile("appsettings.json") // requires Microsoft.Extensions.Configuration.Json
                    .AddEnvironmentVariables(); // requires Microsoft.Extensions.Configuration.EnvironmentVariables
  Configuration = builder.Build();

有趣的是，我所需要的唯一 using 语句是 using Microsoft.Extensions.Configuration。

- Ed Graham

---

在类文件中，唯一必要的 using 语句应该是 Microsoft.Extensions.Configuration。然而，在项目中，您必须通过“管理 NuGet 程序包”项目选项显式添加 NuGet 依赖项“Microsoft.Extensions.Configuration.Json”。其中一个依赖项是“Microsoft.Extensions.Configuration.FileExtensions”，因此将作为依赖项的一部分包含在内。这两个依赖项将解决“SetBasePath”和“AddJsonFile”编译错误。 - gregsonian

值得指出的是，由于VS for Mac Preview 8将当前目录设置为bin/netcoreapp2x，因此这不再起作用。 - Chris Becke

不是要挑剔，但 Configuration.EnvironmentVariables 等同于 Microsoft.Extensions.Configuration.EnvironmentVariables。有几个名称相似的东西。 - Lee Richardson

Answer 3

同时使用 'Microsoft.Extensions.Configuration' 和 'Microsoft.Extensions.Configuration.Json' 可以解决该问题。

https://www.nuget.org/packages/Microsoft.Extensions.Configuration/ https://www.nuget.org/packages/Microsoft.Extensions.Configuration.Json/

下面是一个示例的“ConnectionFactory”

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

namespace DataAccess.Infrastructure
{
 public class ConnectionFactory : IConnectionFactory
 {
    public ConnectionFactory()
    {
        var builder = new ConfigurationBuilder().SetBasePath(Directory.GetCurrentDirectory()).AddJsonFile("appsettings.json");
        Configuration = builder.Build();
    }


    public IConfigurationRoot Configuration { get; }
    public IDbConnection GetConnection
    {
        get
        {
            var connectionString = Configuration.GetConnectionString("DefaultConnection");
            var conn = new SqlConnection(connectionString);
            conn.Open();
            return conn;
        }
    }

    #region IDisposable Support
    private bool disposedValue = false; // To detect redundant calls

    protected virtual void Dispose(bool disposing)
    {
        if (!disposedValue)
        {
            if (disposing)
            {
                // TODO: dispose managed state (managed objects).
            }


            // TODO: free unmanaged resources (unmanaged objects) and override a finalizer below.
            // TODO: set large fields to null.

            disposedValue = true;
        }
    }

    // TODO: override a finalizer only if Dispose(bool disposing) above has code to free unmanaged resources.
    // ~ConnectionFactory() {
    //   // Do not change this code. Put cleanup code in Dispose(bool disposing) above.
    //   Dispose(false);
    // }

    // This code added to correctly implement the disposable pattern.
    public void Dispose()
    {
        // Do not change this code. Put cleanup code in Dispose(bool disposing) above.
        Dispose(true);
        // TODO: uncomment the following line if the finalizer is overridden above.
        // GC.SuppressFinalize(this);
    }
    #endregion
} }

- Anish Manchappillil

Answer 4

如果添加了引用后仍无法获取JSON内容。

进入JSON属性（右键单击JSON文件>属性） 将“复制到输出目录”更改为“始终复制”

查看截图

- Darshan Jain