Azure Function调用带参数GET API时ID参数为空问题排查

问题描述 #

我正尝试实现一个Azure Function，该Function接收ID作为输入并根据该ID获取数据，核心逻辑是调用另一个.NET API来获取对应数据。但目前遇到无法传递ID参数的问题，每次传递的ID值都为空。

.NET API代码 #

[HttpGet]
[Route("{id:guid}")]
public async Task<IActionResult> GetContact([FromRoute] Guid id)
{
    var contact = await dbContext.Contacts.FindAsync(id);

    if (contact == null)
    {
        return NotFound();
    }

    return Ok(contact);
}

Azure Function代码 #

[FunctionName("GetSingleContact")]
public async Task<IActionResult> GetContact(
    [HttpTrigger(AuthorizationLevel.Anonymous, nameof(HttpMethods.Get), Route = null)] HttpRequest req,
    ILogger log)
{
    try
    {

        var client = _httpClientFactory.CreateClient();
        string id = req.Query["id"];//Null
        string requestBody = await new StreamReader(req.Body).ReadToEndAsync();
        dynamic data = JsonConvert.DeserializeObject(requestBody);
        id ??= data?.id;

        HttpResponseMessage httpResponseMessage = await client.GetAsync($"https://localhost:7209/api/Contacts/{id}");

        if (httpResponseMessage.StatusCode == System.Net.HttpStatusCode.OK)
        {
            var content = httpResponseMessage.Content;
            var data1 = await content.ReadAsStringAsync();
            return new OkObjectResult(data1);
        }

    }
    catch(Exception ex)
    {
        return new BadRequestObjectResult(ex.Message);
    }
    
    return new BadRequestObjectResult("Problem");
}

原因分析 #

• 你的Azure Function的HttpTrigger未配置路由参数，Route = null意味着仅支持通过查询字符串传递参数；如果调用Function时采用路由方式传ID（如/GetSingleContact/xxx-guid-xxx），就会读取不到值。
• GET请求通常没有请求体，你尝试从req.Body读取ID的逻辑基本不会生效，这也是ID始终为空的关键原因。

解决方案 #

方案1：配置路由参数，直接绑定ID #

修改HttpTrigger的Route属性，定义路由参数，并在方法参数中直接绑定该参数，无需手动解析请求：

[FunctionName("GetSingleContact")]
public async Task<IActionResult> GetContact(
    [HttpTrigger(AuthorizationLevel.Anonymous, "get", Route = "GetSingleContact/{id:guid}")] HttpRequest req,
    Guid id, // 直接绑定路由中的ID参数
    ILogger log)
{
    try
    {
        var client = _httpClientFactory.CreateClient();

        HttpResponseMessage httpResponseMessage = await client.GetAsync($"https://localhost:7209/api/Contacts/{id}");

        if (httpResponseMessage.StatusCode == System.Net.HttpStatusCode.OK)
        {
            var content = httpResponseMessage.Content;
            var data1 = await content.ReadAsStringAsync();
            return new OkObjectResult(data1);
        }
    }
    catch(Exception ex)
    {
        return new BadRequestObjectResult(ex.Message);
    }
    
    return new BadRequestObjectResult("Problem");
}

调用方式：通过路由传递ID，例如 http://<你的Function地址>/api/GetSingleContact/你的GUID值

方案2：保留默认路由，通过查询字符串传ID #

若坚持使用默认路由，需确保调用时通过查询字符串传递ID（如http://<你的Function地址>/api/GetSingleContact?id=你的GUID值），同时移除从请求体读取ID的无效逻辑：

[FunctionName("GetSingleContact")]
public async Task<IActionResult> GetContact(
    [HttpTrigger(AuthorizationLevel.Anonymous, "get", Route = null)] HttpRequest req,
    ILogger log)
{
    try
    {
        var client = _httpClientFactory.CreateClient();
        // 校验并获取查询字符串中的ID
        if (!Guid.TryParse(req.Query["id"], out Guid id))
        {
            return new BadRequestObjectResult("无效的ID格式");
        }

        HttpResponseMessage httpResponseMessage = await client.GetAsync($"https://localhost:7209/api/Contacts/{id}");

        if (httpResponseMessage.StatusCode == System.Net.HttpStatusCode.OK)
        {
            var content = httpResponseMessage.Content;
            var data1 = await content.ReadAsStringAsync();
            return new OkObjectResult(data1);
        }
    }
    catch(Exception ex)
    {
        return new BadRequestObjectResult(ex.Message);
    }
    
    return new BadRequestObjectResult("Problem");
}

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