向ApiKeyAuthorizeAttribute注入IOptions<>

基础概念

ApiKeyAuthorizeAttribute 是一个自定义的属性，通常用于ASP.NET Core应用程序中进行API密钥验证。IOptions<> 是ASP.NET Core中的一个接口，用于从配置文件（如appsettings.json）中读取配置选项。

类型与应用场景

类型：IOptions<> 是一个泛型接口，可以用于任何需要从配置文件中读取的设置。
应用场景：适用于需要在应用程序中读取配置选项的场景，特别是涉及到安全性和灵活性的配置，如API密钥、数据库连接字符串等。

示例代码

假设我们有一个ApiKeysOptions类来存储API密钥配置：

public class ApiKeysOptions
{
    public string Key1 { get; set; }
    public string Key2 { get; set; }
}

在appsettings.json中配置API密钥：

{
  "ApiKeys": {
    "Key1": "your-api-key-1",
    "Key2": "your-api-key-2"
  }
}

在Startup.cs中配置IOptions<>服务：

public void ConfigureServices(IServiceCollection services)
{
    services.Configure<ApiKeysOptions>(Configuration.GetSection("ApiKeys"));
    services.AddControllers();
}

创建ApiKeyAuthorizeAttribute并注入IOptions<>：

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
public class ApiKeyAuthorizeAttribute : TypeFilterAttribute
{
    public ApiKeyAuthorizeAttribute() : base(typeof(ApiKeyAuthorizeFilter))
    {
    }

    private class ApiKeyAuthorizeFilter : IAuthorizationFilter
    {
        private readonly ApiKeysOptions _apiKeysOptions;

        public ApiKeyAuthorizeFilter(IOptions<ApiKeysOptions> apiKeysOptions)
        {
            _apiKeysOptions = apiKeysOptions.Value;
        }

        public void OnAuthorization(AuthorizationFilterContext context)
        {
            // 获取请求中的API密钥并进行验证
            var apiKey = context.HttpContext.Request.Headers["X-API-Key"].ToString();

            if (apiKey != _apiKeysOptions.Key1 && apiKey != _apiKeysOptions.Key2)
            {
                context.Result = new UnauthorizedResult();
            }
        }
    }
}

遇到的问题及解决方法

问题：在注入IOptions<>时，可能会遇到配置未正确加载的问题。

原因：

配置文件路径或名称错误。
配置文件中的键名与代码中的属性名不匹配。
配置文件未被正确读取或解析。

解决方法：

检查appsettings.json文件的路径和名称是否正确。
确保配置文件中的键名与代码中的属性名完全匹配。
在Startup.cs中添加日志记录以验证配置文件是否被正确读取。

public void ConfigureServices(IServiceCollection services)
{
    var apiKeysSection = Configuration.GetSection("ApiKeys");
    services.Configure<ApiKeysOptions>(apiKeysSection);

    // 添加日志记录
    var apiKeys = apiKeysSection.Get<ApiKeysOptions>();
    Console.WriteLine($"API Keys: Key1={apiKeys.Key1}, Key2={apiKeys.Key2}");

    services.AddControllers();
}

通过以上步骤，可以确保IOptions<>正确注入并使用配置选项。