Wyślij prostą prośbę

Dowiedz się, jak używać biblioteki Cronet do wykonywania operacji sieciowych w aplikacji na Androida. Cronet to stos sieciowy Chromium udostępniany jako biblioteka do wykorzystania w aplikacjach. Więcej informacji o funkcjach biblioteki znajdziesz w artykule Wykonywanie operacji sieciowych za pomocą Cronet.

Konfigurowanie biblioteki w projekcie

Aby dodać zależność do biblioteki Cronet w projekcie:

  1. Sprawdź, czy Android Studio zawiera odniesienie do repozytorium Google Maven w pliku settings.gradle projektu, jak w tym przykładzie:

    Dynamiczny

    dependencyResolutionManagement {
       ...
       repositories {
           ...
           google()
       }
    }

    Kotlin

    dependencyResolutionManagement {
       ...
       repositories {
           ...
           google()
       }
    }
  2. Dodaj odwołanie do biblioteki klienta usług Google Play dla Cronet w sekcji dependencies pliku build.gradle modułu aplikacji, jak pokazano w tym przykładzie:

    Dynamiczny

    dependencies {
       implementation 'com.google.android.gms:play-services-cronet:18.0.1'
    }

    Kotlin

    dependencies {
       implementation("com.google.android.gms:play-services-cronet:18.0.1")
    }

Obiekty CronetEngine utworzone po dodaniu tej zależności używają Croneta wczytanego z usług Google Play. Aby zapobiec nieoczekiwanym wyjątkom podczas tworzenia CronetEngine (np. na urządzeniach wymagających zaktualizowanej wersji Usług Google Play), przed utworzeniem obiektów CronetEngine wywołaj CronetProviderInstaller.installProvider(Context).

W przypadkach, gdy nie można wczytać Croneta z Usług Google Play, można użyć mniej wydajnej implementacji interfejsu API Croneta. Aby użyć tej implementacji zastępczej, musisz korzystać z org.chromium.net:cronet-fallback i wywołać new JavaCronetProvider(context).createBuilder().

Tworzenie żądania sieciowego

Z tej sekcji dowiesz się, jak utworzyć i wysłać żądanie sieciowe za pomocą biblioteki Cronet. Po wysłaniu żądania sieciowego aplikacja musi przetworzyć odpowiedź sieciową.

Tworzenie i konfigurowanie instancji CronetEngine

Biblioteka udostępnia klasę CronetEngine.Builder, której możesz użyć do utworzenia instancji CronetEngine. Poniższy przykład pokazuje, jak utworzyć obiekt CronetEngine:

Kotlin

val myBuilder = CronetEngine.Builder(context)
val cronetEngine: CronetEngine = myBuilder.build()

Java

CronetEngine.Builder myBuilder = new CronetEngine.Builder(context);
CronetEngine cronetEngine = myBuilder.build();

Do skonfigurowania obiektu CronetEngine możesz użyć klasy Builder. Możesz na przykład udostępnić opcje takie jak buforowanie i kompresja danych. Więcej informacji znajdziesz tutaj: CronetEngine.Builder.

Zaimplementuj wywołanie zwrotne żądania

Aby udostępnić implementację wywołania zwrotnego, utwórz podklasę UrlRequest.Callback i zaimplementuj wymagane metody abstrakcyjne, jak pokazano w tym przykładzie:

Kotlin

private const val TAG = "MyUrlRequestCallback"

class MyUrlRequestCallback : UrlRequest.Callback() {
    override fun onRedirectReceived(request: UrlRequest?, info: UrlResponseInfo?, newLocationUrl: String?) {
        Log.i(TAG, "onRedirectReceived method called.")
        // You should call the request.followRedirect() method to continue
        // processing the request.
        request?.followRedirect()
    }

    override fun onResponseStarted(request: UrlRequest?, info: UrlResponseInfo?) {
        Log.i(TAG, "onResponseStarted method called.")
        // You should call the request.read() method before the request can be
        // further processed. The following instruction provides a ByteBuffer object
        // with a capacity of 102400 bytes for the read() method. The same buffer
        // with data is passed to the onReadCompleted() method.
        request?.read(ByteBuffer.allocateDirect(102400))
    }

    override fun onReadCompleted(request: UrlRequest?, info: UrlResponseInfo?, byteBuffer: ByteBuffer?) {
        Log.i(TAG, "onReadCompleted method called.")
        // You should keep reading the request until there's no more data.
        byteBuffer?.clear()
        request?.read(byteBuffer)
    }

    override fun onSucceeded(request: UrlRequest?, info: UrlResponseInfo?) {
        Log.i(TAG, "onSucceeded method called.")
    }
}

Java

class MyUrlRequestCallback extends UrlRequest.Callback {
  private static final String TAG = "MyUrlRequestCallback";

  @Override
  public void onRedirectReceived(UrlRequest request, UrlResponseInfo info, String newLocationUrl) {
    Log.i(TAG, "onRedirectReceived method called.");
    // You should call the request.followRedirect() method to continue
    // processing the request.
    request.followRedirect();
  }

  @Override
  public void onResponseStarted(UrlRequest request, UrlResponseInfo info) {
    Log.i(TAG, "onResponseStarted method called.");
    // You should call the request.read() method before the request can be
    // further processed. The following instruction provides a ByteBuffer object
    // with a capacity of 102400 bytes for the read() method. The same buffer
    // with data is passed to the onReadCompleted() method.
    request.read(ByteBuffer.allocateDirect(102400));
  }

  @Override
  public void onReadCompleted(UrlRequest request, UrlResponseInfo info, ByteBuffer byteBuffer) {
    Log.i(TAG, "onReadCompleted method called.");
    // You should keep reading the request until there's no more data.
    byteBuffer.clear();
    request.read(byteBuffer);
  }

  @Override
  public void onSucceeded(UrlRequest request, UrlResponseInfo info) {
    Log.i(TAG, "onSucceeded method called.");
  }
}

Tworzenie obiektu Executor do zarządzania zadaniami sieciowymi

Do wykonywania zadań sieciowych możesz używać klasy Executor. Aby uzyskać instancję Executor, użyj jednej ze statycznych metod klasy Executors, która zwraca obiekt Executor. Poniższy przykład pokazuje, jak utworzyć obiekt Executor za pomocą metody newSingleThreadExecutor():

Kotlin

val executor: Executor = Executors.newSingleThreadExecutor()

Java

Executor executor = Executors.newSingleThreadExecutor();

Tworzenie i konfigurowanie obiektu UrlRequest

Aby utworzyć żądanie sieciowe, wywołaj metodę newUrlRequestBuilder() klasy CronetEngine, przekazując docelowy adres URL, instancję klasy wywołania zwrotnego i obiekt wykonawcy. Metoda newUrlRequestBuilder() zwraca obiekt UrlRequest.Builder, którego możesz użyć do utworzenia obiektu UrlRequest, jak w tym przykładzie:

Kotlin

val requestBuilder = cronetEngine.newUrlRequestBuilder(
        "https://www.example.com",
        MyUrlRequestCallback(),
        executor
)

val request: UrlRequest = requestBuilder.build()

Java

UrlRequest.Builder requestBuilder = cronetEngine.newUrlRequestBuilder(
        "https://www.example.com", new MyUrlRequestCallback(), executor);

UrlRequest request = requestBuilder.build();

Do skonfigurowania instancji UrlRequest możesz użyć klasy Builder. Możesz na przykład określić priorytet lub czasownik HTTP. Więcej informacji: UrlRequest.Builder.

Aby rozpocząć zadanie sieciowe, wywołaj metodę start() żądania:

Kotlin

request.start()

Java

request.start();

Postępując zgodnie z instrukcjami w tej sekcji, możesz utworzyć i wysłać żądanie sieciowe za pomocą Cronet. Jednak dla uproszczenia przykładowa implementacja UrlRequest.Callback tylko wyświetla komunikat w logu. W następnej sekcji pokazujemy, jak udostępnić implementację wywołania zwrotnego, która obsługuje bardziej przydatne scenariusze, takie jak wyodrębnianie danych z odpowiedzi i wykrywanie niepowodzenia żądania.

Przetwarzanie odpowiedzi sieci

Po wywołaniu metody start() Cronet rozpoczyna cykl życia żądania. Zarządzaj żądaniem w trakcie cyklu życia, określając wywołanie zwrotne. Więcej informacji o cyklu życia znajdziesz w artykule Cykl życia żądania Cronet. Możesz określić wywołanie zwrotne, tworząc podklasę UrlRequest.Callback i implementując te metody:

onRedirectReceived()

Cronet wywołuje tę metodę, gdy serwer wysyła kod przekierowania HTTP w odpowiedzi na pierwotne żądanie. Aby przejść do nowego miejsca docelowego, użyj metody followRedirect(). W przeciwnym razie użyj metody cancel(). Poniższy przykład pokazuje, jak wdrożyć metodę:

Kotlin

override fun onRedirectReceived(request: UrlRequest?, info: UrlResponseInfo?, newLocationUrl: String?) {
  // Determine whether you want to follow the redirect.
  ...

  if (shouldFollow) {
      request?.followRedirect()
  } else {
      request?.cancel()
  }
}

Java

@Override
public void onRedirectReceived(UrlRequest request, UrlResponseInfo info, String newLocationUrl) {
  // Determine whether you want to follow the redirect.
  ...

  if (shouldFollow) {
    request.followRedirect();
  } else {
    request.cancel();
  }
}
onResponseStarted()

Cronet wywołuje tę metodę po otrzymaniu ostatecznego zestawu nagłówków. Cronet wywołuje onResponseStarted() dopiero po przejściu wszystkich przekierowań. Poniższy kod pokazuje przykładową implementację metody:

Kotlin

override fun onResponseStarted(request: UrlRequest?, info: UrlResponseInfo?) {
  val httpStatusCode = info?.httpStatusCode
  if (httpStatusCode == 200) {
    // The request was fulfilled. Start reading the response.
    request?.read(myBuffer)
  } else if (httpStatusCode == 503) {
    // The service is unavailable. You should still check if the request
    // contains some data.
    request?.read(myBuffer)
  }
  responseHeaders = info?.allHeaders
}

Java

@Override
public void onResponseStarted(UrlRequest request, UrlResponseInfo info) {
  int httpStatusCode = info.getHttpStatusCode();
  if (httpStatusCode == 200) {
    // The request was fulfilled. Start reading the response.
    request.read(myBuffer);
  } else if (httpStatusCode == 503) {
    // The service is unavailable. You should still check if the request
    // contains some data.
    request.read(myBuffer);
  }
  responseHeaders = info.getAllHeaders();
}
onReadCompleted()

Cronet wywołuje tę metodę za każdym razem, gdy zostanie odczytana część treści odpowiedzi. Poniższy przykładowy kod pokazuje, jak zaimplementować metodę i wyodrębnić treść odpowiedzi:

Kotlin

override fun onReadCompleted(request: UrlRequest?, info: UrlResponseInfo?, byteBuffer: ByteBuffer?) {
  // The response body is available, process byteBuffer.
  ...

  // Continue reading the response body by reusing the same buffer
  // until the response has been completed.
  byteBuffer?.clear()
  request?.read(myBuffer)
}

Java

@Override
public void onReadCompleted(UrlRequest request, UrlResponseInfo info, ByteBuffer byteBuffer) {
  // The response body is available, process byteBuffer.
  ...

  // Continue reading the response body by reusing the same buffer
  // until the response has been completed.
  byteBuffer.clear();
  request.read(myBuffer);
}
onSucceeded()

Cronet wywołuje tę metodę, gdy żądanie sieciowe zostanie pomyślnie zrealizowane. Poniższy przykład pokazuje, jak wdrożyć tę metodę:

Kotlin

override fun onSucceeded(request: UrlRequest?, info: UrlResponseInfo?) {
    // The request has completed successfully.
}

Java

@Override
public void onSucceeded(UrlRequest request, UrlResponseInfo info) {
  // The request has completed successfully.
}
onFailed()

Cronet wywołuje tę metodę, jeśli żądanie nie powiedzie się z jakiegokolwiek powodu po wywołaniu przez aplikację metody start(). Poniższy przykład pokazuje, jak zaimplementować metodę i uzyskać informacje o błędzie:

Kotlin

override fun onFailed(request: UrlRequest?, info: UrlResponseInfo?, error: CronetException?) {
    // The request has failed. If possible, handle the error.
    Log.e(TAG, "The request failed.", error)
}

Java

@Override
public void onFailed(UrlRequest request, UrlResponseInfo info, CronetException error) {
  // The request has failed. If possible, handle the error.
  Log.e(TAG, "The request failed.", error);
}
onCanceled()

Cronet wywołuje tę metodę, jeśli żądanie zostało anulowane za pomocą metody cancel(). Po wywołaniu metody onCanceled() Cronet nie wywołuje żadnych innych metod klasy UrlRequest.Callback. Możesz użyć tej metody, aby zwolnić zasoby przydzielone do przetwarzania żądania. Poniższy przykład pokazuje, jak wdrożyć tę metodę:

Kotlin

override fun onCanceled(request: UrlRequest?, info: UrlResponseInfo?) {
    // Free resources allocated to process this request.
    ...
}

Java

@Override
public void onCanceled(UrlRequest request, UrlResponseInfo info) {
  // Free resources allocated to process this request.
  ...
}