ASP.NET Core 配置檔案

阿飛24發表於2019-05-10
ASP.NET

　　在ASP.NET Core 中，應用程式配置資料可以使用JSON, XML 和 INI格式 和內建環境變數，命令列引數或記憶體中的集合。

　　1.如何獲取和設定配置

　　ASP.NET Core配置系統針對以前的依賴於System.Configuration和XML配置檔案(如Web.config)的ASP,NET 版本進行了重構。新的配置模型提供了精簡高效的，能夠通過檢索多樣化提供程式來獲取基於鍵/值對配置的能力。應用程式和框架可以通過新的選擇模式訪問配置。

　　可以在ASP.NET Core應用程式中的Startup類中只例項化一個Configuration示例，然後選擇模式來訪問各自的設定。

　　Configuration類是一個提供讀寫鍵/值對能力的Providers集合。如果一個鍵值對寫入Configuration，它不會持久，當源再次讀寫值時將會丟失。因此至少需要配置一個資料來源，使得configuration能正常工作。

　　下面通過記憶體配置演示Configuration處理鍵值對：

　　　　

　　記憶體配置一般用在一次請求中需要暫存資料的情況，例如，如果管道中有多箇中介軟體，可以在某一箇中介軟體中暫存資料，後面的某一箇中使用。

　　在開發中一般會把配置值放在一個有層次的資料結構中，例如appsettings.json，在這種情況下，可以使用以: 符號分割（從層次結構的根開始）的鍵讀取值：

{
  "ConnectionStrings": {
    "DefaultConnection": "Data Source=.;Initial Catalog=AccessManagement;Integrated Security=True"
  },
  "Logging": {
    "LogLevel": {
      "Default": "Information"
    }
  },
  "AllowedHosts": "*",
  "MyOptions": {
    "Option1": "ww",
    "Option2": 3
  }
}

　　在應用程式中通過Configuration獲取配置的連線字串，可以通過ConnectionStrings:DefaultConnection讀取ConnectionStrings的設定，也可以通過GetConnectionString擴充套件方法加引數"DefaultConnection"來獲取。

　　　　

　　應用程式所需要的設定和指定配置的機制都可以通過使用選擇模式解耦。建立自己的配置類時，可以是幾個不同的類，分別對應不同的配置組，然後通過選項服務注入到應用程式中。這樣就可以通過配置或其他所選擇的機制來設定了。

 

　　2.使用內建資料來源

　　開發時並不侷限於必須使用單個配置提供程式，可以把多個配置提供程式組合在一起。

 　　擴充套件方法支援為配置新增額外的配置檔案提供程式。這些方法能被獨立的或鏈式呼叫在ConfigurationBuilder例項之上：　　

　　　　public Startup()
        {
            var builder = new ConfigurationBuilder();
            builder.SetBasePath(Directory.GetCurrentDirectory());
            builder.AddJsonFile("appsettings.json");
            var config = builder.Build();

            var _config = new ConfigurationBuilder()
                .SetBasePath(Directory.GetCurrentDirectory())
                .AddJsonFile("appsettings.json")
                .Build();
        }

　　　　指定配置提供程式的順序很重要，這將影響他們的設定被應用的優先順序：

public Startup(IConfiguration configuration,IHostingEnvironment env)
        {

            var builder = new ConfigurationBuilder()
                .SetBasePath(Directory.GetCurrentDirectory())
                .AddJsonFile(“appsettings.json",optional:true,reloadOnChange:true)
                .AddJsonFile($"appsettings.{env.EnvironmentName}.json",optional:true);

            //配置環境變數
            builder.AddEnvironmentVariables();
            Configuration = builder.Build();
        }

        public IConfiguration Configuration { get; }

　　IHostingEnvironment 服務用於獲取當前環境。在Development環境中，AddJsonFile($"appsettings.{env.EnvironmentName}.json",optional:true)將會查詢appsettings.Development.json配置檔案，並覆蓋appsettings.json中存在的值。同樣環境變數也會覆蓋它們兩個的值。

　　一旦將指定檔案作為配置源，就可以選擇當檔案發生變化後，是否重新再付這部分的配置，reloadOnChange:true。

 

　　3.使用選項和配置物件

　　選擇模式可使用自定義的配置類表示一組相關設定。這個配置類需要為配置項提供公開的 屬性和一個無參的建構函式。可以根據應用程式的功能分解為多個配置物件。

　　下面自定義appsettings.json的配置類，並使用：

　　先建立配置類

namespace MVCTest
{
    public class AppSettingOptions
    {
        public DefaultConnec ConnectionStrings { get; set; }
        public string AllowedHosts { get; set; }
    }

    public class DefaultConnec
    {
        public string DefaultConnection { get; set; }
    }
}

　　在ConfigureServices中呼叫選項服務：

        public Startup(IConfiguration configuration,IHostingEnvironment env)
        {
            //Configuration = configuration;
            var builder = new ConfigurationBuilder()
                .SetBasePath(Directory.GetCurrentDirectory())
                .AddJsonFile("appsettings.json",optional:true,reloadOnChange:true)
                //.AddJsonFile($"appsettings.{env.EnvironmentName}.json",optional:true);

            //配置環境變數
            builder.AddEnvironmentVariables();
            Configuration = builder.Build();
        }

        public IConfiguration Configuration { get; }

        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddOptions();//提供依賴注入
            services.Configure<AppSettingOptions>(Configuration); //繫結配置選項     
   services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
        }

　　　　在HomeController中使用：

public class HomeController : Controller
    {
        private readonly IOptions<AppSettingOptions> _options;
        public HomeController(IOptions<AppSettingOptions> options,)
        {
            _options = options;
        }
        public static Logger nlog = LogManager.GetCurrentClassLogger();
        public IActionResult Index()
        {
            var AllowedHosts = _options.Value.AllowedHosts;
            var DefaultConnection = _options.Value.ConnectionStrings.DefaultConnection;
        }
     }

　　　　結果：

　　　　　　

　　　　

　　當通過繫結選項來配置選項型別的每一個屬性時，實際上是繫結到每一個配置鍵。配置鍵是大小寫不敏感的。

 　　當通過呼叫services.Configure<AppSettingOptions>(Configuration);程式碼，將一個IConfigureOptions<AppSettingOptions>服務加入服務容器，是為了後面應用程式或框架能通過IOptions<AppSettingOptions>服務來獲取配置。若想從其他途徑（從資料庫通過EF獲取）獲取配置，可以使用ConfigureOptions<TOptions>擴充套件方法直接指定經過定製的IConfigureOptions<TOptions>服務。

　　其他方法：

//通過程式碼編寫
            services.Configure<AppSettingOptions>(options=>
            {
                options.AllowedHosts = "test";
            });
            //只配置部分
            services.Configure<AppSettingOptions>(Configuration.GetSection("ConnectionStrings"));

 

相關文章