C# 自定义项写入配置文件appsettings.json中(如url和token)

最新推荐文章于 2025-05-09 11:46:31 发布

读书士子

最新推荐文章于 2025-05-09 11:46:31 发布

阅读量1.3k

点赞数

文章标签： c# json .net core

本文链接：https://blog.youkuaiyun.com/weixin_42060801/article/details/132576647

版权

本文介绍了如何在.NET项目中通过appsettings.json文件管理和动态配置API接口地址和令牌，以及如何在Startup.cs中注册配置，通过IOptions接口在类中注入和使用这些配置，实现代码解耦和灵活配置。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一、打开项目的 `appsettings.json` 文件，通常位于项目的根目录。

二、在 `appsettings.json` 文件中添加相应的配置项。可以使用类似下面的格式添加配置项：

{
  "ApiConfiguration": {
    "BaseApiUrl": "your_url_here",
    "Token": "your_token_here"
  },
  // 其他配置项...
}

三、在 `Startup.cs` 文件中的 `ConfigureServices` 方法中，注册配置项，并使其可供应用程序的其他部分访问。确保引用 `Microsoft.Extensions.Configuration` 和 `Microsoft.Extensions.Options` 命名空间。

using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;

namespace YourNamespace
{
    public class Startup
    {
        //...

        public void ConfigureServices(IServiceCollection services)
        {
            //...
             
                services.Configure<ApiConfiguration>
                    Configuration.GetSection("ApiConfiguration"));
            //...
        }
    }
}

四、创建一个包含配置项属性的类 `ApiConfiguration`，用于将配置项映射到实际的类属性。

public class ApiConfiguration
{
    public string BaseApiUrl { get; set; }
    public string Token { get; set; }
}

五、在所需使用配置文件的类中，如 `ApiDataProcessor` 类使用 `IOptions<ApiConfiguration>` 注入配置项，并将其作为构造函数参数。

public class ApiDataProcessor : BackgroundService
{
    private readonly ApiConfiguration _apiConfiguration;

    public ApiDataProcessor(IOptions<ApiConfiguration> apiConfigurationOptions)
    {
        _apiConfiguration = apiConfigurationOptions.Value;
    }

    //...
}

现在，就可以在 ApiDataProcessor 类（可替换为实际类）中使用 _apiConfiguration.BaseApiUrl 和 _apiConfiguration.Token 来访问配置项的值，而不是硬编码在代码中。这样的好处是，可以在不更改代码的情况下更改配置项的值。