Jak ustawić limit czasu połączenia za pomocą OkHttp

173

Tworzę aplikację przy użyciu biblioteki OkHttp i nie mogę znaleźć sposobu ustawienia limitu czasu połączenia i limitu czasu gniazda.

OkHttpClient client = new OkHttpClient();

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

Response response = client.newCall(request).execute();
kelvincer
źródło
2
Wybrana odpowiedź jest już nieaktualna. Może powinieneś edytować pytanie, aby określić wersję okhttp.
Theyouthis

Odpowiedzi:

324

Po prostu musisz to zrobić

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();

Należy pamiętać, że wartość zadana w setReadTimeoutjedną używany w setSoTimeoutsprawie Socketwewnętrznie wOkHttp Connection .

Brak ustawienia limitu czasu OkHttpClientjest równoznaczne z ustawieniem wartości 0on setConnectTimeoutlub setReadTimeouti nie spowoduje żadnego limitu czasu. Opis można znaleźć tutaj .

Jak wspomniałem @marceloquinta w komentarzach setWriteTimeoutmożna również ustawić.

Począwszy od wersji 2.5.0 wartości limitu czasu odczytu / zapisu / połączenia są domyślnie ustawione na 10 sekund, jak wspomniano w @ChristerNordvik. Można to zobaczyć tutaj .

Od OkHttp3 można to teraz zrobić za pomocą Buildera w ten sposób

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

Możesz również wyświetlić przepis tutaj .

Miguel Lavigne
źródło
6
Czy istnieje sposób, aby ustawić ten limit czasu inny dla każdego żądania (każde żądanie ma tego samego klienta statycznego)?
StErMi
3
Możesz ustawić określony limit czasu dla każdego żądania: Oto kilka informacji: github.com/square/okhttp/wiki/Recipes
Tobliug
3
Nie zapomnij o przekroczeniu limitu czasu WRITE: client.setWriteTimeout (10, TimeUnit.SECONDS);
marceloquinta
7
@MiguelLavigne Just FYI, OkHttp zmieniło się w 2.5.0, aby mieć domyślny limit czasu wynoszący 10 sekund.
Christer Nordvik
5
Nieaktualna odpowiedź
devDeejay
143

W przypadku okhttp3 to się nieco zmieniło.

Teraz ustawiasz czasy za pomocą kreatora, a nie ustawiaczy, w ten sposób:

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

Więcej informacji można znaleźć na ich wiki: https://github.com/square/okhttp/blob/b3dcb9b1871325248fba917458658628c44ce8a3/docs/recipes.md#timeouts-kt-java

Kaizie
źródło
12

W przypadku modernizacji typu Retrofit: 2.0.0-beta4 kod wygląda następująco

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();
Sam
źródło
9

W przypadku Retrofit 2.0.0-beta1 lub beta2 kod wygląda następująco

    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
źródło
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();
Mohammad nabil
źródło
5

To się teraz zmieniło. wymienić .Builder()z.newBuilder()

Od okhttp: 3.9.0 kod wygląda następująco:

OkHttpClient okHttpClient = new OkHttpClient()
    .newBuilder()
    .connectTimeout(10,TimeUnit.SECONDS)
    .writeTimeout(10,TimeUnit.SECONDS)
    .readTimeout(30,TimeUnit.SECONDS)
    .build();
Lew
źródło
5

wersja okhttp:3.11.0 lub nowsza

z kodu źródłowego okhttp

/**
 * 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 może mieć dowolną wartość poniżej

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

przykładowy kod

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();
}

Zaktualizowano

Dodałem nowy api do okhttp z wersji 3.12.0, możesz ustawić limit czasu w ten sposób:

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

UWAGA: Wymaga to API 26+, więc jeśli obsługujesz starsze wersje Androida, nadal używaj (5, TimeUnit.SECONDS).

shellhub
źródło
4

tak:

//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
źródło
4

to zadziałało dla mnie ... z 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
źródło
2

Jeśli chcesz dostosować konfigurację, użyj najpierw poniższej metodologii tworzenia OKhttpclient, a następnie dodaj do niego konstruktora.

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);
    }
sandhya murugesan
źródło
1

Możesz ustawić limit czasu wywołania, aby pokryć cały cykl od rozwiązania DNS, nawiązania połączenia, zapisania treści żądania, przetwarzania serwera i odczytania treści odpowiedzi.

val client = OkHttpClient().newBuilder().callTimeout(CALL_TIMEOUT_IN_MINUTES, TimeUnit.MINUTES).build()
ChaturaM
źródło