วิธีการตั้งค่าการหมดเวลาเชื่อมต่อกับ OkHttp

ฉันกำลังพัฒนาแอพโดยใช้ไลบรารี OkHttp และปัญหาของฉันคือฉันไม่สามารถหาวิธีตั้งค่าการหมดเวลาการเชื่อมต่อและการหมดเวลาซ็อกเก็ตได้

OkHttpClient client = new OkHttpClient();

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

Response response = client.newCall(request).execute();

คุณเพียงแค่ต้องทำสิ่งนี้

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ค่าเท่ากับการตั้งค่าเป็น0เปิดsetConnectTimeoutหรือsetReadTimeoutและจะส่งผลให้หมดเวลาที่ทุกคนไม่ รายละเอียดสามารถพบได้ที่นี่

ตามที่กล่าวถึงโดย @marceloquinta ในความคิดเห็นsetWriteTimeoutยังสามารถตั้งค่า

ในฐานะที่เป็นรุ่น 2.5.0 ค่าการอ่าน / เขียน / เชื่อมต่อหมดเวลาถูกตั้งค่าเป็น 10 วินาทีโดยค่าเริ่มต้นตามที่ระบุไว้โดย @ChristerNordvik สามารถมองเห็นได้ที่นี่

ในฐานะที่เป็น OkHttp3 ตอนนี้สามารถทำได้ผ่านตัวสร้างเช่นนี้

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

นอกจากนี้คุณยังสามารถดูสูตรที่นี่

สำหรับ okhttp3 นี่เปลี่ยนไปเล็กน้อย

ตอนนี้คุณตั้งค่าเวลาโดยใช้ตัวสร้างและไม่ใช่ตัวตั้งค่าเช่นนี้:

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

สำหรับชุดติดตั้งเพิ่มเติม: 2.0.0-beta4 รหัสจะเป็นดังนี้

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

สำหรับ 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();

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

มันเปลี่ยนไปแล้ว แทนที่.Builder()ด้วย.newBuilder()

ในฐานะที่เป็นokhttp: 3.9.0รหัสไปดังนี้:

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

รุ่น okhttp:3.11.0หรือสูงกว่า

จากซอร์สโค้ด 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 สามารถเป็นค่าใด ๆ ของด้านล่าง

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

Updated

ฉันได้เพิ่ม api ใหม่เป็น okhttp จากรุ่น3.12.0คุณสามารถตั้งค่าการหมดเวลาเช่นนี้:

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

หมายเหตุ:นี้ต้องใช้ API 26+ ดังนั้นหากคุณสนับสนุน Android (5, TimeUnit.SECONDS)เวอร์ชันเก่ายังคงใช้

ชอบมาก:

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

สิ่งนี้ใช้ได้กับฉัน ... จาก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();

หากคุณต้องการปรับแต่งการกำหนดค่าให้ใช้วิธีการด้านล่างในการสร้าง 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);
    }

คุณสามารถตั้งค่าการหมดเวลาการโทรเพื่อให้ครอบคลุมวงจรทั้งหมดจากการแก้ไข DNS การเชื่อมต่อการเขียนเนื้อหาคำขอการประมวลผลเซิร์ฟเวอร์และการอ่านเนื้อหาการตอบสนอง

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