ASP.NET Core Options pattern with name split by single underscore

Question

I am trying to load my app settings with ASP.NET Core Options pattern.

The appsettings.json contains:

{
  "TEst": "hello",
  "TEST_ABC": "2" 
}

POCO class:

public class AppSetting
{
    public string Test { get; set; }

    public string TestAbc { get; set; }
}

Bind to configuration:

services.Configure<AppSetting>(Configuration);

While access AppSetting instance in controller, I can only get config Test as hello. TestAbc is set to null.

It seems Options pattern couldn't convert this kind of naming configuration, is it possible by any other means to achieve this?

TestAbc and TEST_ABC Are two different names, they have to match — Train
– Train, Commented Sep 3, 2019 at 14:17
@RyanWilson well, I am trying to not do that workaround, as it's not appropriate naming for property in C#. — Jerry Bian
– Jerry Bian, Commented Sep 3, 2019 at 14:17
@Train Yes, just looking for any solution allow that mismatch :) — Jerry Bian
– Jerry Bian, Commented Sep 3, 2019 at 14:18
You would need to tell the framework how to deal with the underscore, you could probably used [JsonProperty("TEST_ABC")] attribute for example. — DavidG
– DavidG, Commented Sep 3, 2019 at 14:19

Vladislav Borovikov · Accepted Answer · 2021-09-13 13:10:38Z

7

Starting with .NET 6.0 Preview 7 you can use ConfigurationKeyNameAttribute class.

[ConfigurationKeyName("TEST_ABC")]
public string TestAbc { get; set; }

answered Sep 13, 2021 at 13:10

Vladislav Borovikov

1271 silver badge7 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Chris Pratt · Accepted Answer · 2019-09-03 15:20:44Z

5

The only way to have it done automatically would be to name your property with the underscore (Test_Abc). Short of that, you can specify the mapping manually:

services.Configure<AppSettings>(o => 
{
    o.TestAbc = Configuration["TEST_ABC"];
    // etc.
});

@DavidG's comment about using [JsonProperty] may work. I've never tried that in the context of configuration. However, it will only work, if it works at all, when using the JSON config provider. If you later need to satisfy this via an environment variable, for example, you're out of luck. As such, I would stick with a more universally applicable solution than that.

answered Sep 3, 2019 at 15:20

Chris Pratt

240k37 gold badges414 silver badges468 bronze badges

Collectives™ on Stack Overflow

ASP.NET Core Options pattern with name split by single underscore

2 Answers 2

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related