日常开发中,程序的环境切换是相当频繁的了,如果不同环境中的某些参数不同,那就需要每次编辑之前手动进行修改,比较麻烦,效率低下。本文将以 .NET Core WebAPI 项目的配置方法为例,分步骤实现根据环境变量的配置参数,自动读取对应配置文件中的特殊参数值,从而达到 Development、Staging、Production 三种环境的无感部署。
{ // 堆代码 duidaima.com "Logging": { "LogLevel": { "Default": "Information", "Microsoft": "Warning", "Microsoft.Hosting.Lifetime": "Information" } } }需要手动添加一个与 Logging 同级的节点,名称自定义,如下示例:
{ "Logging": { "LogLevel": { "Default": "Information", "Microsoft": "Warning", "Microsoft.Hosting.Lifetime": "Information" } }, "MyPara": { "myparavalue": "测试文本", "myparavalue2": [ { "key": "111", "value": "v111" }, { "key": "222", "value": "v222" }, { "key": "333", "value": "v333" } ] } }注意,三个配置文件中需要加上完全一样的参数名称,然后根据环境不同配置不同的值。
using Microsoft.AspNetCore.Hosting; using Microsoft.Extensions.Configuration; [Route("api/[controller]/[action]")] [ApiController] public class SystemConfigController : ControllerBase // SystemConfig { public static IConfigurationRoot configurationRoot = null; // 堆代码 duidaima.com // 示例只有两个字段,就用字典 Dictionary 来演示了,若字段较多时,可用实体对象 list public static Dictionary<string, string> keyValuePairs = new Dictionary<string, string>(); public SystemConfigController(IWebHostEnvironment env) { try { configurationRoot = AppConfigure.GetConfigurationRoot(env.ContentRootPath, env.EnvironmentName); if (keyValuePairs.Count == 0) // 仅首次加载时读取 { string flag = string.Empty; int i = 0; while (flag != null) { var keyinfo = configurationRoot[$"MyConfigPara:myparavalue2:{i}:key"]; var valueinfo = configurationRoot[$"MyConfigPara:myparavalue2:{i}:value"]; if (keyinfo != null && valueinfo != null) { keyValuePairs.Add(keyinfo, valueinfo); // 加入字典 i++; } else flag = null; } } } catch (Exception ex) { // 日志框架记录日志 } } public void TestAction() { // 读取配置文件具体值 string myparavalue = configurationRoot["MyPara:myparavalue"]; } }配置文件读取帮助类:AppConfigure.cs。
using Microsoft.Extensions.Configuration; using System.Collections.Concurrent; public static class AppConfigure { // 缓存字典 private static readonly ConcurrentDictionary<string, IConfigurationRoot> _cacheDict; static AppConfigure() { _cacheDict = new ConcurrentDictionary<string, IConfigurationRoot>(); } // 传入 JSON 文件夹路径与当前的环境变量值 public static IConfigurationRoot GetConfigurationRoot(string jsonDir, string environmentName = null) { // 设置缓存的 KEY var cacheKey = $"{jsonDir}#{environmentName}"; // 添加默认的 JSON 配置 var builder = new ConfigurationBuilder().SetBasePath(jsonDir) .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true); // 根据环境变量添加相应的 JSON 配置文件 if (!string.IsNullOrEmpty(environmentName)) { builder = builder.AddJsonFile($"appsettings.{environmentName}.json", optional: true, reloadOnChange: true); } // 返回构建成功的 IConfigurationRoot 对象 return builder.Build(); } }三、Windows 服务器配置