ตั้งค่า appsettings.json โดยอัตโนมัติสำหรับสภาพแวดล้อมการพัฒนาและรีลีสในแกน asp.net หรือไม่

Question 1

ฉันได้กำหนดค่าบางอย่างใน my appsettings.jsonสำหรับสิ่งต่างๆเช่นสตริงการเชื่อมต่อฐานข้อมูลตำแหน่ง webapi และสิ่งที่คล้ายกันซึ่งแตกต่างกันสำหรับการพัฒนาการจัดเตรียมและสภาพแวดล้อมแบบสด

มีวิธีการมีหลายappsettings.jsonไฟล์ (เช่นappsettings.live.jsonฯลฯ ฯลฯ ) และมีแอป asp.net เพียงแค่ 'รู้' ว่าจะใช้ไฟล์ใดตามการกำหนดค่าบิลด์ที่กำลังทำงานอยู่

Question 2

คุณสามารถใช้การรวบรวมตามเงื่อนไข:

public Startup(IHostingEnvironment env)
{
    var builder = new ConfigurationBuilder()
    .SetBasePath(env.ContentRootPath)
    .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
#if SOME_BUILD_FLAG_A
    .AddJsonFile($"appsettings.flag_a.json", optional: true)
#else
    .AddJsonFile($"appsettings.no_flag_a.json", optional: true)
#endif
    .AddEnvironmentVariables();
    this.configuration = builder.Build();
}

Question 3

ฉันได้เพิ่มภาพหน้าจอของสภาพแวดล้อมการทำงานเนื่องจากต้องใช้เวลาหลายชั่วโมงในการวิจัยและพัฒนา

ขั้นแรกให้เพิ่มคีย์ลงในlaunch.jsonไฟล์ของคุณ

ดูภาพหน้าจอด้านล่างฉันได้เพิ่มDevelopmentเป็นสภาพแวดล้อมของฉัน
จากนั้นในโครงการของคุณให้สร้างappsettings.{environment}.jsonไฟล์ใหม่ที่มีชื่อของสภาพแวดล้อม

ในภาพหน้าจอต่อไปนี้ให้มองหาไฟล์สองไฟล์ที่มีชื่อ:
- appsettings.Development.Json
- appSetting.json

และสุดท้ายกำหนดค่าให้กับStartUpชั้นเรียนของคุณดังนี้:

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();

    Configuration = builder.Build();
}

และในที่สุดคุณสามารถเรียกใช้จากบรรทัดคำสั่งเช่นนี้:
```
dotnet run --environment "Development"
```
ที่"Development"เป็นชื่อของสภาพแวดล้อมของฉัน

Question 4

อัปเดตสำหรับ. NET Core 3.0+

คุณสามารถใช้CreateDefaultBuilderซึ่งจะสร้างและส่งผ่านวัตถุการกำหนดค่าไปยังคลาสเริ่มต้นของคุณโดยอัตโนมัติ:

WebHost.CreateDefaultBuilder(args).UseStartup<Startup>();

public class Startup
{
    public Startup(IConfiguration configuration) // automatically injected
    {
        Configuration = configuration;
    }
    public IConfiguration Configuration { get; }
    /* ... */
}

CreateDefaultBuilderรวมไฟล์ที่เหมาะสมโดยอัตโนมัติดังนั้นให้เพิ่มไฟล์ appsettings แยกต่างหากสำหรับแต่ละสภาพแวดล้อม:appsettings.Environment.json
จากนั้นตั้งค่าASPNETCORE_ENVIRONMENT ตัวแปรสภาพแวดล้อมเมื่อรัน / ดีบัก

วิธีตั้งค่าตัวแปรสภาพแวดล้อม

ขึ้นอยู่กับ IDE ของคุณมีสองสถานที่ที่โครงการดอทเน็ตมักมองหาตัวแปรสภาพแวดล้อม:

สำหรับVisual Studioไปที่ Project> Properties> Debug> Environment Variables:
สำหรับVisual Studio Codeแก้ไข.vscode/launch.json> env:
ใช้Launch Settingsแก้ไขProperties/launchSettings.json> environmentVariables:

ซึ่งสามารถเลือกได้จาก Toolbar ใน Visual Studio
การใช้dotnet CLIใช้ไวยากรณ์ที่เหมาะสมสำหรับการตั้งค่าตัวแปรสภาพแวดล้อมตามระบบปฏิบัติการของคุณ

หมายเหตุ : เมื่อแอปเปิดตัวด้วยระยะ dotnet , launchSettings.jsonถูกอ่านถ้าพร้อมใช้งานและenvironmentVariablesการตั้งค่าใน launchSettings.json ตัวแปรสภาพแวดล้อมแทนที่

วิธีการ`Host.CreateDefaultBuilder`ทำงานหรือไม่

.NET Core 3.0 เพิ่มHost.CreateDefaultBuilderภายใต้ส่วนขยายแพลตฟอร์มซึ่งจะให้การเริ่มต้นเริ่มต้นIConfigurationซึ่งจะให้การกำหนดค่าเริ่มต้นสำหรับแอปตามลำดับต่อไปนี้

appsettings.jsonโดยใช้ผู้ให้บริการกำหนดค่า JSON

appsettings.Environment.jsonโดยใช้ผู้ให้บริการกำหนดค่า JSON ตัวอย่างเช่น:

appsettings.Production.json หรือ

appsettings.Development.json

ความลับของแอปเมื่อแอปทำงานในสภาพแวดล้อมการพัฒนา

ตัวแปรสภาพแวดล้อมโดยใช้ผู้ให้บริการกำหนดค่าตัวแปรของสภาพแวดล้อม

อาร์กิวเมนต์บรรทัดคำสั่งโดยใช้ผู้ให้บริการกำหนดค่าบรรทัดคำสั่ง

การอ่านเพิ่มเติม - MS Docs

Question 5

ใน ASP.NET Core คุณควรใช้ Environment Variables แทนการสร้างคอนฟิกูเรชันสำหรับ appsettings.json ที่เหมาะสม

คลิกขวาที่โปรเจ็กต์ของคุณ> คุณสมบัติ> ดีบัก> ตัวแปรสภาพแวดล้อม
ASP.NET Core จะใช้ไฟล์ appsettings.json ที่เหมาะสม:

ตอนนี้คุณสามารถใช้ Environment Variable ได้ดังนี้:

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

    Configuration = builder.Build();
}

หมายเหตุ : หากคุณใช้คำตอบของ @ Dmitryคุณอาจพบปัญหาเช่น เมื่อแทนที่ค่า appsettings.json บน Azure

Question 6

คุณสามารถใช้ตัวแปรสภาพแวดล้อมและConfigurationBuilderคลาสในตัวStartupสร้างของคุณได้ดังนี้:

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

จากนั้นคุณจะสร้างappsettings.xxx.jsonไฟล์สำหรับทุกสภาพแวดล้อมที่คุณต้องการโดยมี "xxx" เป็นชื่อสภาพแวดล้อม โปรดทราบว่าคุณสามารถใส่ค่าการกำหนดค่าส่วนกลางทั้งหมดในappsettings.jsonไฟล์"ปกติ" ของคุณและใส่เฉพาะสภาพแวดล้อมลงในไฟล์ใหม่เหล่านี้

ตอนนี้คุณต้องการเพียงตัวแปรสภาพแวดล้อมที่เรียกASPNETCORE_ENVIRONMENTด้วยค่าสภาพแวดล้อมที่เฉพาะเจาะจง ("live", "staging", "production" อะไรก็ได้) คุณสามารถระบุตัวแปรนี้ในการตั้งค่าโปรเจ็กต์สำหรับสภาพแวดล้อมการพัฒนาของคุณและแน่นอนว่าคุณต้องตั้งค่าในสภาพแวดล้อมการจัดเตรียมและการใช้งานจริงด้วย วิธีที่คุณทำขึ้นอยู่กับสภาพแวดล้อมแบบนี้

UPDATE:ฉันเพิ่งตระหนักคุณต้องการที่จะเลือกappsettings.xxx.jsonขึ้นอยู่กับปัจจุบันของคุณสร้างการกำหนดค่า สิ่งนี้ไม่สามารถทำได้ด้วยวิธีแก้ปัญหาที่ฉันเสนอและฉันไม่รู้ว่ามีวิธีทำหรือไม่ อย่างไรก็ตามวิธี "ตัวแปรสภาพแวดล้อม" ได้ผลและอาจเป็นทางเลือกที่ดีสำหรับแนวทางของคุณด้วย

Question 7

เพียงแค่อัปเดตสำหรับผู้ใช้. NET core 2.0 คุณสามารถระบุการกำหนดค่าแอปพลิเคชันหลังจากโทรไปที่CreateDefaultBuilder:

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

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

   static void ConfigConfiguration(WebHostBuilderContext ctx, IConfigurationBuilder config)
   {
            config.SetBasePath(Directory.GetCurrentDirectory())
                .AddJsonFile("config.json", optional: false, reloadOnChange: true)
                .AddJsonFile($"config.{ctx.HostingEnvironment.EnvironmentName}.json", optional: true, reloadOnChange: true);

   }
 }

Question 8

สร้างไฟล์หลายไฟล์เช่น:appSettings.$(Configuration).json
- appSettings.staging.json
- appSettings.production.json
สร้างเหตุการณ์ก่อนสร้างในโปรเจ็กต์ซึ่งคัดลอกไฟล์ตามลำดับไปยังappSettings.json:
```
copy appSettings.$(Configuration).json appSettings.json
```

ใช้เฉพาะappSettings.jsonใน Config Builder ของคุณ:

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

Configuration = builder.Build();

Question 9

คุณสามารถเพิ่มชื่อการกำหนดค่าเป็นASPNETCORE_ENVIRONMENTในlaunchSettings.jsonดังต่อไปนี้

  "iisSettings": {
    "windowsAuthentication": false,
    "anonymousAuthentication": true,
    "iisExpress": {
      "applicationUrl": "http://localhost:58446/",
      "sslPort": 0
    }
  },
  "profiles": {
    "IIS Express": {
      "commandName": "IISExpress",
      "environmentVariables": {
        ASPNETCORE_ENVIRONMENT": "$(Configuration)"
      }
    }
  }

Question 10

นี่เป็นเวอร์ชันที่เหมาะกับฉันเมื่อใช้แอปคอนโซลที่ไม่มีหน้าเว็บ:

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

            IConfigurationRoot configuration = builder.Build();
            AppSettings appSettings = new AppSettings();
            configuration.GetSection("AppSettings").Bind(appSettings);

Question 11

ไฟล์. vscode / launch.json ใช้เฉพาะโดย Visual Studio เช่นเดียวกับไฟล์ /Properties/launchSettings.json อย่าใช้ไฟล์เหล่านี้ในการผลิต

ไฟล์ launchSettings.json:

ใช้กับเครื่องพัฒนาท้องถิ่นเท่านั้น
ไม่มีการปรับใช้
มีการตั้งค่าโปรไฟล์
- ค่าสภาพแวดล้อมที่ตั้งค่าใน launchSettings.json ค่าแทนที่ที่ตั้งไว้ในสภาพแวดล้อมระบบ

ในการใช้ไฟล์ 'appSettings.QA.json' เช่น คุณสามารถใช้ "ASPNETCORE_ENVIRONMENT" ทำตามขั้นตอนด้านล่าง

เพิ่มตัวแปรสภาพแวดล้อมใหม่บนเครื่องโฮสต์และเรียกมันว่า 'ASPNETCORE_ENVIRONMENT' ตั้งค่าเป็น 'QA'
สร้างไฟล์ 'appSettings.QA.json' ในโปรเจ็กต์ของคุณ เพิ่มการกำหนดค่าของคุณที่นี่
ปรับใช้กับเครื่องในขั้นตอนที่ 1 ยืนยันว่ามีการปรับใช้ 'appSettings.QA.json'
โหลดเว็บไซต์ของคุณ คาดว่า appSettings.QA.json จะถูกใช้ที่นี่

ตั้งค่า appsettings.json โดยอัตโนมัติสำหรับสภาพแวดล้อมการพัฒนาและรีลีสในแกน asp.net หรือไม่

อัปเดตสำหรับ. NET Core 3.0+

วิธีตั้งค่าตัวแปรสภาพแวดล้อม

วิธีการHost.CreateDefaultBuilderทำงานหรือไม่

การอ่านเพิ่มเติม - MS Docs

วิธีการ`Host.CreateDefaultBuilder`ทำงานหรือไม่