Как установить тайм-аут соединения с OkHttp

173

Я разрабатываю приложение, используя библиотеку OkHttp, и моя проблема в том, что я не могу найти, как установить время ожидания подключения и время сокета.

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder().url(url).build();

Response response = client.newCall(request).execute();
kelvincer
источник
2
Выбранный вами ответ больше не действителен. Может быть, вам следует отредактировать вопрос, чтобы указать версию ohttp.
Они в

Ответы:

324

Вы просто должны сделать это

OkHttpClient client = new OkHttpClient();
client.setConnectTimeout(15, TimeUnit.SECONDS); // connect timeout
client.setReadTimeout(15, TimeUnit.SECONDS);    // socket timeout

Request request = new Request.Builder().url(url).build();
Response response = client.newCall(request).execute();

Имейте в виду , что значение , установленное в setReadTimeoutэто один используется в setSoTimeoutна Socketвнутренне вOkHttp Connection классе.

Отсутствие тайм-аута для OkHttpClientэквивалента равнозначно установке значения 0on setConnectTimeoutили setReadTimeoutприводит к тому, что тайм-аут вообще не будет. Описание можно найти здесь .

Как уже упоминалось @marceloquinta в комментариях setWriteTimeoutтакже может быть установлен.

Начиная с версии 2.5.0, время ожидания чтения / записи / подключения установлено по умолчанию на 10 секунд, как указано @ChristerNordvik. Это можно увидеть здесь .

Начиная с OkHttp3 теперь можно делать это через Builder, вот так

client = new OkHttpClient.Builder()
        .connectTimeout(10, TimeUnit.SECONDS)
        .writeTimeout(10, TimeUnit.SECONDS)
        .readTimeout(30, TimeUnit.SECONDS)
        .build();

Вы также можете посмотреть рецепт здесь .

Мигель Лавин
источник
6
Есть ли способ установить разные таймауты для каждого запроса (у каждого запроса один и тот же статический клиент)?
StErMi
3
Вы можете установить конкретное время ожидания для каждого запроса: Вот некоторая информация: github.com/square/okhttp/wiki/Recipes
Tobliug
3
Не забывайте тайм-аут ЗАПИСИ: client.setWriteTimeout (10, TimeUnit.SECONDS);
Marceloquinta
7
@MiguelLavigne Просто к вашему сведению, OkHttp изменился в 2.5.0, чтобы иметь тайм-аут по умолчанию 10 секунд.
Кристер Нордвик
5
Устаревший ответ
devDeejay
143

Для охттп3 это немного изменилось.

Теперь вы устанавливаете время, используя компоновщик, а не сеттеры, например так:

OkHttpClient client = new OkHttpClient.Builder()
        .connectTimeout(10, TimeUnit.SECONDS)
        .writeTimeout(10, TimeUnit.SECONDS)
        .readTimeout(30, TimeUnit.SECONDS)
        .build();

Дополнительную информацию можно найти в их вики: https://github.com/square/okhttp/blob/b3dcb9b1871325248fba917458658628c44ce8a3/docs/recipes.md#timeouts-kt-java

Kaizie
источник
12

Для Retrofit Retrofit: 2.0.0-бета4 код выглядит следующим образом

OkHttpClient client = new OkHttpClient.Builder()
        .addInterceptor(logging)
        .connectTimeout(30, TimeUnit.SECONDS)
        .readTimeout(30, TimeUnit.SECONDS)
        .writeTimeout(30, TimeUnit.SECONDS)
        .build();

Retrofit retrofit = new Retrofit.Builder()
        .baseUrl("http://api.yourapp.com/")
        .addConverterFactory(GsonConverterFactory.create())
        .client(client)
        .build();
Сэм
источник
9

Для Retrofit 2.0.0-beta1 или beta2 код выглядит следующим образом

    OkHttpClient client = new OkHttpClient();

    client.setConnectTimeout(30, TimeUnit.SECONDS);
    client.setReadTimeout(30, TimeUnit.SECONDS);
    client.setWriteTimeout(30, TimeUnit.SECONDS);

    Retrofit retrofit = new Retrofit.Builder()
            .baseUrl("http://api.yourapp.com/")
            .addConverterFactory(GsonConverterFactory.create())
            .client(client)
            .build();
xaxist
источник
7
//add in gradle and sync
compile 'com.squareup.okhttp3:okhttp:3.2.0'
compile 'com.google.code.gson:gson:2.6.2'

import okhttp3.OkHttpClient;
import okhttp3.OkHttpClient.Builder;


Builder b = new Builder();
b.readTimeout(200, TimeUnit.MILLISECONDS);
b.writeTimeout(600, TimeUnit.MILLISECONDS);
// set other properties

OkHttpClient client = b.build();
Мухаммед Набиль
источник
5

Теперь это изменилось. Заменить .Builder()на.newBuilder()

Начиная с : 3.9.0 код выглядит следующим образом:

OkHttpClient okHttpClient = new OkHttpClient()
    .newBuilder()
    .connectTimeout(10,TimeUnit.SECONDS)
    .writeTimeout(10,TimeUnit.SECONDS)
    .readTimeout(30,TimeUnit.SECONDS)
    .build();
Лео
источник
5

Охтп версия: 3.11.0или выше

из исходника охтпп

/**
 * Sets the default connect timeout for new connections. A value of 0 means no timeout,
 * otherwise values must be between 1 and {@link Integer#MAX_VALUE} when converted to
 * milliseconds.
 *
 * <p>The connectTimeout is applied when connecting a TCP socket to the target host.
 * The default value is 10 seconds.
 */
public Builder connectTimeout(long timeout, TimeUnit unit) {
  connectTimeout = checkDuration("timeout", timeout, unit);
  return this;
}

unit может быть любое значение ниже

TimeUnit.NANOSECONDS
TimeUnit.MICROSECONDS
TimeUnit.MILLISECONDS
TimeUnit.SECONDS
TimeUnit.MINUTES
TimeUnit.HOURS
TimeUnit.DAYS

пример кода

OkHttpClient client = new OkHttpClient.Builder()
        .connectTimeout(5000, TimeUnit.MILLISECONDS)/*timeout: 5 seconds*/
        .build();

String url = "https://www.google.com";
Request request = new Request.Builder()
        .url(url)
        .build();

try {
    Response response = client.newCall(request).execute();
} catch (IOException e) {
    e.printStackTrace();
}

обновленный

Я добавил новый API в ohttp из версии 3.12.0, вы можете установить таймаут так:

OkHttpClient client = new OkHttpClient.Builder()
        .connectTimeout(Duration.ofSeconds(5))/*timeout: 5 seconds*/
        .build();

ПРИМЕЧАНИЕ. Для этого требуется API 26+, поэтому, если вы поддерживаете более старые версии Android, продолжайте использовать (5, TimeUnit.SECONDS).

shellhub
источник
4

вот так:

//New Request
        HttpLoggingInterceptor logging = new HttpLoggingInterceptor();
        logging.setLevel(HttpLoggingInterceptor.Level.BASIC);
        final OkHttpClient client = new OkHttpClient.Builder()
                .addInterceptor(logging)
                .connectTimeout(30, TimeUnit.SECONDS)
                .readTimeout(30, TimeUnit.SECONDS)
                .writeTimeout(30, TimeUnit.SECONDS)
                .build();
Joolah
источник
4

это сработало для меня ... с https://github.com/square/okhttp/issues/3553

OkHttpClient client = new OkHttpClient.Builder()
        .connectTimeout(10, TimeUnit.SECONDS)
        .readTimeout(10, TimeUnit.SECONDS)
        .writeTimeout(10, TimeUnit.SECONDS)
        .retryOnConnectionFailure(false) <-- not necessary but useful!
        .build();
rHenderson
источник
2

Если вы хотите настроить конфигурацию, то используйте приведенную ниже методологию создания OKhttpclient, а затем добавьте компоновщик поверх нее.

private final OkHttpClient client = new OkHttpClient();

// Copy to customize OkHttp for this request.
    OkHttpClient client1 = client.newBuilder()
        .readTimeout(500, TimeUnit.MILLISECONDS)
        .build();
    try (Response response = client1.newCall(request).execute()) {
      System.out.println("Response 1 succeeded: " + response);
    } catch (IOException e) {
      System.out.println("Response 1 failed: " + e);
    }
сандхья муругесан
источник
1

Вы можете установить тайм-аут вызова, чтобы охватить весь цикл от разрешения DNS, соединения, записи тела запроса, обработки сервера и чтения тела ответа.

val client = OkHttpClient().newBuilder().callTimeout(CALL_TIMEOUT_IN_MINUTES, TimeUnit.MINUTES).build()
ChaturaM
источник