Comment extraire une liste de appsettings.json en .net core

Question

J'ai un fichier appsettings.json qui ressemble à ceci :

{
    "someSetting": {
        "subSettings": [
            "one",
            "two",
            "three"
         ]
    }
}

Lorsque je construis ma configuration Root, et que je fais quelque chose comme config["someSetting:subSettings"] il renvoie null et les paramètres disponibles sont quelque chose comme ceci :

config["someSettings:subSettings:0"]

Existe-t-il un meilleur moyen de récupérer le contenu du fichier someSettings:subSettings comme une liste ?

Answer 1

En supposant que votre appsettings.json ressemble à ça :

{
  "foo": {
    "bar": [
      "1",
      "2",
      "3"
    ]
  }
}

Vous pouvez extraire les éléments de la liste comme suit :

Configuration.GetSection("foo:bar").Get<List<string>>()

Answer 2

Dans .NetCore, c'est ce que j'ai fait :

Configuration normale :

Dans votre appsettings.json, créez une section de configuration pour vos définitions personnalisées :

    "IDP": [
    {
      "Server": "asdfsd",
      "Authority": "asdfasd",
      "Audience": "asdfadf"
    },
    {
      "Server": "aaaaaa",
      "Authority": "aaaaaa",
      "Audience": "aaaa"
    }
  ]

Créez une classe pour modéliser les objets :

public class IDP
{
    public String Server { get; set; }
    public String Authority { get; set; }
    public String Audience { get; set; }

}

dans votre Démarrage -> ConfigureServices

services.Configure<List<IDP>>(Configuration.GetSection("IDP"));

Remarque : si vous devez accéder immédiatement à votre liste dans votre méthode ConfigureServices vous pouvez utiliser...

var subSettings = Configuration.GetSection("IDP").Get<List<IDP>>();

Puis dans votre contrôleur quelque chose comme ceci :

Public class AccountController: Controller
{
    private readonly IOptions<List<IDP>> _IDPs;
    public AccountController(IOptions<List<Defined>> IDPs)
    {
        _IDPs = IDPs;
    }
  ...
}

juste à titre d'exemple, je l'ai utilisé ailleurs dans le contrôleur ci-dessus comme ceci :

       _IDPs.Value.ForEach(x => {
            // do something with x
        });

Cas limite

Dans le cas où vous avez besoin de plusieurs configurations mais qu'elles ne peuvent pas être dans un tableau et que vous n'avez aucune idée du nombre de sous-configurations que vous aurez à un moment donné. Utilisez la méthode suivante.

appsettings.json

"IDP": {
    "0": {
      "Description": "idp01_test",
      "IDPServer": "https://intapi.somedomain.com/testing/idp01/v1.0",
      "IDPClient": "someapi",
      "Format": "IDP"
    },
    "1": {
      "Description": "idpb2c_test",
      "IDPServer": "https://intapi.somedomain.com/testing/idpb2c",
      "IDPClient": "api1",
      "Format": "IDP"
    },
    "2": {
      "Description": "MyApp",
      "Instance": "https://sts.windows.net/",
      "ClientId": "https://somedomain.com/12345678-5191-1111-bcdf-782d958de2b3",
      "Domain": "somedomain.com",
      "TenantId": "87654321-a10f-499f-9b5f-6de6ef439787",
      "Format": "AzureAD"
    }
  }

Modèle

public class IDP
{
    public String Description { get; set; }
    public String IDPServer { get; set; }
    public String IDPClient { get; set; }
    public String Format { get; set; }
    public String Instance { get; set; }
    public String ClientId { get; set; }
    public String Domain { get; set; }
    public String TenantId { get; set; }
}

Créer une extension pour l'objet Expando

public static class ExpandObjectExtension
    {
        public static TObject ToObject<TObject>(this IDictionary<string, object> someSource, BindingFlags bindingFlags = BindingFlags.Instance | BindingFlags.Public)
               where TObject : class, new()
        {
            Contract.Requires(someSource != null);
            TObject targetObject = new TObject();
            Type targetObjectType = typeof(TObject);

            // Go through all bound target object type properties...
            foreach (PropertyInfo property in
                        targetObjectType.GetProperties(bindingFlags))
            {
                // ...and check that both the target type property name and its type matches
                // its counterpart in the ExpandoObject
                if (someSource.ContainsKey(property.Name)
                    && property.PropertyType == someSource[property.Name].GetType())
                {
                    property.SetValue(targetObject, someSource[property.Name]);
                }
            }

            return targetObject;
        }
    }

ConfigureServices

var subSettings = Configuration.GetSection("IDP").Get<List<ExpandoObject>>();

var idx = 0;
foreach (var pair in subSettings)
{

    IDP scheme = ((ExpandoObject)pair).ToObject<IDP>();
    if (scheme.Format == "AzureAD")
    {
        // this is why I couldn't use an array, AddProtecedWebApi requires a path to a config section
        var section = $"IDP:{idx.ToString()}";
        services.AddProtectedWebApi(Configuration, section, scheme.Description);
        // ... do more stuff

    }
    idx++;
}

Answer 3

Vous pouvez utiliser le classeur de configuration pour obtenir une représentation de type fort des sources de configuration.

Voici un exemple tiré d'un test que j'ai écrit auparavant, j'espère que cela vous aidera :

    [Fact]
    public void BindList()
    {
        var input = new Dictionary<string, string>
        {
            {"StringList:0", "val0"},
            {"StringList:1", "val1"},
            {"StringList:2", "val2"},
            {"StringList:x", "valx"}
        };

        var configurationBuilder = new ConfigurationBuilder();
        configurationBuilder.AddInMemoryCollection(input);
        var config = configurationBuilder.Build();

        var list = new List<string>();
        config.GetSection("StringList").Bind(list);

        Assert.Equal(4, list.Count);

        Assert.Equal("val0", list[0]);
        Assert.Equal("val1", list[1]);
        Assert.Equal("val2", list[2]);
        Assert.Equal("valx", list[3]);
    }

La partie importante est l'appel à Bind .

Le test et d'autres exemples sont disponibles sur GitHub

Answer 4

var settingsSection = config.GetSection["someSettings:subSettings"];
var subSettings = new List<string>;

foreach (var section in settingsSection.GetChildren())
{
    subSettings.Add(section.Value);
}

Cela devrait vous donner les valeurs dont vous avez besoin, stockées dans le fichier subSettings

Je m'excuse d'avoir remis sur le tapis un sujet semi-ancien. J'ai eu du mal à trouver une réponse car un bon nombre de méthodes sont dépréciées, comme par exemple Get et GetValue . Cela devrait convenir si vous n'avez besoin que d'une solution simple sans le liant de configuration :)

Answer 5

Dans mon cas, la configuration

 services.Configure<List<ApiKey>>(Configuration.GetSection("ApiKeysList"));

n'a pas été chargé parce que les propriétés étaient en lecture seule et qu'il n'y avait pas de constructeur par défaut.

 **//not working** 
  public class ApiKey : IApiKey
    {
        public ApiKey(string key, string owner)
        {
            Key = key;
            OwnerName = owner;
        }
        public string Key { get;  }
        public string OwnerName { get;}
    } 

//Travail

    public class ApiKey : IApiKey
    {
        public ApiKey(){}//Added default constructor
        public ApiKey(string key, string owner)
        {
            Key = key;
            OwnerName = owner;
        }
        public string Key { get; set; }        //Added set property
        public string OwnerName { get; set; }  //Added set property
    }