Java-Backend-Entwicklung: API-Aufrufe mit Retrofit

Java-Backend-Entwicklung: Verwenden Sie Retrofit für API-Aufrufe

Mit der rasanten Entwicklung der Internettechnologie ist API zu einem Standardprotokoll für die Kommunikation zwischen Anwendungen und Diensten geworden und wird in verschiedenen Szenarien, beispielsweise bei der Entwicklung mobiler Anwendungen und Websites, häufig verwendet. Im Bereich der Java-Backend-Entwicklung ist Retrofit derzeit ein sehr beliebtes Framework zur Implementierung von API-Aufrufen. In diesem Artikel wird vorgestellt, was Retrofit ist und wie man Retrofit zum Durchführen von API-Aufrufen verwendet.

1. Was ist Retrofit? Retrofit ist ein Java-basiertes Framework zur Implementierung serverseitiger API-Aufrufe. Es verwendet Annotationen zur Beschreibung von HTTP-Anfragen, Parametern und Antwortkörpern und implementiert so serverseitige API-Aufrufe über Java-Schnittstellen. Es verwendet OkHttp als zugrunde liegende Netzwerkanforderungsbibliothek, unterstützt synchrone und asynchrone Netzwerkanforderungsmethoden und bietet zahlreiche Zusatzfunktionen wie Anforderungswiederholung, Anforderungscaching, Datei-Upload usw. Retrofit unterstützt auch verschiedene Datenkonverter wie Gson, Jackson, Moshi usw., die Anforderungs- und Antwortkörper problemlos in Java-Objekte konvertieren können.

2. So verwenden Sie Retrofit zum Durchführen von API-Aufrufen

1. Abhängigkeiten importieren

Um Retrofit zum Durchführen von API-Aufrufen zu verwenden, müssen Sie dem Projekt zunächst relevante Abhängigkeiten hinzufügen. Im Maven-Projekt können Sie der Datei pom.xml die folgenden Abhängigkeiten hinzufügen:

<dependency>
  <groupId>com.squareup.retrofit2</groupId>
  <artifactId>retrofit</artifactId>
  <version>2.9.0</version>
</dependency>
<dependency>
  <groupId>com.squareup.retrofit2</groupId>
  <artifactId>converter-gson</artifactId>
  <version>2.9.0</version>
</dependency>

Unter diesen ist Retrofit eine Abhängigkeit des Retrofit-Frameworks selbst und Converter-Gson eine Abhängigkeit des Gson-Datenkonverters von Retrofit.

2. API-Schnittstelle erstellen

Wenn Sie Retrofit zum Ausführen von API-Aufrufen verwenden, müssen Sie zuerst die entsprechende API-Schnittstelle erstellen. Die Schnittstelle beschreibt die URL, die Anfragemethode, die Anfrageparameter, den Rückgabedatentyp und andere Informationen der Server-API. Der folgende Code definiert beispielsweise eine grundlegende Schnittstelle zum Senden einer GET-Anfrage an den Server und zur Rückgabe einer Zeichenfolge:

public interface ApiService {
    @GET("/api/hello")
    Call<String> getHello();
}

In dieser Schnittstelle wird die von Retrofit bereitgestellte @GET-Annotation verwendet, um den Typ der HTTP-Anfrage und die URL-Adresse zu beschreiben. Verwenden Sie Call8742468051c85b06f0a0af9e3e506b5c, um den zurückgegebenen Datentyp zu beschreiben, wobei T ein beliebiger Java-Typ sein kann, z. B. eine Zeichenfolge, ein benutzerdefiniertes Objekt usw.

3. Erstellen Sie ein Retrofit-Objekt

Nachdem die Schnittstelle definiert ist, müssen Sie Retrofit verwenden, um die entsprechende Dienstinstanz zu erstellen. Beim Erstellen eines Retrofit-Objekts können Sie die Anforderungs-URL, den Datenkonverter, die Netzwerkanforderungsbibliothek und andere zugehörige Eigenschaften angeben. Der folgende Code erstellt beispielsweise eine Retrofit-Instanz und gibt die Anforderungs-URL, den Gson-Datenkonverter und die OkHttp-Netzwerkanforderungsbibliothek an:

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("http://localhost:8080")
    .addConverterFactory(GsonConverterFactory.create())
    .client(new OkHttpClient.Builder().build())
    .build();

Unter diesen gibt baseUrl die grundlegende URL-Adresse des Servers an, addConverterFactory gibt den Datenkonverter als GsonConverter an Der Client gibt die Verwendung von OkHttp als zugrunde liegende Netzwerkanforderungsbibliothek an. Hier wird die Standardkonfiguration von OkHttpClient verwendet. Sie können jedoch auch verwandte Parameter selbst konfigurieren, z. B. Verbindungszeitlimit, Lese- und Schreibzeitlimit usw.

4. Erstellen Sie eine API-Instanz

Retrofit erstellt die Implementierungsklasse der API-Schnittstelle über einen dynamischen Proxy, wodurch API-Aufrufe sehr einfach werden. Der folgende Code erstellt beispielsweise eine API-Instanz und ruft die getHello-Methode auf:

ApiService apiService = retrofit.create(ApiService.class);
Call<String> call = apiService.getHello();
Response<String> response = call.execute();
System.out.println(response.body());

In diesem Code wird eine ApiService-Implementierungsklasse dynamisch über die retrofit.create-Methode generiert und die getHello-Methode wird verwendet, um das Call-Objekt abzurufen Die schließlich aufgerufene Ausführungsmethode von Call führt die Anforderung synchron aus. Die Ausführungsmethode gibt ein Antwortobjekt zurück, das alle vom Server zurückgegebenen Informationen enthält, wobei das Body-Attribut die vom Server zurückgegebenen Daten sind.

Wenn Sie die Anforderung asynchron ausführen möchten, können Sie die Enqueue-Methode von Call verwenden. Beispiel:

ApiService apiService = retrofit.create(ApiService.class);
Call<String> call = apiService.getHello();
call.enqueue(new Callback<String>() {
  @Override
  public void onResponse(Call<String> call, Response<String> response) {
    System.out.println(response.body());
  }
  
  @Override
  public void onFailure(Call<String> call, Throwable t) {
    t.printStackTrace();
  }
});

In diesem Code wird die Enqueue-Methode von Call verwendet, um die Anforderung asynchron auszuführen, und eine Callback-Schnittstelle wird implementiert, um die Anforderungsergebnisse zu verarbeiten. Die Methode onResponse wird aufgerufen, wenn die Anfrage erfolgreich ist, und die Methode onFailure wird aufgerufen, wenn die Anfrage fehlschlägt.

3. Zusammenfassung

In diesem Artikel wird die grundlegende Verwendung von Retrofit vorgestellt, einschließlich des Prozesses zum Erstellen von API-Schnittstellen, zum Erstellen von Retrofit-Instanzen, zum Erstellen von API-Instanzen und zum Durchführen von Netzwerkanforderungen. Retrofit vereinfacht API-Aufrufe durch die Verwendung von Annotationen und macht es für Front-End und Back-End sehr bequem, mit Daten zu interagieren. Bei der Verwendung von Retrofit müssen Sie auf Thread-Sicherheitsprobleme achten, da Retrofit nicht threadsicher ist und eine ordnungsgemäße Synchronisierung in einer Multithread-Umgebung erfordert.

Das obige ist der detaillierte Inhalt vonJava-Backend-Entwicklung: API-Aufrufe mit Retrofit. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!