asp.net core 中灵活的配置方式
asp.net core支持外部文件和命令行参数方式来配置系统运行所需要的配置信息,我们从下面两个常用场景来具体说下具体使用方法。
一、监听地址及端口配置
1,命令行方式
asp.net core系统通过命令行方式启动,使用的命令如下:
dotnet run
上面的命令直接在源代码目录下执行,便可以编译程序并运行。那对于已经发布好的程序,就不能使用上面的指令了,应该使用下面的指令:
dotnet 程序集文件名(程序集文件名就是程序发布后生成的dll文件)
上面两个指令都能够启动应用程序。程序启动后,默认监听地址及端口是http://localhost:5000。但是程序发布后,肯定不会使用默认的地址及端口,那如果要想让启动时监听其他的地址或域名怎么办?答案是使用--urls参数,具体指令格式如下:
dotnet run --urls="http://域名:端口号"
如果想设置多个域名,可以使用分号分隔。
程序默认情况下是不支持参数传递的,我们需要对程序进行一些配置。首先需要引入Microsoft.Extensions.Configuration.CommandLine库文件,然后在main方法中添加commandline支持,具体代码如下:
public class Program { public static void Main(string[] args) { var config = new ConfigurationBuilder() .AddCommandLine(args)//增加commandline支持 .Build(); var host = new WebHostBuilder() .UseConfiguration(config) .UseKestrel() .UseContentRoot(Directory.GetCurrentDirectory()) .UseIISIntegration() .UseStartup<Startup>() .UseApplicationInsights() .Build(); host.Run(); } }
经过配置后就可以使用上面的指令传递参数了
2,配置文件
asp.net core配置信息也可以放置在一个配置文件中,系统启动时进行加载配置文件内容,来影响程序启动所需要的环境参数。我们来看一下具体操作过程。
首先我们需要引入一个库文件"Microsoft.Extensions.Configuration.Json",然后在main方法中引入配置文件路径信息,具体代码如下:
public class Program { public static void Main(string[] args) { var config = new ConfigurationBuilder() .SetBasePath(Directory.GetCurrentDirectory()) .AddJsonFile("hosting.json") .Build(); var host = new WebHostBuilder() .UseConfiguration(config) .UseKestrel() .UseContentRoot(Directory.GetCurrentDirectory()) .UseIISIntegration() .UseStartup<Startup>() .UseApplicationInsights() .Build(); host.Run(); } }
通过上面方式,我们就增加了一个外部的hosting.json配置文件,在里面我们可以增加监听地址信息,内容如下:
{ "server.urls": "http://*:5001" }
二、运行环境配置
在进行项目开发时,常常要求开发环境,测试环境及正式环境的分离,并且不同环境运行的参数都是不一样的,比如监听地址,数据库连接信息等。当然我们把配置信息保存到一个文件中,每次发布的时候,可以先修改配置文件的内容,然后再进行程序发布,这样操作起来无疑是很麻烦,每次发布都得先确定对应的环境,然后修改配置信息,如果需要同时发布多个环境版本,那就得进行多次操作。
asp.net core 其实已经考虑到了这样的场景,我们可以先看下下面的代码:
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(); }
上面的代码是出现在startup.cs文件中,里面首先使用AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)加载appsettings配置文件,这个文件里可以放置所有环境共享的信息,后面有一句AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true),env.EnvironmentName其实就是系统环境,根据启动时设置的EnvironmentName不同,可以加载对应的配置文件内容。
现在的问题是如何去指定这个EnvironmentName?
1,通过命令行指定environment
在执行dotnet run之前,可以先执行以下下面的指令:
set ASPNETCORE_ENVIRONMENT= 环境名称,注意这里没有引号,直接把环境名称写成具体的值即可,比如 set ASPNETCORE_ENVIRONMNET=development
然后再执行dotnet run指令,这样当前运行就会按照set指令中设置的环境进行运行
2,直接给dotnet run指令传递具体参数
先看直接的执行效果:dotnet run --ASPNETCORE_ENVIRONMENT=development
具体做法:引入Microsoft.Extensions.Configuration.CommandLine,Microsoft.Extensions.Configuration.EnvironmentVariables库文件,然后在main方法中增加环境参数的支持,具体代码如下:
public class Program { public static void Main(string[] args) { var config = new ConfigurationBuilder() .AddEnvironmentVariables() .AddCommandLine(args) .SetBasePath(Directory.GetCurrentDirectory()) .AddJsonFile("hosting.json") .Build(); var host = new WebHostBuilder() .UseEnvironment(config["ASPNETCORE_ENVIRONMENT"]) .UseConfiguration(config) .UseKestrel() .UseContentRoot(Directory.GetCurrentDirectory()) .UseIISIntegration() .UseStartup<Startup>() .UseApplicationInsights() .Build(); host.Run(); } }
关键是AddEnvironmentVariables(),UseEnvironment(config["ASPNETCORE_ENVIRONMENT"])两处的处理。这样我们就可以在dotnet run指令后面增加对应的环境参数。