使用PTV Geocoding API时，IEnumerable<string>参数引发请求异常的排查

我正在用C#/Visual Studio 2019评估PTV Developer的地理编码API及其他接口，已经通过OpenAPI生成了客户端类，能成功调用SearchPlacesByTextAsync接口并传入必填参数。但当尝试使用categoryFilter（IEnumerable<string>类型）这类可选参数时出现错误，我用List<string>构建该参数，崩溃原因是什么？该如何添加一个或多个分类？错误似乎出在OpenAPI工具链生成的源代码里。

调用代码 #

private void button1_Click(object sender, EventArgs e)
{
    try
    {
        button1.BackColor = System.Drawing.Color.Yellow;
        button1.Update();
        //
        List<string> country = new List<string>();
        if (tbxCountry.Text != "")
            country.AddRange(tbxCountry.Text.Split(','));
        List<string> category = new List<string>();
        if (tbxCategoryFilter.Text != "")
            category.AddRange(tbxCategoryFilter.Text.Split(','));

        string language = (tbxLanguage.Text != "") ? tbxLanguage.Text : null;
        PlacesSearchResult result = svcGeocoding.SearchPlacesByTextAsync(tbxText.Text, category, country, language).Result;
        dataGridView1.DataSource = result.Places
            .OrderBy(o => o.Name)
            .Select((p, i) => new
            {
                i,
                p.Name,
                p.Address.CountryName,
                p.Address.State,
                p.Address.Province,
                p.Address.PostalCode,
                p.Address.City,
                p.Address.District,
                p.Address.Subdistrict,
                p.Address.Street,
                p.Address.HouseNumber,
                p.FormattedAddress,
                CategoryIds = (p.CategoryIds != null) ? String.Join(",",p.CategoryIds) : null,
                p.Quality.TotalScore,
                ref_Longitude = p.ReferencePosition.Longitude.ToString(coord_tostring),
                ref_Latitude = p.ReferencePosition.Latitude.ToString(coord_tostring),
                road_Longitude = p.RoadAccessPosition.Longitude.ToString(coord_tostring),
                road_Latitude = p.RoadAccessPosition.Latitude.ToString(coord_tostring)
            }).ToArray();
        //
        button1.BackColor = System.Drawing.Color.LimeGreen;
        button1.Update();

    }
    catch (Exception ex)
    {
        button1.BackColor = System.Drawing.Color.OrangeRed;
        button1.Update();
        MessageBox.Show(ex.Message, ex.GetType().ToString());
    }
}

崩溃原因及解决办法 #

• 空集合传递问题：当输入框为空时，你创建了空List<string>并传入，但OpenAPI生成的客户端通常期望可选参数为null而非空集合。空集合会被解析成无效的查询参数（如categoryFilter=&categoryFilter=），触发服务端或客户端报错。
• 分类ID格式错误：PTV Developer的分类ID是特定规范编码（比如PIP.GasStation），如果输入的分类值不符合要求，服务端会返回错误，而生成的客户端可能未妥善处理该异常。
• 异步调用阻塞问题：用.Result阻塞异步调用，在WinForms环境下容易引发死锁或上下文异常。

修复步骤

1. 传递null而非空集合
   无过滤条件时将参数设为null，避免空集合导致的无效参数：

   List<string> category = null;
   if (!string.IsNullOrEmpty(tbxCategoryFilter.Text))
       category = tbxCategoryFilter.Text.Split(',').ToList();
   

   同理处理country参数。

2. 验证分类ID合法性
   确保输入的分类ID符合PTV Developer官方规范，从官方文档获取合法分类值，避免输入无效字符串。

3. 正确处理异步调用
   将按钮方法改为异步，用await替代.Result，避免死锁：

   private async void button1_Click(object sender, EventArgs e)
   {
       try
       {
           button1.BackColor = System.Drawing.Color.Yellow;
           button1.Update();
   
           List<string> country = null;
           if (!string.IsNullOrEmpty(tbxCountry.Text))
               country = tbxCountry.Text.Split(',').ToList();
           List<string> category = null;
           if (!string.IsNullOrEmpty(tbxCategoryFilter.Text))
               category = tbxCategoryFilter.Text.Split(',').ToList();
   
           string language = string.IsNullOrEmpty(tbxLanguage.Text) ? null : tbxLanguage.Text;
           PlacesSearchResult result = await svcGeocoding.SearchPlacesByTextAsync(tbxText.Text, category, country, language);
           // 后续DataGridView绑定代码保持不变
       }
       catch (Exception ex)
       {
           // 异常处理代码保持不变
       }
   }
   

4. 检查生成的客户端代码
   查看SearchPlacesByTextAsync的实现逻辑，确认它对IEnumerable<string>参数的处理。如果生成的代码会将空集合序列化为无效参数，可手动修改客户端代码，在参数为空时跳过该查询参数的生成。

内容的提问来源于stack exchange，提问作者Bernd Welter