OStack程序员社区-中国程序员成长平台 › 门户 › 编程› ASP.NET›ASP.NET编程经验

ASP.NetCore解读appsettings.json

原作者: [db:作者] 来自: [db:来源] 收藏邀请

环境：ASP.NET Core3.1

ASP.NET Core是一个全新的Web开发平台，微软在它上面构建了MVC、SingalR、GRPC、Orleans这样广泛使用的Web框架，我们先以MVC框架为例介绍利用ASP.NET Core构建项目的常见名词。这篇文章介绍appsettings.json

ASP.NET Core MVC项目文件夹解读

在开发项目的过程当中，生产环境与调试环境的配置是不一样的，比如连接字符串。 ASP .NET Core 支持利用环境变量来动态配置 JSON 文件。ASP.NET Core 引用了一个特定的环境变量 ASPNETCORE_ENVIRONMENT 来描述应用程序当前运行的环境。这个变量可以被设置为任何你喜欢的值，但是有三个值被约定使用： Development，Staging 和 Production。

二、Appsettings.json

首先在 ASP .NET Core 项目当中添加一个appsettings.json（默认都有该文件）文件，内容如下图：

再继续添加 appsettings.Development.json和appsettings.Production.json两个配置文件。解决方案管理器如下图：

我们可以在appsettings.Development.json和appsettings.Production.json分别设置相应的配置信息，比如数据库连接

三、自定义配置json

有时候一个复杂的项目配置信息比较多，Appsettings.json会很复杂，所以一般都会把一些单独分离出来，比如将数据库连接配置分离出来。

首先在 ASP .NET Core 项目当中添加一个connectionStrings.json文件，内容如下：

再继续添加 connectionStrings.Development.json和connectionStrings.Production.json两个配置文件。如下图：

之前有同事问，我们添加了一个自定义的json文件，应用是如何也晓得的呢？IHostBuilder提供了一个扩展方法ConfigureAppConfiguration，它的作用就是将我们自定义的json文件注入到项目中，能够被应用所识别。ConfigureAppConfiguration方法可累加，也就是说你可以利用ConfigureAppConfiguration方法加入多个json文件。如：

public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    webBuilder.UseKestrel();
                    webBuilder.UseStartup<Startup>();
                })
                //指定自定义的配置json
                .ConfigureAppConfiguration((h, c) =>
                {
                    c.AddJsonFile($"appsettings_ratelimit.json", true, true);
                });

使用的时候和使用appsettings.json一样，不用指定json的文件名称。为什么呢？看下AddJsonFile方法的源码如下：

// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.

using System;
using System.Collections.Generic;

namespace Microsoft.Extensions.Configuration
{
    /// <summary>
    /// Used to build key/value based configuration settings for use in an application.
    /// </summary>
    public class ConfigurationBuilder : IConfigurationBuilder
    {
        /// <summary>
        /// Returns the sources used to obtain configuration values.
        /// </summary>
        public IList<IConfigurationSource> Sources { get; } = new List<IConfigurationSource>();

        /// <summary>
        /// Gets a key/value collection that can be used to share data between the <see cref="IConfigurationBuilder"/>
        /// and the registered <see cref="IConfigurationProvider"/>s.
        /// </summary>
        public IDictionary<string, object> Properties { get; } = new Dictionary<string, object>();

        /// <summary>
        /// Adds a new configuration source.
        /// </summary>
        /// <param name="source">The configuration source to add.</param>
        /// <returns>The same <see cref="IConfigurationBuilder"/>.</returns>
        public IConfigurationBuilder Add(IConfigurationSource source)
        {
            if (source == null)
            {
                throw new ArgumentNullException(nameof(source));
            }

            Sources.Add(source);
            return this;
        }

        /// <summary>
        /// Builds an <see cref="IConfiguration"/> with keys and values from the set of providers registered in
        /// <see cref="Sources"/>.
        /// </summary>
        /// <returns>An <see cref="IConfigurationRoot"/> with keys and values from the registered providers.</returns>
        public IConfigurationRoot Build()
        {
            var providers = new List<IConfigurationProvider>();
            foreach (var source in Sources)
            {
                var provider = source.Build(this);
                providers.Add(provider);
            }
            return new ConfigurationRoot(providers);
        }
    }
}