如何在ConfigureServices方法中获取IOptions或将IOptions传递给扩展方法?

时间:2018-09-10 13:02:42

标签: asp.net-web-api asp.net-core .net-core asp.net-core-2.0

我正在开发ASP .NET Core Web API 2.1应用程序。

我将JWT身份验证服务添加为静态类中的扩展方法:

 public static class AuthenticationMiddleware
    {
        public static IServiceCollection AddJwtAuthentication(this IServiceCollection services, string issuer, string key)
        {
            services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
                .AddJwtBearer(options =>
                {
                    options.TokenValidationParameters = new TokenValidationParameters
                    {
                        // validate the server that created that token
                        ValidateIssuer = true,
                        // ensure that the recipient of the token is authorized to receive it
                        ValidateAudience = true,
                        // check that the token is not expired and that the signing key of the issuer is valid
                        ValidateLifetime = true,
                        // verify that the key used to sign the incoming token is part of a list of trusted keys
                        ValidateIssuerSigningKey = true,
                        ValidIssuer = issuer,
                        ValidAudience = issuer,
                        IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(key))
                    };
                });

            return services;
        }
    }
我在Startup类的ConfigureServices方法中使用的

是这样的:

public void ConfigureServices(IServiceCollection services)
        {
            // adding some services here

            services.AddJwtAuthentication(Configuration["Jwt:Issuer"], Configuration["Jwt:Key"]);

            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);           
        }

现在,我需要使用IOptions模式从appsettings.json获取JWT身份验证数据

如何在ConfigureServices方法中获取IOptions以将颁发者和密钥传递给扩展方法?还是如何将IOptions传递给扩展方法?

3 个答案:

答案 0 :(得分:5)

要将数据从appsettings.json绑定到Model,可以按照以下步骤操作:

  1. Appsettings.json内容

    {
    "Logging": {
     "IncludeScopes": false,
     "LogLevel": {
        "Default": "Warning"
           }
     },      
     "JWT": {
          "Issuer": "I",
          "Key": "K"
        }
     }
    
  2. JWT选项

    public class JwtOptions
    {
        public string Issuer { get; set; }
        public string Key { get; set; }
     }
    
  3. Startup.cs

        public void ConfigureServices(IServiceCollection services)
    {
        services.Configure<JwtOptions>(Configuration.GetSection("JWT"));
        var serviceProvider = services.BuildServiceProvider();
        var opt = serviceProvider.GetRequiredService<IOptions<JwtOptions>>().Value;
        services.AddJwtAuthentication(opt.Issuer, opt.Key);
        services.AddMvc();
    }
    
  4. 还有一个选项可以直接传递JwtOptions

        public void ConfigureServices(IServiceCollection services)
    {
        services.Configure<JwtOptions>(Configuration.GetSection("JWT"));
        var serviceProvider = services.BuildServiceProvider();
        var opt = serviceProvider.GetRequiredService<IOptions<JwtOptions>>().Value;
        services.AddJwtAuthentication(opt);
    
        services.AddMvc();
    }
    
  5. 更改扩展方法。

        public static IServiceCollection AddJwtAuthentication(this IServiceCollection services, JwtOptions opt)
    

答案 1 :(得分:2)

另一个选择是将配置绑定到扩展名为Bind()的类。 (IMO比IOptions更干净)

public class JwtKeys
{
    public string Issuer { get; set; }
    public string Key { get; set; }
}

public void ConfigureServices(IServiceCollection services)
{
    var jwtKeys = new JwtKeys();
    Configuration.GetSection("JWT").Bind(JwtKeys);

    services.AddJwtAuthentication(jwtKeys);
}

public static IServiceCollection AddJwtAuthentication(this IServiceCollection services, JwtKeys jwtKeys)
{....}

然后,如果您需要在解决方案中的其他位置使用JwtKeys设置,只需在集合上注册该类,然后将其注入到需要的地方

services.AddSingleton(jwtKeys);

答案 2 :(得分:1)

您可以像这样在Startup类的DI容器中添加选项:

public class JwtOptions
{
    public string Issuer { get; set; }
    public string Key { get; set; }

}

public void ConfigureService(IServiceCollection services)
{
    services.AddOptions();
    services.Configure<JwtOptions>(Configuration.GetSection("Jwt"));
}

现在,您可以在配置阶段或扩展方法中使用此选项:

public void Configure(IApplicationBuilder app)
{
    var options = app.ApplicationServices.GetService<IOptions<JwtOptions>();
    // write your own code
}