如何在ASP.NET Core 的任意类中注入Configuration

在ASP.NET Core中，可以使用Configuration API来读取应用程序的配置信息。在任意类中注入Configuration可以方便地访问应用程序的配置信息。以下是如何在ASP.NET Core的任意类中注入Configuration的完整攻略。

步骤

步骤1：安装Microsoft.Extensions.Configuration包

首先，需要安装Microsoft.Extensions.Configuration包。可以使用以下命令安装：

dotnet add package Microsoft.Extensions.Configuration

步骤2：创建appsettings.json文件

接下来，需要创建一个appsettings.json文件，用于存储应用程序的配置信息。以下是一个简单的示例：

{
  "MyConfig": {
    "ConnectionString": "Server=myServerAddress;Database=myDataBase;User Id=myUsername;Password=myPassword;"
  }
}

在上面的示例中，我们定义了一个名为 MyConfig 的配置节，其中包含一个名为 ConnectionString 的配置项。

步骤3：在Startup.cs中添加Configuration服务

现在，我们已经创建了appsettings.json文件，可以在Startup.cs中添加Configuration服务。以下是一个简单的示例：

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();
    services.AddConfiguration(Configuration);
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // ...
}

private IConfiguration Configuration { get; }

在上面的示例中，我们使用 services.AddConfiguration(Configuration) 方法将Configuration服务添加到依赖注入容器中。

步骤4：在任意类中注入Configuration

现在，我们已经将Configuration服务添加到依赖注入容器中，可以在任意类中注入Configuration。以下是一个简单的示例：

public class MyClass
{
    private readonly IConfiguration _configuration;

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

    public void MyMethod()
    {
        var connectionString = _configuration.GetSection("MyConfig:ConnectionString").Value;
        // ...
    }
}

在上面的示例中，我们在MyClass类的构造函数中注入了Configuration服务，并使用 _configuration.GetSection("MyConfig:ConnectionString").Value 方法获取配置项的值。

示例说明

以下是两个示例说明，演示如何在ASP.NET Core的任意类中注入Configuration。

示例1：在控制器中注入Configuration

以下是在控制器中注入Configuration的步骤：

创建一个新的ASP.NET Core Web应用程序。

dotnet new webapp -n MyWebApp

在上面的命令中，使用 dotnet new 命令创建一个新的Web应用程序。使用 -n 参数指定应用程序的名称为 MyWebApp。

在Startup.cs中添加Configuration服务。

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();
    services.AddConfiguration(Configuration);
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // ...
}

private IConfiguration Configuration { get; }

在上面的示例中，我们使用 services.AddConfiguration(Configuration) 方法将Configuration服务添加到依赖注入容器中。

在控制器中注入Configuration。

[ApiController]
[Route("[controller]")]
public class MyController : ControllerBase
{
    private readonly IConfiguration _configuration;

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

    [HttpGet]
    public IActionResult Get()
    {
        var connectionString = _configuration.GetSection("MyConfig:ConnectionString").Value;
        // ...
    }
}

在上面的示例中，我们在MyController类的构造函数中注入了Configuration服务，并使用 _configuration.GetSection("MyConfig:ConnectionString").Value 方法获取配置项的值。

启动应用程序并测试控制器。

dotnet run

在上面的命令中，使用 dotnet run 命令启动应用程序。

在Web浏览器中输入 http://localhost:5000/MyController，即可访问控制器。

示例2：在服务中注入Configuration

以下是在服务中注入Configuration的步骤：

创建一个新的ASP.NET Core Web应用程序。

dotnet new webapp -n MyWebApp

在上面的命令中，使用 dotnet new 命令创建一个新的Web应用程序。使用 -n 参数指定应用程序的名称为 MyWebApp。

在Startup.cs中添加Configuration服务。

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();
    services.AddConfiguration(Configuration);
    services.AddTransient<MyService>();
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // ...
}

private IConfiguration Configuration { get; }

在上面的示例中，我们使用 services.AddConfiguration(Configuration) 方法将Configuration服务添加到依赖注入容器中，并使用 services.AddTransient<MyService>() 方法将MyService服务添加到依赖注入容器中。

在服务中注入Configuration。

public class MyService
{
    private readonly IConfiguration _configuration;

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

    public void MyMethod()
    {
        var connectionString = _configuration.GetSection("MyConfig:ConnectionString").Value;
        // ...
    }
}

在上面的示例中，我们在MyService类的构造函数中注入了Configuration服务，并使用 _configuration.GetSection("MyConfig:ConnectionString").Value 方法获取配置项的值。

启动应用程序并测试服务。

dotnet run