Développement backend Java : appels d'API utilisant Retrofit

Développement backend Java : utiliser Retrofit pour les appels API

Avec le développement rapide de la technologie Internet, l'API est devenue un protocole standard pour la communication entre les applications et les services et est largement utilisée dans divers scénarios, tels que le développement d'applications mobiles et de sites Web. Dans le domaine du développement back-end Java, Retrofit est actuellement un framework très populaire pour implémenter des appels API. Cet article présentera ce qu'est Retrofit et comment utiliser Retrofit pour effectuer des appels API.

1. Qu'est-ce que Retrofit

Retrofit est un framework basé sur Java pour implémenter des appels API côté serveur. Il utilise des annotations pour décrire les requêtes HTTP, les paramètres et les corps de réponse, implémentant ainsi les appels API côté serveur via des interfaces Java. Il utilise OkHttp comme bibliothèque de requêtes réseau sous-jacente, prend en charge les méthodes de requête réseau synchrones et asynchrones et fournit un grand nombre de fonctions auxiliaires, telles que la nouvelle tentative de requête, la mise en cache des requêtes, le téléchargement de fichiers, etc. Retrofit prend également en charge une variété de convertisseurs de données, tels que Gson, Jackson, Moshi, etc., qui peuvent facilement convertir les corps de requête et de réponse en objets Java.

2. Comment utiliser Retrofit pour effectuer des appels API

1. Importer des dépendances

Pour utiliser Retrofit pour effectuer des appels API, vous devez d'abord ajouter les dépendances pertinentes au projet. Dans le projet Maven, vous pouvez ajouter les dépendances suivantes dans le fichier pom.xml :

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

Parmi elles, retrofit est une dépendance du framework Retrofit lui-même, et converter-gson est une dépendance du convertisseur de données Gson de Retrofit.

2. Créer une interface API

Lorsque vous utilisez Retrofit pour effectuer des appels API, vous devez d'abord créer l'interface API correspondante. L'interface décrit l'URL, la méthode de requête, les paramètres de requête, le type de données renvoyées et d'autres informations de l'API du serveur. Par exemple, le code suivant définit une interface de base pour envoyer une requête GET au serveur et renvoyer une chaîne :

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

Dans cette interface, l'annotation @GET fournie par Retrofit est utilisée pour décrire le type de requête HTTP et l'adresse URL, utilisez Call pour décrire le type de données renvoyé, où T peut être n'importe quel type Java, tel qu'une chaîne, un objet personnalisé, etc.

3. Créer un objet Retrofit

Une fois l'interface définie, vous devez utiliser Retrofit pour créer l'instance de service correspondante. Lors de la création d'un objet Retrofit, vous pouvez spécifier l'URL de la requête, le convertisseur de données, la bibliothèque de requêtes réseau et d'autres propriétés associées. Par exemple, le code suivant crée une instance Retrofit et spécifie l'URL de la requête, le convertisseur de données Gson et la bibliothèque de requêtes réseau OkHttp :

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

Parmi eux, baseUrl spécifie l'adresse URL de base du serveur, addConverterFactory spécifie le convertisseur de données comme GsonConverter, The le client spécifie l'utilisation de OkHttp comme bibliothèque de requêtes réseau sous-jacente. La configuration par défaut d'OkHttpClient est utilisée ici, mais vous pouvez également configurer vous-même les paramètres associés, tels que le délai d'attente de connexion, le délai d'attente de lecture et d'écriture, etc.

4. Créer une instance d'API

Retrofit crée la classe d'implémentation de l'interface API via un proxy dynamique, ce qui rend les appels d'API très simples. Par exemple, le code suivant crée une instance d'API et appelle la méthode getHello :

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

Dans ce code, une classe d'implémentation ApiService est générée dynamiquement via la méthode retrofit.create, et la méthode getHello est utilisée pour obtenir l'objet Call, et finalement appelée, la méthode d'exécution de Call exécute la requête de manière synchrone. La méthode d'exécution renverra un objet Response, qui contient toutes les informations renvoyées par le serveur, dans lequel l'attribut body correspond aux données renvoyées par le serveur.

Si vous souhaitez exécuter la requête de manière asynchrone, vous pouvez utiliser la méthode de mise en file d'attente de Call. Par exemple :

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

Dans ce code, la méthode de mise en file d'attente de Call est utilisée pour exécuter la requête de manière asynchrone et une interface de rappel est implémentée pour traiter les résultats de la requête. La méthode onResponse sera appelée lorsque la requête aboutira et la méthode onFailure sera appelée lorsque la requête échouera.

3. Résumé

Cet article présente l'utilisation de base de Retrofit, y compris le processus de création d'interfaces API, de création d'instances Retrofit, de création d'instances API et d'exécution de requêtes réseau. Retrofit simplifie les appels d'API en utilisant des annotations, ce qui rend très pratique l'interaction du front-end et du back-end avec les données. Vous devez faire attention aux problèmes de sécurité des threads lors de l'utilisation de Retrofit, car Retrofit n'est pas thread-safe et nécessite une synchronisation appropriée dans un environnement multithread.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!