ASP.NET Core中的配置文件

最新推荐文章于 2024-07-31 10:43:31 发布
最新推荐文章于 2024-07-31 10:43:31 发布
阅读量1.3k 收藏 3
点赞数
分类专栏： # ASP.NET Core 文章标签： c# asp.net core
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Cheng_XZ/article/details/112316044
版权

文章目录

启动配置信息

项目启动的时候，将会获取launchsettings.json设置信息。

  • 我们可以在项目根目录的Properties文件夹中找到此文件
  • 当我们使用Visual Studio或.NET Core CLI运行此ASP.NET Core项目时，将使用此文件中的设置
  • 此文件仅用于本地开发环境，我们不需要把它发布到生产环境的ASP.NET Core程序中
  • 如果希望在使用ASP.NET Core发布和部署应用程序时采用某些独立的设置，请将它们存储在appsettings.json文件中。我们通常将应用程序的配置信息存储在此文件中，比如数据库连接字符串
  • 还可以使用不同环境的appsettings.json文件。比如，appsettings.Staging.json用于临时环境。
  • 在ASP.NET Core中，除appsettings.json文件外，我们还可以采用其他的配置源，如环境变量，用户机密(User Secret)、命令行(Command Line)参数，甚至自定义配置源

打开launchSettings.json，可以看到文件中的设置信息如下：

{
  "iisSettings": {
    "windowsAuthentication": false, 
    "anonymousAuthentication": true, 
    "iisExpress": {
      "applicationUrl": "http://localhost:3682",
      "sslPort": 0
    }
  },
  "profiles": {
    "IIS Express": {
      "commandName": "IISExpress",
      "launchBrowser": true,
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    },
    "WebApplication6": {
      "commandName": "Project",
      "launchBrowser": true,
      "applicationUrl": "http://localhost:5000",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    }
  }
}

请注意：我们有两个配置信息。

  • IIS Express
  • WebApplication6

当我们通过F5键从Visual Studio中运行项目时。

  • 默认情况下，调用配置文件名称“commandName”：“IIS Express”
  • 另外一种情况，如果我们使用.NET Core CLI（dotnet run）运行项目，则使用带有“command Name”：“Project”的配置文件

我们可以通过单击Visual Studio中的下拉列表来更改要配置文件中的commandName属性，修改默认设置。

在这里插入图片描述

默认值如下：

  • 项目名称（现在显示的时WebApplication6）
  • IIS Express
  • IIS

图中所示的值与项目文件中的元素的值对应，当选择的值不同时，会指定要启动的是内部服务器还是外部服务器（反向代理服务器），详情如下表：

commandNameAspNetCoreHostingModel的值Internal Web Server（内部服务器）External Web Server（外部服务器）
项目名称忽略托管设置的值只使用一个Web服务器—IIS Express只使用一个Web服务器—IIS Expresss
IIS Express进程内托管InProcess只使用一个Web服务器—IIS Express只使用一个Web服务器—IIS Express
IIS ExpressOutOfProcessKestrelIIS Express
IISInProcess只使用一个Web服务器—IIS只使用一个Web服务器—IIS
IISOutOfProcessKestrelIIS

我们还可以通过直接编辑launchSettings.json文件来设置commandName的值，也可以使用Visual Studio提供的图形用户界面更改设置。

通过GUI来设置launchSettings文件

在Visual Studio的解决方案资源管理器中右击项目名称，然后从快捷菜单中选择属性。单击项目属性窗口中的调试选项卡，如图所示

在这里插入图片描述

我们可以使用GUI来更改launchSettings.json文件中的设置

注意，环境变量ASPNETCORE_ENVITONMENT的默认值为Development。

可以将此值更改为Staging或Production，具体取决于我们是在Staging还是Production环境中运行了此项目。

我们还可以添加新的环境变量。这些环境变量在ASP.NET Core应用程序中都可用，可以根据这些环境变量的值的不同，有条件地执行代码。

在这里将环境变量ASPNETCORE_ENVIRONMENT设置为Production。保存后打开launchSettings.json文件，发现IIS Express中的ASPNETCORE_ENVIRONMENT值已经修改为Production。

"profiles": {
    "IIS Express": {
      "commandName": "IISExpress",
      "launchBrowser": true,
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Production"
      }
    },

比如，参考Startup.cs文件下Configure()方法的以下代码。

  // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            //其他代码
        }

这段代码的意思是仅当环境变量值为Development时，程序发生异常才会显示开发异常页面。

ASP.NET Core appsettings.json文件

在传统的Asp.Net版本中，我们将应用程序配置（数据库连接字符串）存储在web.config文件中。

在ASP.Net Core中，应用程序配置可以来自以下不同的配置源。

  • appsettings.json和appsettings.{Environment}.json文件可以根据Environment的不同托管在对应环境。
  • User Secret（用户机密）
  • Environment variables（环境变量）
  • Command-line arguments（命令行参数）

appsettings.json文件：我们的项目是通过ASP.NET Core内置的“空”模板创建的，所以项目中已经有一个appsettings.json文件了。

​ 可以对该文件做如下修改，补充一个MyKey的键值对。

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*",
  "MyKey": "appsettings.json中MyKey的值"
}

访问配置信息

若要访问Startup类中的配置信息，则需要在其中注入IConfiguration服务，它是由ASP.NET Core框架提供的。

 public class Startup
    {
        private IConfiguration _configuration;
        //需要先添加一个构造方法，然后将IConfiguration服务注入方法中
        public Startup(IConfiguration configuration)
        {
            _configuration = configuration;
        }

        public void ConfigureServices(IServiceCollection services)
        {
               
        }

        
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            app.Run(async (context) =>
            {
                //防止乱码
                context.Response.ContentType = "text/plain;charset=utf-8";
                //注入后通过_configuration访问MyKey
                await context.Response.WriteAsync(_configuration["MyKey"]);
            });

           //其他代码
        }
    }

此时运行项目仍然出现乱码，我们还需要将appsettings.json文件的编码格式修改为UTF-8。打开文件后，单击Visual Studio标签栏上的文件，选择appsettings.json另存为，然后根据编码保存选择如图所示的UTF-8无签名。
在这里插入图片描述

保存完毕后，执行程序即可得到没有乱码的值。

在这里插入图片描述

appsettings.json

在我们的项目中，appsetings.json文件旁还有一个appsettings.Development.json，现在打开它并添加一个MyKey的键值对。

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "MyKey": "appsettings.Developmen.json中MyKey的值"
}

​ 此时运行项目，会发现浏览器显示的值没有变化，这是因为在launchSettings.json中，将ASPNETCORE_ENVIRONMENT的值修改为了Production。这告诉项目，采用IIS Express启动的时候当前的环境变量为Production，因此appsettings.Development.json的文件没有被读取，而是去读取apppsettings.json中的值。

​ 现在只要将启动配置文件中的Production修改回Development，运行项目后就可以看到MyKey的值已经是appsettings.Development.json中MyKey的值。

​ 当然，如果不想修改launchSettings.json中的值，则可以通过CLI命令行的形式运行项目，也可以通过在Visual Studio标签栏上选择WebApplication6（项目名称）的方式启动项目得到相同的结果。

在这里插入图片描述

用户机密

在应用程序的开发过程中，有时需要在代码中保存一些机密信息，比如加密密钥、字符串、用户名或密码等。通常的做法是将其保存到一个配置文件(如appsettings.json)中。但是在设计以下场景的时候就会发现该文件不够用了。

  • 需要保存一些和第三方网站对接的密钥，比如微信、支付宝或微博站点使用的密钥
  • 在团队协同开发的过程中，开发人员在使用各自本机的数据库时，如何配置数据库地址、账号和密码。

那么此时用户机密就排上用场了，接下来我们启动它，首先右击项目名，选择管理用户机密

Visual Studio会自动创建并打开一个名为secrets.json的文件，我们在文件中添加一行代码。

{
  "MyKey": "secrets.json中的MyKey的值"
}

然后打开项目文件（点击项目名称即可），会发现在PropertyGroup下添加了一行代码

 <UserSecretsId>17b0458c-c095-4825-a1ff-90fc77af6861</UserSecretsId>

在这里，元素中的值代表了用户机密在本地计算机存储的ID，它是由一串GUID的值组成的。

我们可以通过在Visual Studio标签栏上右击secrets.json文件，选择打开所在的文件夹查看，会自动跳到系统文件路径。

%APPDATA%\Microsoft\UserSecrets\<User_Secrets_Id>\secrets.json

在上面的文件路径中，<User_Secrets_Id>与在项目文件中UserSecretsId中的值是相同的。
在这里插入图片描述

用户机密保存在本地计算机中，然后通过UserSecrets的值来替换配置信息，现在运行项目得到的输出结果如图所示。

在这里插入图片描述

环境变量

​ 现在可以打开launchSettings.json文件，在IIS Express中的environmentVariables添加MyKey的键值对。

"profiles": {
    "IIS Express": {
      "commandName": "IISExpress",
      "launchBrowser": true,
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development",
        "MyKey": "launchSettings.json中的MyKey的值"
      }
    },

运行项目后得到的输出结果如图所示

在这里插入图片描述

命令行参数

​ 现在我们再通过使用命令行参数的方式来访问配置信息。

​ 首先打开项目的根目录，然后在资源管理器的地址栏中输入powershell(cmd也可)，按Enter键，系统会打开命令行工具，它会自动帮我们填写路径信息，如图所示

在这里插入图片描述

输入命令dotnet run MyKey=“Value from Command Line”，然后访问http://localhost:5000,得到的结果如图所示

在这里插入图片描述

如图所示，我们通过.NET Core CLI命令行来运行项目，然后通过命令行参数的形式设置了MyKey的值。

ASP.NET Core IConfiguration服务与依赖注入

​ 前面在Startup类构造函数中注入的IConfiguration服务采用的是依赖注入的形式。

  • IConfiguration服务是为从ASP.NET Core中的所有配置源读取配置信息而设计的
  • 如果在多个配置源中具有密钥名称相同的配置中设置，简单来说就是重名了，则后面的配置源将覆盖前面的配置源，所以我们刚刚访问了各种配置源，但是不删除之前的配置信息，原因就是我们通过配置源的读取顺序来设置MyKey的值
  • 静态类Host的CreateDefaultBuilder()方法在应用程序启动时会自动去调用，按特定顺序读取配置源。
  • 要确认配置源的读取顺序，可以查看ASP.NET Core的源代码，查看GitHub上的源代码上的ConfigureAppConfiguration() 方法。查看后就可知道读取各种配置源的顺序如下。
    • appsettings.json
    • appsettings.{Environment}.json
    • 用户机密
    • 环境变量
    • 命令行参数

总结

在实际开发项目的过程中会遇到各种突发情况，到时候可以根据不同的情况采用不同的配置源来适配自己需要的服务，知晓不同的配置源的默认读取顺序，有利于排查问题以及保证系统的安全性。

益生菌冻干粉
关注
  • 0
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Asp.net Core与类库读取配置文件信息的方法
10-17
主要给大家介绍了关于Asp.net Core与类库读取配置文件信息的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
.net core .net6 读取数据库 读取配置文件 保姆级教程
曲滨_銘龘鶽
07-18 4108
.net core .net6 读取数据库、读取配置文件，保姆级教程
.NET Core 核心知识点(五) -- 配置系统(2)自定义配置
最新发布
liyumin2006的博客
07-31 1102
1.第一步：我们在目录下新建一个web.config文件，定义一些配置：2.第二步，新建一个FxConfigurationProvider类继承自FIleConfigurationProvider，然后重写Load方法，定义一个Dictionary用来获取文件中的配置信息，转化为键值对的形式存储，利用XmlDocument类来读取web.config中的内容。并且把数据传到父类的Data数据中；//建立一个键不分大小写的字典//Xml读取//读取连接串//
asp数据库配置，及入口文件
05-10
asp数据库配置，及入口文件
ASP.NET连接数据库配置文件
weixin_30525825的博客
10-13 229
// Web.Config <?xml version="1.0" encoding="utf-8"?> <!-- 有关如何配置 ASP.NET 应用程序的详细信息，请访问 http://go.microsoft.com/fwlink/?LinkId=169433 --> <configuration> &...
ASP.NET中的配置文件
weixin_33841503的博客
06-18 67
 在机房收费系统的时候以前应用过配置文件，当时也就那么一用对配置文件了解的不是非常透彻。以下就来总结一下有关配置文件的一些操作。   什么是配置文件 说白了就是用来保存项目中的一些配置信息，尤其是以后须要变更的配置信息。比方说连接数据库的操作，变更时，直接改动就可以。ASP.NET站点IIS启动的时候会载入配置文件里的配置信息。然后进行缓存这些信息，在执行过...
NET学习——ASP.NET 配置文件
Abbey_qi的博客
09-05 165
今天调试别人代码的时候，发现有的调试页面有显示目录下文件，有的什么都没有显示。经过询问知道和配置文件中的设置有关。可惜本人能力欠缺，看不懂。决定要研究一下配置文件。——2019/09/05 找到一篇讲的比较清楚的文章： https://blog.csdn.net/cxh6863/article/details/82054978 有关如何配置 ASP.NET 应用程序的详细信息，请访问 ht...
asp.net连接mysql配置文件怎么写_ASP.NET连接数据库配置文件
weixin_35505629的博客
02-04 201
// Web.Config// 获取配置文件信息using System;using System.Collections.Generic;using System.Linq;using System.Web;using System.Web.UI;using System.Web.UI.WebControls;using System.Data;using System.Data.SqlClie...
如何在ASP.NET Core类库项目中读取配置文件详解
10-19
在ASP.NET Core中，配置文件的管理是一个关键的方面，特别是在构建类库项目时，我们需要有效地读取和使用这些配置。在.NET Core之前，配置通常存储在web.config文件中，但现在，配置文件通常是JSON格式，如...
ASP.NET core Web中使用appsettings.json配置文件的方法
10-19
这篇内容将详细介绍如何在ASP.NET Core Web项目中使用`appsettings.json`配置文件。 首先，`appsettings.json`文件是存储应用程序配置信息的标准JSON格式文件，通常位于项目的根目录下。它可以包含各种层次的键值对...
ASP.NET Core MVC 配置全局路由前缀
10-21
ASP.NET Core MVC 配置全局路由前缀是用于在应用程序中为所有路由添加一个公共的前缀，使得接口请求地址更加规范和易于管理。在传统的做法中，我们可能需要在每个控制器或操作方法上手动添加特性路由（如 `[Route("/...
使用SQL Server数据库的ASP网站配置
11-09
使用SQL Server数据库的ASP网站配置介绍了集成Windows验证模式下的详细配置方法
认识ASP.NET配置文件Web.config
12-26
Web.config文件是一个XML文本文件，它用来储存 ASP.NET Web 应用程序的配置信息（如最常用的设置ASP.NET Web 应用程序的身份验证方式），它可以出现在应用程序的每一个目录中。当你通过VB.NET新建一个Web应用程序后，默认情况下会在根目录自动创建一个默认的 Web.config文件，包括默认的配置设置，所有的子目录都继承它的配置设置。如果你想修改子目录的配置设置，你可以在该子目录下新建一个Web.config文件。它可以提供除从父目录继承的配置信息以外的配置信息，也可以重写或修改父目录中定义的设置。 http://www.abo518,cn
ASP.NET Core中修改配置文件后自动加载新配置的方法详解
10-14
在默认情况下，ASP.NET Core提供了对配置文件的自动重新加载功能，使得在更新了如`appsettings.json`或环境特定的配置文件后，系统能自动读取新的配置值。以下将详细介绍如何实现这一特性。 首先，我们来看ASP.NET ...
ASP.NET网站开发中的配置文件
weixin_30716141的博客
03-17 82
来源：微信公众号CodeL 1.配置文件层次分类 Machine.config：对.netframework整体的配置 web.config（framework目录下）：对所有项目所公有的应用程序配置 web.config（应用程序下）： 对当前应用程序的配置(项目目录中常见的) 2.运行顺序 配置文件的运行顺序从大到小，从公有到私有：machine.conf...
asp.net网站运行时，读取的配置文件总是网站根目录的配置文件
布里渊区
02-17 757
不管开发时在其它相关引用项目中写没写配置文件，当网站运行时，总是读取网站根目录的配置文件【开发时有感】
C# asp.net 中关于配置文件的配置和作用（数据库部分）
Niro_z的专栏
12-26 2057
web中在web.config配置文件中写了连接数据库的作用   第一步： 在web.config配置文件中添加有下划线的类似如下代码：                           第二步： 在要使用数据库连接的页面中引入 using System.Configuration;  ///系统配置包在配置文件中设置数据库连接时必须用   第三步：
Asp.net配置文件中数据库的连接
lovejesuslove的博客
03-21 296
1.SQL登陆： <add key="SQLConnString" value="Data Source=YUBINGJIAN;Initial Catalog=LcDB;Persist Security Info=True;User ID=aaa;pwd=aaa;"/> 一定要注意这样写才可以。*************pwd=aaa;
Asp.NetCore 从数据库加载配置（二）
q__y__L的博客
11-03 640
在第一节中，我们实现了基本的自定义数据库配置源，从而可以读取MySql数据库的配置，但是，我们没有实现动态加载数据库配置，也就是程序一但运行起来，数据库的配置更改后就不在被更新。所以本节重点来解决这个问题。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值