Como definir o tempo limite da conexão com o OkHttp

173

Estou desenvolvendo um aplicativo usando a biblioteca OkHttp e meu problema é que não consigo encontrar como definir o tempo limite da conexão e o tempo limite do soquete.

OkHttpClient client = new OkHttpClient();

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

Response response = client.newCall(request).execute();
Kelvincer
fonte
2
A resposta que você selecionou não é mais válida. Talvez você deva editar a pergunta para especificar a versão do okhttp.
Theyouthis

Respostas:

324

Você simplesmente tem que fazer isso

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

Esteja ciente de que valor definido no setReadTimeouté o utilizado em setSoTimeoutna Socketinternamente na OkHttp Connectionclasse.

Não definir nenhum tempo limite no OkHttpClienté o equivalente a definir um valor de 0on setConnectTimeoutou setReadTimeoute resultará em nenhum tempo limite. A descrição pode ser encontrada aqui .

Como mencionado por @marceloquinta nos comentários setWriteTimeouttambém pode ser definido.

A partir da versão 2.5.0, os valores de tempo limite de leitura / gravação / conexão são definidos para 10 segundos por padrão, conforme mencionado por @ChristerNordvik. Isso pode ser visto aqui .

A partir do OkHttp3, agora é possível fazer isso através do Builder da seguinte maneira

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

Você também pode ver a receita aqui .

Miguel Lavigne
fonte
6
Existe uma maneira de definir o tempo limite diferente para cada solicitação (cada solicitação tem o mesmo cliente estático)?
31514 StErMi
3
Você pode definir o tempo limite específico para cada pedido: Aqui algumas informações: github.com/square/okhttp/wiki/Recipes
Tobliug
3
Não se esqueça do tempo limite de gravação: client.setWriteTimeout (10, TimeUnit.SECONDS);
Marceloquinta 21/09/2015
7
@MiguelLavigne Apenas para sua informação, OkHttp mudou na 2.5.0 para ter um tempo limite padrão de 10 segundos.
Christer Nordvik
5
Resposta desatualizada
devDeejay 31/01
143

Para okhttp3, isso mudou um pouco.

Agora você configura os horários usando o construtor, e não os configuradores, assim:

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

Mais informações podem ser encontradas em seu wiki: https://github.com/square/okhttp/blob/b3dcb9b1871325248fba917458658628c44ce8a3/docs/recipes.md#timeouts-kt-java

Kaizie
fonte
12

Para Retrofit retrofit: 2.0.0-beta4, o código é o seguinte

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
fonte
9

Para o Retrofit 2.0.0-beta1 ou beta2, o código é o seguinte

    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();
xaxista
fonte
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
fonte
5

Isso mudou agora. Substitua .Builder()por.newBuilder()

A partir do okhttp: 3.9.0, o código é o seguinte:

OkHttpClient okHttpClient = new OkHttpClient()
    .newBuilder()
    .connectTimeout(10,TimeUnit.SECONDS)
    .writeTimeout(10,TimeUnit.SECONDS)
    .readTimeout(30,TimeUnit.SECONDS)
    .build();
Leo
fonte
5

okhttp versão:3.11.0 ou superior

do código fonte 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 pode ser qualquer valor abaixo

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

código de exemplo

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

Atualizada

Eu adicionei uma nova API ao okhttp da versão 3.12.0, você pode definir o tempo limite da seguinte forma:

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

NOTA: Isso requer a API 26+; portanto, se você suporta versões mais antigas do Android, continue usando (5, TimeUnit.SECONDS).

shellhub
fonte
4

igual a:

//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
fonte
4

isso funcionou para mim ... de 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
fonte
2

Se você deseja personalizar a configuração, use a metodologia abaixo para criar o OKhttpclient primeiro e, em seguida, adicione o construtor sobre ele.

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
fonte
1

Você pode definir um tempo limite de chamada para cobrir todo o ciclo, desde a resolução do DNS, conexão, gravação do corpo da solicitação, processamento do servidor e leitura do corpo da resposta.

val client = OkHttpClient().newBuilder().callTimeout(CALL_TIMEOUT_IN_MINUTES, TimeUnit.MINUTES).build()
ChaturaM
fonte