ASP.NET Core配置设置之Configuration包

在ASP.NET Core应用程序中，Configuration包是一个非常重要的包，它允许我们从不同的配置源中读取配置信息，并将其注入到应用程序中。本攻略将介绍如何使用Configuration包，并提供两个示例说明。

1. 安装Configuration包

在ASP.NET Core应用程序中使用Configuration包，需要先安装Microsoft.Extensions.Configuration包。可以使用NuGet包管理器或在项目文件中手动添加以下代码：

<ItemGroup>
  <PackageReference Include="Microsoft.Extensions.Configuration" Version="5.0.0" />
</ItemGroup>

2. 使用Configuration包

在ASP.NET Core应用程序中使用Configuration包，可以按照以下步骤操作：

1. 在appsettings.json文件中添加配置信息。

{
  "MyConfig": {
    "Name": "My Application",
    "Version": "1.0.0"
  }
}

在上面的代码中，我们添加了一个名为"MyConfig"的配置节，并在其中添加了"Name"和"Version"两个配置项。

1. 在Startup.cs文件中注入配置信息。

using Microsoft.Extensions.Configuration;

public class Startup
{
    private readonly IConfiguration _configuration;

    public Startup(IConfiguration configuration)
    {
        _configuration = configuration;
    }

    public void ConfigureServices(IServiceCollection services)
    {
        services.Configure<MyConfig>(_configuration.GetSection("MyConfig"));
    }
}

在上面的代码中，我们在Startup类的构造函数中注入了IConfiguration对象，并在ConfigureServices方法中使用Configure方法将"MyConfig"配置节注入到MyConfig对象中。

1. 在控制器中使用配置信息。

using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Options;

namespace MyApplication.Controllers
{
    public class MyController : Controller
    {
        private readonly MyConfig _myConfig;

        public MyController(IOptions<MyConfig> myConfig)
        {
            _myConfig = myConfig.Value;
        }

        public IActionResult Index()
        {
            ViewBag.Name = _myConfig.Name;
            ViewBag.Version = _myConfig.Version;
            return View();
        }
    }
}

在上面的代码中，我们在控制器类的构造函数中注入了IOptions对象，并在Index方法中使用配置信息。

3. 示例说明

以下是两个示例，演示了如何在ASP.NET Core应用程序中使用Configuration包。

示例一：读取数据库连接字符串

在这个示例中，我们演示了如何从appsettings.json文件中读取数据库连接字符串。可以按照以下步骤操作：

1. 在appsettings.json文件中添加数据库连接字符串。

{
  "ConnectionStrings": {
    "DefaultConnection": "Server=(localdb)\\mssqllocaldb;Database=MyDatabase;Trusted_Connection=True;MultipleActiveResultSets=true"
  }
}

在上面的代码中，我们添加了一个名为"DefaultConnection"的数据库连接字符串。

1. 在Startup.cs文件中注入数据库连接字符串。

using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.Configuration;

public class Startup
{
    private readonly IConfiguration _configuration;

    public Startup(IConfiguration configuration)
    {
        _configuration = configuration;
    }

    public void ConfigureServices(IServiceCollection services)
    {
        services.AddDbContext<MyDbContext>(options =>
            options.UseSqlServer(_configuration.GetConnectionString("DefaultConnection")));
    }
}

在上面的代码中，我们在ConfigureServices方法中使用UseSqlServer方法将"DefaultConnection"数据库连接字符串注入到MyDbContext对象中。

1. 在控制器中使用数据库连接字符串。

using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;

namespace MyApplication.Controllers
{
    public class MyController : Controller
    {
        private readonly IConfiguration _configuration;

        public MyController(IConfiguration configuration)
        {
            _configuration = configuration;
        }

        public IActionResult Index()
        {
            var connectionString = _configuration.GetConnectionString("DefaultConnection");
            return View();
        }
    }
}

在上面的代码中，我们在控制器类的构造函数中注入了IConfiguration对象，并在Index方法中使用GetConnectionString方法获取数据库连接字符串。

示例二：读取自定义配置信息

在这个示例中，我们演示了如何从appsettings.json文件中读取自定义配置信息。可以按照以下步骤操作：

1. 在appsettings.json文件中添加自定义配置信息。

{
  "MyConfig": {
    "Name": "My Application",
    "Version": "1.0.0"
  }
}

在上面的代码中，我们添加了一个名为"MyConfig"的配置节，并在其中添加了"Name"和"Version"两个配置项。

1. 在Startup.cs文件中注入自定义配置信息。

using Microsoft.Extensions.Configuration;

public class Startup
{
    private readonly IConfiguration _configuration;

    public Startup(IConfiguration configuration)
    {
        _configuration = configuration;
    }

    public void ConfigureServices(IServiceCollection services)
    {
        services.Configure<MyConfig>(_configuration.GetSection("MyConfig"));
    }
}

在上面的代码中，我们在ConfigureServices方法中使用Configure方法将"MyConfig"配置节注入到MyConfig对象中。

1. 在控制器中使用自定义配置信息。

using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Options;

namespace MyApplication.Controllers
{
    public class MyController : Controller
    {
        private readonly MyConfig _myConfig;

        public MyController(IOptions<MyConfig> myConfig)
        {
            _myConfig = myConfig.Value;
        }

        public IActionResult Index()
        {
            ViewBag.Name = _myConfig.Name;
            ViewBag.Version = _myConfig.Version;
            return View();
        }
    }
}

在上面的代码中，我们在控制器类的构造函数中注入了IOptions对象，并在Index方法中使用配置信息。