如何在c#中将数组作为查询字符串的参数发送？

Question

我正在尝试使用自己编写的网页 API 获取一些数据。文档都是用 PHP 编写的。我正在看的例子是这样的：

$params = array(
    'id' => 1
    ,'data' => array(
        ,'email' => '[e-mail]'
    )

$url = "www.someapi.com/api?" . http_build_query( $params );

我正在使用C#的WebClient类，但是我不知道如何序列化数据参数：

WebClient wc = new WebClient();
wc.QueryString["id"] = "1";
wc.QueryString["data"] = // I have no idea.

string json = wc.DownloadString(apiUrl);

我尝试了几种不同的方式：

wc.QueryString["data"] = "email=[e-mail]";
wc.QueryString["data"] = Uri.EscapeDataString("data[email]=[e-mail]");
wc.QueryString["data"] = Uri.EscapeDataString("email[0]=[e-mail]");
wc.QueryString["data"] = Uri.EscapeDataString("email=[e-mail]");

当然，我没有在任何地方设置PHP来查看http_build_query()实际返回的内容。

- scottm

Answer 1

我终于理解了。我猜是因为发了这个问题，让我的大脑重新启动了。

以下是有效的解决方法：

wc.QueryString["data[email]"] = "[e-mail]";

- scottm

---

有没有想法动态地解决数组嵌套的问题？有没有C#版本相当于PHP的混乱代码？ - vojta

@vojta 你说的数组中嵌套数组是什么意思？你期望的键是什么？ - zastrowm

Answer 2

请注意，这个问题与本回答非常相关，因此我也将这个类作为那里的一个答案。该答案将接收此类的任何更新。

据我所知，没有内置的方法可以实现此功能。但是，您可以创建自己的类。

所以我这样做了：

/// <summary>
///  Helps up build a query string by converting an object into a set of named-values and making a
///  query string out of it.
/// </summary>
public class QueryStringBuilder
{
  private readonly List<KeyValuePair<string, object>> _keyValuePairs
    = new List<KeyValuePair<string, object>>();

  /// <summary> Builds the query string from the given instance. </summary>
  public static string BuildQueryString(object queryData, string argSeperator = "&")
  {
    var encoder = new QueryStringBuilder();
    encoder.AddEntry(null, queryData, allowObjects: true);

    return encoder.GetUriString(argSeperator);
  }

  /// <summary>
  ///  Convert the key-value pairs that we've collected into an actual query string.
  /// </summary>
  private string GetUriString(string argSeperator)
  {
    return String.Join(argSeperator,
                       _keyValuePairs.Select(kvp =>
                                             {
                                               var key = Uri.EscapeDataString(kvp.Key);
                                               var value = Uri.EscapeDataString(kvp.Value.ToString());
                                               return $"{key}={value}";
                                             }));
  }

  /// <summary> Adds a single entry to the collection. </summary>
  /// <param name="prefix"> The prefix to use when generating the key of the entry. Can be null. </param>
  /// <param name="instance"> The instance to add.
  ///  
  ///  - If the instance is a dictionary, the entries determine the key and values.
  ///  - If the instance is a collection, the keys will be the index of the entries, and the value
  ///  will be each item in the collection.
  ///  - If allowObjects is true, then the object's properties' names will be the keys, and the
  ///  values of the properties will be the values.
  ///  - Otherwise the instance is added with the given prefix to the collection of items. </param>
  /// <param name="allowObjects"> true to add the properties of the given instance (if the object is
  ///  not a collection or dictionary), false to add the object as a key-value pair. </param>
  private void AddEntry(string prefix, object instance, bool allowObjects)
  {
    var dictionary = instance as IDictionary;
    var collection = instance as ICollection;

    if (dictionary != null)
    {
      Add(prefix, GetDictionaryAdapter(dictionary));
    }
    else if (collection != null)
    {
      Add(prefix, GetArrayAdapter(collection));
    }
    else if (allowObjects)
    {
      Add(prefix, GetObjectAdapter(instance));
    }
    else
    {
      _keyValuePairs.Add(new KeyValuePair<string, object>(prefix, instance));
    }
  }

  /// <summary> Adds the given collection of entries. </summary>
  private void Add(string prefix, IEnumerable<Entry> datas)
  {
    foreach (var item in datas)
    {
      var newPrefix = String.IsNullOrEmpty(prefix)
        ? item.Key
        : $"{prefix}[{item.Key}]";

      AddEntry(newPrefix, item.Value, allowObjects: false);
    }
  }

  private struct Entry
  {
    public string Key;
    public object Value;
  }

  /// <summary>
  ///  Returns a collection of entries that represent the properties on the object.
  /// </summary>
  private IEnumerable<Entry> GetObjectAdapter(object data)
  {
    var properties = data.GetType().GetProperties();

    foreach (var property in properties)
    {
      yield return new Entry()
                   {
                     Key = property.Name,
                     Value = property.GetValue(data)
                   };
    }
  }

  /// <summary>
  ///  Returns a collection of entries that represent items in the collection.
  /// </summary>
  private IEnumerable<Entry> GetArrayAdapter(ICollection collection)
  {
    int i = 0;
    foreach (var item in collection)
    {
      yield return new Entry()
                   {
                     Key = i.ToString(),
                     Value = item,
                   };
      i++;
    }
  }

  /// <summary>
  ///  Returns a collection of entries that represent items in the dictionary.
  /// </summary>
  private IEnumerable<Entry> GetDictionaryAdapter(IDictionary collection)
  {
    foreach (DictionaryEntry item in collection)
    {
      yield return new Entry()
                   {
                     Key = item.Key.ToString(),
                     Value = item.Value,
                   };
    }
  }
}

像这样：

// Age=19&Name=John%26Doe&Values%5B0%5D=1&Values%5B1%5D=2&Values%5B2%5D%5Bkey1%5D=value1&Values%5B2%5D%5Bkey2%5D=value2
QueryStringBuilder.BuildQueryString(new
       {
         Age = 19,
         Name = "John&Doe",
         Values = new object[]
                  {
                    1,
                    2,
                    new Dictionary<string, string>()
                    {
                      { "key1", "value1" },
                      { "key2", "value2" },
                    }
                  },
       });

// 0=1&1=2&2%5B0%5D=one&2%5B1%5D=two&2%5B2%5D=three&3%5Bkey1%5D=value1&3%5Bkey2%5D=value2
QueryStringBuilder.BuildQueryString(new object[]
       {
         1,
         2,
         new object[] { "one", "two", "three" },
         new Dictionary<string, string>()
         {
           { "key1", "value1" },
           { "key2", "value2" },
         }
       }
  );

- zastrowm