Cấu hình ASP.NET Core cho ứng dụng bảng điều khiển .NET Core

ASP.NET Core hỗ trợ một hệ thống cấu hình mới như được thấy ở đây: https://docs.asp.net/en/latest/fundamentals/configuration.html

Có phải mô hình này cũng được hỗ trợ trong các ứng dụng bảng điều khiển .NET Core?

Nếu không những gì là thay thế cho trước đó app.configvà ConfigurationManagermô hình?

Bạn có thể sử dụng đoạn mã này. Nó bao gồm Cấu hình và DI.

public class Program
{
    public static ILoggerFactory LoggerFactory;
    public static IConfigurationRoot Configuration;

    public static void Main(string[] args)
    {
        Console.OutputEncoding = Encoding.UTF8;

        string environment = Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT");

        if (String.IsNullOrWhiteSpace(environment))
            throw new ArgumentNullException("Environment not found in ASPNETCORE_ENVIRONMENT");

        Console.WriteLine("Environment: {0}", environment);

        var services = new ServiceCollection();

        // Set up configuration sources.
        var builder = new ConfigurationBuilder()
            .SetBasePath(Path.Combine(AppContext.BaseDirectory))
            .AddJsonFile("appsettings.json", optional: true);
        if (environment == "Development")
        {

            builder
                .AddJsonFile(
                    Path.Combine(AppContext.BaseDirectory, string.Format("..{0}..{0}..{0}", Path.DirectorySeparatorChar), $"appsettings.{environment}.json"),
                    optional: true
                );
        }
        else
        {
            builder
                .AddJsonFile($"appsettings.{environment}.json", optional: false);
        }

        Configuration = builder.Build();

        LoggerFactory = new LoggerFactory()
            .AddConsole(Configuration.GetSection("Logging"))
            .AddDebug();

        services
            .AddEntityFrameworkNpgsql()
            .AddDbContext<FmDataContext>(o => o.UseNpgsql(connectionString), ServiceLifetime.Transient);

        services.AddTransient<IPackageFileService, PackageFileServiceImpl>();

        var serviceProvider = services.BuildServiceProvider();

        var packageFileService = serviceProvider.GetRequiredService<IPackageFileService>();

        ............
    }
}

Ồ, và đừng quên thêm vào project.json

{
  "version": "1.0.0-*",
  "buildOptions": {
    "emitEntryPoint": true,
    "copyToOutput": {
      "includeFiles": [
        "appsettings.json",
        "appsettings.Integration.json",
        "appsettings.Production.json",
        "appsettings.Staging.json"
      ]
    }
  },

  "publishOptions": {
    "copyToOutput": [
      "appsettings.json",
      "appsettings.Integration.json",
      "appsettings.Production.json",
      "appsettings.Staging.json"
    ]
  },
...
}

Đối với ứng dụng bảng điều khiển .NET Core 2.0, tôi đã làm như sau:

1. Tạo một tệp mới có tên appsinstall.json ở thư mục gốc của dự án (tên tệp có thể là bất cứ thứ gì)
2. Thêm cài đặt cụ thể của tôi vào tập tin đó là json. Ví dụ:

{
  "myKey1" :  "my test value 1", 
  "myKey2" :  "my test value 2", 
  "foo" :  "bar" 
}

3. Định cấu hình để sao chép tệp vào thư mục đầu ra bất cứ khi nào dự án được xây dựng (trong VS -> Solution Explorer -> nhấp chuột phải vào tệp -> chọn 'Thuộc tính' -> Nâng cao -> Sao chép vào Thư mục đầu ra -> chọn 'Sao chép luôn')

4. Cài đặt gói nuget sau trong dự án của tôi:

   • Microsoft.Extensions.Configuration.Json

5. Thêm phần sau vào Program.cs (hoặc bất cứ nơi nào Main()được đặt):

   static void Main(string[] args)
   {
       var builder = new ConfigurationBuilder()
           .SetBasePath(Directory.GetCurrentDirectory())
           .AddJsonFile("appsettings.json");
   
       var configuration = builder.Build();
   
       // rest of code...
   }

6. Sau đó đọc các giá trị bằng một trong các cách sau:

   string myKey1 = configuration["myKey1"];
   Console.WriteLine(myKey1);
   
   string foo = configuration.GetSection("foo").Value;
   Console.WriteLine(foo);

Thông tin thêm: https://docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration?tabs=basicconfiguration#simple-configuration

Nếu bạn sử dụng Microsoft.Extensions.Hosting(phiên bản 2.1.0+) để lưu trữ ứng dụng bảng điều khiển và ứng dụng lõi asp.net, tất cả các cấu hình của bạn sẽ được thêm vào bằng HostBuildercác phương thức ConfigureAppConfigurationvà ConfigureHostConfigurationphương thức. Đây là bản demo về cách thêm các appsettings.jsonbiến và môi trường:

    var hostBuilder = new HostBuilder()
        .ConfigureHostConfiguration(config =>
        {
            config.AddEnvironmentVariables();

            if (args != null)
            {
                // enviroment from command line
                // e.g.: dotnet run --environment "Staging"
                config.AddCommandLine(args);
            }
        })
        .ConfigureAppConfiguration((context, builder) =>
        {
            var env = context.HostingEnvironment;
            builder.SetBasePath(AppContext.BaseDirectory)
            .AddJsonFile("appsettings.json", optional: false)
            .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true)
            // Override config by env, using like Logging:Level or Logging__Level
            .AddEnvironmentVariables();

        })
        ... // add others, logging, services
        //;

Để biên dịch mã ở trên, bạn cần thêm các gói sau:

<PackageReference Include="Microsoft.Extensions.Configuration" Version="2.1.0" />
<PackageReference Include="Microsoft.Extensions.Configuration.CommandLine" Version="2.1.0" />
<PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" Version="2.1.0" />
<PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="2.1.0" />
<PackageReference Include="Microsoft.Extensions.Hosting" Version="2.1.0" />

Tôi đã lầm. Bạn có thể sử dụng mới ConfigurationBuildertừ một ứng dụng bảng điều khiển netcore.

Xem https://docs.asp.net/en/latest/fundamentals/configuration.html để biết ví dụ.

Tuy nhiên, chỉ lõi aspnet có tính năng tiêm phụ thuộc ra khỏi hộp để bạn không có khả năng gõ mạnh các cài đặt cấu hình và tự động tiêm chúng bằng cách sử dụng IOptions.

Nó giống như thế này, đối với ứng dụng bảng điều khiển lõi dotnet 2.x:

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

        [...]
        var configuration = new ConfigurationBuilder()
            .SetBasePath(Directory.GetCurrentDirectory())
            .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
            .AddEnvironmentVariables()
            .Build();
        var serviceProvider = new ServiceCollection()
            .AddLogging(options => options.AddConfiguration(configuration).AddConsole())
            .AddSingleton<IConfiguration>(configuration)
            .AddSingleton<SomeService>()
            .BuildServiceProvider();
        [...]
        await serviceProvider.GetService<SomeService>().Start();

Bạn có thể tiêm ILoggerFactory, IConfiguration trong SomeService.

Trên .Net Core 3.1, chúng ta chỉ cần thực hiện những điều sau:

static void Main(string[] args)
{
  var configuration = new ConfigurationBuilder().AddJsonFile("appsettings.json").Build();
}

Sử dụng SeriLog sẽ như sau:

using Microsoft.Extensions.Configuration;
using Serilog;
using System;


namespace yournamespace
{
    class Program
    {

        static void Main(string[] args)
        {
            var configuration = new ConfigurationBuilder().AddJsonFile("appsettings.json").Build();
            Log.Logger = new LoggerConfiguration().ReadFrom.Configuration(configuration).CreateLogger();

            try
            {
                Log.Information("Starting Program.");
            }
            catch (Exception ex)
            {
                Log.Fatal(ex, "Program terminated unexpectedly.");
                return;
            }
            finally
            {
                Log.CloseAndFlush();
            }
        }
    }
}

Và phần ứng dụng Serilog appsetings.json để tạo một tệp hàng ngày sẽ như sau:

  "Serilog": {
    "MinimumLevel": {
      "Default": "Information",
      "Override": {
        "Microsoft": "Warning",
        "System": "Warning"
      }
    },
    "Using": [ "Serilog.Sinks.Console", "Serilog.Sinks.File" ],
    "WriteTo": [
      {
        "Name": "File",
        "Args": {
          "path": "C:\\Logs\\Program.json",
          "rollingInterval": "Day",
          "formatter": "Serilog.Formatting.Compact.CompactJsonFormatter, Serilog.Formatting.Compact"
        }
      }
    ]
  }

Bạn có thể sử dụng thư viện LiteWare.Configuration cho điều đó. Nó rất giống với .NET Framework gốc ConfigurationManagervà hoạt động cho .NET Core / Standard. Thông thái mã, bạn sẽ kết thúc với một cái gì đó như:

string cacheDirectory = ConfigurationManager.AppSettings.GetValue<string>("CacheDirectory");
ulong cacheFileSize = ConfigurationManager.AppSettings.GetValue<ulong>("CacheFileSize");

Tuyên bố miễn trừ trách nhiệm: Tôi là tác giả của LiteWare.Configuration.

Chỉ cần chồng chất lên ... tương tự như bài của Feiyu Zhou. Ở đây tôi đang thêm tên máy.

public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
        WebHost.CreateDefaultBuilder(args)
          .ConfigureAppConfiguration((context, builder) =>
          {
            var env = context.HostingEnvironment;
            var hostname = Environment.MachineName;
            builder.AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
              .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true, reloadOnChange: true)
              .AddJsonFile($"appsettings.{hostname}.json", optional: true, reloadOnChange: true);
            builder.AddEnvironmentVariables();
            if (args != null)
            {
              builder.AddCommandLine(args);
            }
          })
        .UseStartup<Startup>();
  }

Cài đặt các gói này:

• Microsoft.Extensions.Configuration
• Microsoft.Extensions.Configuration.Binder
• Microsoft.Extensions.Configuration.En Môi trường Biến
• Microsoft.Extensions.Configuration.FileExtensions
• Microsoft.Extensions.Configuration.Json

Mã số:

static void Main(string[] args)
    {
        var environmentName = Environment.GetEnvironmentVariable("ENVIRONMENT");
        Console.WriteLine("ENVIRONMENT: " + environmentName);

        var builder = new ConfigurationBuilder()
           .SetBasePath(Directory.GetCurrentDirectory())
           .AddJsonFile("appsettings.json", false)
           .AddJsonFile($"appsettings.{environmentName}.json", true)
           .AddEnvironmentVariables();

        IConfigurationRoot configuration = builder.Build();
        var mySettingsConfig = configuration.Get<MySettingsConfig>();

        Console.WriteLine("URL: " + mySettingsConfig.Url);
        Console.WriteLine("NAME: " + mySettingsConfig.Name);

        Console.ReadKey();
    }

Lớp MySinstallConfig:

public class MySettingsConfig
{
    public string Url { get; set; }
    public string Name { get; set; }
}

Cài đặt ứng dụng của bạn có thể đơn giản như thế này:

Ngoài ra, đặt tệp cài đặt ứng dụng thành Nội dung / Sao chép nếu mới hơn: