Refit库如何设置超时时间

Question

我在我的 Xamarin 应用程序中使用 Refit 库，我想为请求设置 10 秒超时。改装中有什么办法可以做到这一点吗？

接口：

interface IDevice
{
  [Get("/app/device/{id}")]
  Task<Device> GetDevice(string id, [Header("Authorization")] string authorization);
}

调用API

var device = RestService.For<IDevice>("http://localhost");              
var dev = await device.GetDevice("15e2a691-06df-4741-b26e-87e1eecc6bd7", "Bearer OAUTH_TOKEN");

Answer 1

接受的答案是对单个请求强制执行超时的正确方法，但如果您希望所有请求都有一个一致的超时值，则可以传递预配置的

HttpClient

及其

Timeout

属性集：

var api = RestService.For<IDevice>(new HttpClient 
{
    BaseAddress = new Uri("http://localhost"),
    Timeout = TimeSpan.FromSeconds(10)
});

这是一个示例项目。

Answer 2

我终于在Refit中找到了设置请求超时的方法。我用过

CancelationToken

。这是添加后修改后的代码

CancelationToken

接口：

interface IDevice
{
  [Get("/app/device/{id}")]
  Task<Device> GetDevice(string id, [Header("Authorization")] string authorization, CancellationToken cancellationToken);
}

调用API：

var device = RestService.For<IDevice>("http://localhost");    
CancellationTokenSource tokenSource = new CancellationTokenSource();
tokenSource.CancelAfter(10000); // 10000 ms
CancellationToken token = tokenSource.Token;          
var dev = await device.GetDevice("15e2a691-06df-4741-b26e-87e1eecc6bd7", "Bearer OAUTH_TOKEN", token);

它对我来说工作正常。我不知道这是否是正确的方法。如果有错误，请指出正确的方法。

Answer 3

我将提供我自己的版本：

var device = RestService.For<IDevice>("http://localhost");
var dev = await device.GetDevice("15e2a691-06df-4741-b26e-87e1eecc6bd7", "Bearer OAUTH_TOKEN").WaitAsync(TimeSpan.FromSeconds(10));

Answer 4

另一种解决方案：Refit 中的一个测试使用了这种方法。在 nuget 中添加 System.Reactive.Linq。 然后在接口规范中：

interface IDevice
{
    [Get("/app/device/{id}")]
    IObservable<Device> GetDevice(string id, [Header("Authorization")] string authorization);
}

在 API 中：

try
{
  await device.GetDevice("your_parameters_here").Timeout(TimeSpan.FromSeconds(10));
}
catch(System.TimeoutException e)
{
  Console.WriteLine("Timeout: " + e.Message);
}

---

+1 解决方案来自这里：

为您的任务创建扩展方法：

public static class TaskExtensions
{
    public static async Task<TResult> TimeoutAfter<TResult>(this Task<TResult> task, TimeSpan timeout)
    {

        using (var timeoutCancellationTokenSource = new CancellationTokenSource())
        {

            var completedTask = await Task.WhenAny(task, Task.Delay(timeout, timeoutCancellationTokenSource.Token));
            if (completedTask == task)
            {
                timeoutCancellationTokenSource.Cancel();
                return await task;  // Very important in order to propagate exceptions
            }
            else
            {
                throw new TimeoutException("The operation has timed out.");
            }
        }
    }
}

可以使用

Task<Device>

返回值来离开界面。在 API 中：

try
{
  await _server.ListGasLines().TimeoutAfter(TimeSpan.FromSeconds(10));
}
catch(System.TimeoutException e)
{
  Console.WriteLine("Timeout: " + e.Message);
}