欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

.NET Core配置多环境的方法步骤

程序员文章站 2023-11-20 21:40:52
配置多环境是日常开发经常需要用到的操作,实现多环境配置后可以规避生产测试环境混合带来的麻烦和风险,减少项目风险,并且也可以通过多环境来保证生产环境上密钥的安全。 我之前在...

配置多环境是日常开发经常需要用到的操作,实现多环境配置后可以规避生产测试环境混合带来的麻烦和风险,减少项目风险,并且也可以通过多环境来保证生产环境上密钥的安全。

我之前在做ios开发时,ios的解决方法是通过多个target配置不同的环境变量,并且配合宏来实现不同的环境启动时,读取不同的配置,在.net core中当然也会有类似的这种方式,并且它比ios中更简单,只需要注入不同的环境变量即可,而ios还需要建立多个target才能实现注入不同的环境变量,.net core则可以直接在启动时注入不同的环境变量,根本无需再做其它操作。

方式一:预编译指令debug

#if debug
      //读取环境1配置文件
#else
      //读取环境2配置文件
#endif

如果你只有两套环境,这种方式也勉强够用,在日常开发中,我们基本上都是debug模式运行的,在生产环境发布的代码,也基本上都是编译的release代码,所以使用预编译指令 #if debug 即可以满足这种需求,而且这种操作方式非常简单,只需要准备两个不同的配置文件来给两个不同环境读取即可。

/// <summary>
  /// 全局配置管理类(按照debug/release区分环境)
  /// </summary>
  public static class myconfiguration
  {
    public static iconfiguration configuration { get; set; }
    static myconfiguration()
    {
    #if debug
      var envpath = "appsettings.development.json";
    #else
      var envpath = "appsettings.json";
    #endif
      configuration = new configurationbuilder()
        .add(new jsonconfigurationsource
        {
          path = envpath,
          reloadonchange = true
        }).build();
    }
  }

但是如果你想调试生产环境或者想实现两个以上的环境的话,那么就只能使用第二种方式了。

方式二:注入不同环境变量

首先准备好你不同环境的配置文件,例如:

.NET Core配置多环境的方法步骤

然后选择启动项目properties下的launchsettings.json文件,添加如下配置:

{
 "profiles": {
  "240": {
   "commandname": "240",
   "launchbrowser": true,
   "launchurl": "",
   "environmentvariables": {
    "aspnetcore_environment": "dev240"
   }
  },
  "241": {
   "commandname": "241",
   "launchbrowser": true,
   "launchurl": "",
   "environmentvariables": {
    "aspnetcore_environment": "dev241"
   }
  },"243": {
   "commandname": "243",
   "launchbrowser": true,
   "launchurl": "",
   "environmentvariables": {
    "aspnetcore_environment": "dev243"
   }
  },"staging": {
   "commandname": "staging",
   "launchbrowser": true,
   "launchurl": "",
   "environmentvariables": {
    "aspnetcore_environment": "staging"
   }
  }
 }
}

此时,启动选择已然变成这样:

.NET Core配置多环境的方法步骤

当然,我们也可以直接在启动项目的properties里面改,如下图:

.NET Core配置多环境的方法步骤

当然环境变量配置好了之后,我们就需要来使用环境变量,新建一个配置的工具类文件:

/// <summary>
  /// 全局配置管理类(适配多环境)
  /// </summary>
  public static class myconfigurationhelper
  {
    public static iconfiguration config { get; set; }
    static myconfigurationhelper()
    {
      var env = bfserviceprovider.serviceprovider.getrequiredservice<ihostingenvironment>();
      config = new configurationbuilder()
        .setbasepath(env.contentrootpath)
        .addjsonfile($"appsettings.{env.environmentname}.json", true, true)
        .build();
    }
    
  }

  public static class myserviceprovider
  {
    public static iserviceprovider serviceprovider { get; set; }
  }

这个文件中提供了一个读取配置 iconfigurationmyconfigurationhelper 类和一个提供 iserviceprovider 容器的 myserviceprovideriserviceprovider 是.net core中的服务容器,他能够访问到程序注入的环境变量,然后进入 startup.cs 中引用这个文件,并且在 configure 方法中,将 iapplicationbuilderapplicationservices 传递进去。

public void configure(iapplicationbuilder app, ihostingenvironment env)
  {
    //配置多环境
    myserviceprovider.serviceprovider = app.applicationservices;
  }

这时,我们回过去看 myconfigurationhelper 类,它将会在下一次被使用时,从 iserviceprovider 中读取我们选择的启动环境对应的环境变量字符串dev240、dev241、dev243、staging;从而实现读取不同的配置文件与 iconfiguration config 中,我们后继使用读取配置文件的操作时,都将使用 myconfigurationhelper.config 来进行读取。

发布时区分多环境

在liunx上面,我们使用supervisor来守护我们的.net core应用程序,所以我们想要运行哪个环境,就可以在supervisor的项目配置中进行配置,修改 /etc/supervisord.d/ 下的配置文件键入环境变量如下:

# /etc/supervisord.d/dotnetcoretest.ini
[program:dotnetcoretest]
directory=/xxx/dotnetcoretest
command=dotnet dotnetcoretest.dll
autostart=true
autorestart=true
user=root
numprocs=1
redirect_stderr=true
stdout_logfile=/xxx/logs/dotnetcoretest.log
# 环境变量
environment=aspnetcore_environment=dev240

方式一在发布时只需要编译release就能自动读取对应环境的配置文件,无需上面的操作。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。