NameValueCollectionをJSON文字列に変換する方法は？

Question

私は試した：

  NameValueCollection Data = new NameValueCollection();
  Data.Add("foo","baa");
  string json = new JavaScriptSerializer().Serialize(Data);

戻ります：["foo"]期待していた{"foo" : "baa"}これを行うにはどうすればよいですか？

Answer 1

NameValueCollectionはIDictionaryではないため、JavaScriptSerializerは直接期待どおりにシリアル化できません。最初に辞書に変換してから、シリアル化する必要があります。

更新：キーごとの複数の値に関する質問に続いて、nvc[key]への呼び出しは単にカンマで区切られて返されます。そうでない場合は、いつでもGetValuesを呼び出して、値を適切に処理する方法を決定できます。次のコードを更新して、考えられる1つの方法を示しました。

public class StackOverflow_7003740
{
    static Dictionary<string, object> NvcToDictionary(NameValueCollection nvc, bool handleMultipleValuesPerKey)
    {
        var result = new Dictionary<string, object>();
        foreach (string key in nvc.Keys)
        {
            if (handleMultipleValuesPerKey)
            {
                string[] values = nvc.GetValues(key);
                if (values.Length == 1)
                {
                    result.Add(key, values[0]);
                }
                else
                {
                    result.Add(key, values);
                }
            }
            else
            {
                result.Add(key, nvc[key]);
            }
        }

        return result;
    }

    public static void Test()
    {
        NameValueCollection nvc = new NameValueCollection();
        nvc.Add("foo", "bar");
        nvc.Add("multiple", "first");
        nvc.Add("multiple", "second");

        foreach (var handleMultipleValuesPerKey in new bool[] { false, true })
        {
            if (handleMultipleValuesPerKey)
            {
                Console.WriteLine("Using special handling for multiple values per key");
            }
            var dict = NvcToDictionary(nvc, handleMultipleValuesPerKey);
            string json = new JavaScriptSerializer().Serialize(dict);
            Console.WriteLine(json);
            Console.WriteLine();
        }
    }
}

Answer 2

NameValueCollectionをシリアル化する1つの方法は、最初にそれを辞書に変換してから、辞書をシリアル化することです。辞書に変換するには：

thenvc.AllKeys.ToDictionary(k => k, k => thenvc[k]);

変換を頻繁に行う必要がある場合は、NameValueCollectionへの拡張メソッドを作成することもできます。

public static class NVCExtender
{
    public static IDictionary<string, string> ToDictionary(
                                        this NameValueCollection source)
    {
        return source.AllKeys.ToDictionary(k => k, k => source[k]);
    }
}

そのため、次のように1行で変換を行うことができます。

NameValueCollection Data = new NameValueCollection();
Data.Add("Foo", "baa");

var dict = Data.ToDictionary();

次に、辞書をシリアル化できます。

var json = new JavaScriptSerializer().Serialize(dict);
// you get {"Foo":"baa"}

ただし、NameValueCollectionは1つのキーに対して複数の値を持つことができます。たとえば、次のとおりです。

NameValueCollection Data = new NameValueCollection();
Data.Add("Foo", "baa");
Data.Add("Foo", "again?");

これをシリアル化すると、{"Foo":"baa,again?"}が取得されます。

代わりにIDictionary<string, string[]>を生成するようにコンバーターを変更できます。

public static IDictionary<string, string[]> ToDictionary(
                                    this NameValueCollection source)
{
    return source.AllKeys.ToDictionary(k => k, k => source.GetValues(k));
}

したがって、次のようなシリアル化された値を取得できます：{"Foo":["baa","again?"]}。

Answer 3

辞書に多くのエントリを含めることを意図していない場合は、クラスを使用できます：System.Collections.Specialized.ListDictionary

Answer 4

完全を期すために、また質問が引き続き寄せられるため（たとえば here ）、Json.NETまたはDataContractJsonSerializerを使用している限り、 （ただしJavaScriptSerializerではない）、 アダプタパターン を使用して、IDictionary<string, string[]>アダプタでNameValueCollectionをラップできます。 、任意の辞書のシリアル化を完全にサポートするシリアライザーを使用してシリアル化します。

そのようなアダプターが次のようになったら：

public class NameValueCollectionDictionaryAdapter<TNameValueCollection> : IDictionary<string, string[]>
    where TNameValueCollection : NameValueCollection, new()
{
    readonly TNameValueCollection collection;

    public NameValueCollectionDictionaryAdapter() : this(new TNameValueCollection()) { }

    public NameValueCollectionDictionaryAdapter(TNameValueCollection collection)
    {
        this.collection = collection;
    }

    // Method instead of a property to guarantee that nobody tries to serialize it.
    public TNameValueCollection GetCollection() { return collection; }

    #region IDictionary<string,string[]> Members

    public void Add(string key, string[] value)
    {
        if (collection.GetValues(key) != null)
            throw new ArgumentException("Duplicate key " + key);
        if (value == null)
            collection.Add(key, null);
        else
            foreach (var str in value)
                collection.Add(key, str);
    }

    public bool ContainsKey(string key) { return collection.GetValues(key) != null; }

    public ICollection<string> Keys { get { return collection.AllKeys; } }

    public bool Remove(string key)
    {
        bool found = ContainsKey(key);
        if (found)
            collection.Remove(key);
        return found;
    }

    public bool TryGetValue(string key, out string[] value)
    {
        return (value = collection.GetValues(key)) != null;
    }

    public ICollection<string[]> Values
    {
        get
        {
            return new ReadOnlyCollectionAdapter<KeyValuePair<string, string[]>, string[]>(this, p => p.Value);
        }
    }

    public string[] this[string key]
    {
        get
        {
            var value = collection.GetValues(key);
            if (value == null)
                throw new KeyNotFoundException(key);
            return value;
        }
        set
        {
            Remove(key);
            Add(key, value);
        }
    }

    #endregion

    #region ICollection<KeyValuePair<string,string[]>> Members

    public void Add(KeyValuePair<string, string[]> item) { Add(item.Key, item.Value); }

    public void Clear() { collection.Clear(); }

    public bool Contains(KeyValuePair<string, string[]> item)
    {
        string[] value;
        if (!TryGetValue(item.Key, out value))
            return false;
        return EqualityComparer<string[]>.Default.Equals(item.Value, value); // Consistent with Dictionary<TKey, TValue>
    }

    public void CopyTo(KeyValuePair<string, string[]>[] array, int arrayIndex)
    {
        foreach (var item in this)
            array[arrayIndex++] = item;
    }

    public int Count { get { return collection.Count; } }

    public bool IsReadOnly { get { return false; } }

    public bool Remove(KeyValuePair<string, string[]> item)
    {
        if (Contains(item))
            return Remove(item.Key);
        return false;
    }

    #endregion

    #region IEnumerable<KeyValuePair<string,string[]>> Members

    public IEnumerator<KeyValuePair<string, string[]>> GetEnumerator()
    {
        foreach (string key in collection)
            yield return new KeyValuePair<string, string[]>(key, collection.GetValues(key));
    }

    #endregion

    #region IEnumerable Members

    System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() { return GetEnumerator(); }

    #endregion
}

public static class NameValueCollectionExtensions
{
    public static NameValueCollectionDictionaryAdapter<TNameValueCollection> ToDictionaryAdapter<TNameValueCollection>(this TNameValueCollection collection)
        where TNameValueCollection : NameValueCollection, new()
    {
        if (collection == null)
            throw new ArgumentNullException();
        return new NameValueCollectionDictionaryAdapter<TNameValueCollection>(collection);
    }
}

public class ReadOnlyCollectionAdapter<TIn, TOut> : CollectionAdapterBase<TIn, TOut, ICollection<TIn>>
{
    public ReadOnlyCollectionAdapter(ICollection<TIn> collection, Func<TIn, TOut> toOuter)
        : base(() => collection, toOuter)
    {
    }

    public override void Add(TOut item) { throw new NotImplementedException(); }

    public override void Clear() { throw new NotImplementedException(); }

    public override bool IsReadOnly { get { return true; } }

    public override bool Remove(TOut item) { throw new NotImplementedException(); }
}

public abstract class CollectionAdapterBase<TIn, TOut, TCollection> : ICollection<TOut> 
    where TCollection : ICollection<TIn>
{
    readonly Func<TCollection> getCollection;
    readonly Func<TIn, TOut> toOuter;

    public CollectionAdapterBase(Func<TCollection> getCollection, Func<TIn, TOut> toOuter)
    {
        if (getCollection == null || toOuter == null)
            throw new ArgumentNullException();
        this.getCollection = getCollection;
        this.toOuter = toOuter;
    }

    protected TCollection Collection { get { return getCollection(); } }

    protected TOut ToOuter(TIn inner) { return toOuter(inner); }

    #region ICollection<TOut> Members

    public abstract void Add(TOut item);

    public abstract void Clear();

    public virtual bool Contains(TOut item)
    {
        var comparer = EqualityComparer<TOut>.Default;
        foreach (var member in Collection)
            if (comparer.Equals(item, ToOuter(member)))
                return true;
        return false;
    }

    public void CopyTo(TOut[] array, int arrayIndex)
    {
        foreach (var item in this)
            array[arrayIndex++] = item;
    }

    public int Count { get { return Collection.Count; } }

    public abstract bool IsReadOnly { get; }

    public abstract bool Remove(TOut item);

    #endregion

    #region IEnumerable<TOut> Members

    public IEnumerator<TOut> GetEnumerator()
    {
        foreach (var item in Collection)
            yield return ToOuter(item);
    }

    #endregion

    #region IEnumerable Members

    IEnumerator IEnumerable.GetEnumerator() { return GetEnumerator(); }

    #endregion
}

次に、以下を実行するだけで、特定のNameValueCollection Dataに適合したものを構築できます。

var adapter = Data.ToDictionaryAdapter();

ノート：

• アダプターを使用すると、コピーされた辞書を作成するよりもパフォーマンスが向上する場合があり、辞書のシリアル化を完全にサポートするシリアライザーで適切に機能するはずです。

  アダプターは、NameValueCollectionを何らかの種類のIDictionaryを予期する他のコードと一緒に使用する場合にも役立つ可能性があります。これはアダプターパターンの基本的な利点です。

• つまり、JavaScriptSerializerはアダプターで使用できません。このシリアライザーは、IDictionary<TKey, TValue>を継承しないDictionary<TKey, TValue>を実装する任意の型をシリアル化できないためです。詳細については、JavaScriptSerializerで辞書をシリアル化するを参照してください。

• DataContractJsonSerializerを使用する場合、 データコントラクトサロゲート メカニズムを使用して、シリアル化グラフでNameValueCollectionをアダプターに置き換えることができます。

• Json.NETを使用する場合、次のような custom NameValueCollection を使用して、JsonConverterをアダプターに置き換えることができます。

  public class NameValueJsonConverter<TNameValueCollection> : JsonConverter
      where TNameValueCollection : NameValueCollection, new()
  {
      public override bool CanConvert(Type objectType)
      {
          return typeof(TNameValueCollection).IsAssignableFrom(objectType);
      }
  
      public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
      {
          if (reader.SkipComments().TokenType == JsonToken.Null)
              return null;
  
          // Reuse the existing NameValueCollection if present
          var collection = (TNameValueCollection)existingValue ?? new TNameValueCollection();
          var dictionaryWrapper = collection.ToDictionaryAdapter();
  
          serializer.Populate(reader, dictionaryWrapper);
  
          return collection;
      }
  
      public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
      {
          var collection = (TNameValueCollection)value;
          var dictionaryWrapper = new NameValueCollectionDictionaryAdapter<TNameValueCollection>(collection);
          serializer.Serialize(writer, dictionaryWrapper);
      }
  }
  
  public static partial class JsonExtensions
  {
      public static JsonReader SkipComments(this JsonReader reader)
      {
          while (reader.TokenType == JsonToken.Comment && reader.Read())
              ;
          return reader;
      }
  }
  

  使用できるもの次のように：

  string json = JsonConvert.SerializeObject(Data, Formatting.Indented, new NameValueJsonConverter<NameValueCollection>());
  

• NameValueCollectionは次のすべてをサポートします

  • 特定のキーのnull値。
  • 指定されたキーの複数の値（この場合 NameValueCollection.Item[String] は値のコンマ区切りリストを返します）;
  • 埋め込みコンマを含む単一の値（NameValueCollection.Item[String]を使用する場合、複数の値の場合と区別できません）。

  
  したがって、アダプターはIDictionary<string, string[]>ではなくIDictionary<string, string>を実装し、null値の配列を処理するように注意する必要があります。

サンプルフィドル（いくつかの基本的なユニットテストを含む）はこちら： https://dotnetfiddle.net/gVPSi7