Comment créer un client REST pour Java ?

Question

Avec la JSR 311 et ses implémentations, nous disposons d'une norme puissante pour l'exposition d'objets Java via REST. Cependant, du côté client, il semble manquer quelque chose de comparable à Apache Axis pour SOAP - quelque chose qui cache le service web et marshalise les données de manière transparente en objets Java.

Comment créer des clients Java RESTful ? En utilisant HTTPConnection et en analysant manuellement le résultat ? Ou des clients spécialisés pour, par exemple, Jersey ou Apache CXR ?

Answer 1

Il s'agit d'une ancienne question (2008) et il y a donc beaucoup plus d'options aujourd'hui qu'à l'époque :

• Apache CXF dispose de trois Options du client REST
• Jersey (mentionné ci-dessus).
• Spring RestTemplate remplacé par Spring WebClient
• Client HTTP Commons construire le vôtre pour les anciens projets Java.

MISES À JOUR (projets toujours actifs en 2020) :

• Composants Apache HTTP (4.2) Adaptateur Fluent - Remplacement de base du JDK, utilisé par plusieurs autres candidats de cette liste. Meilleur que l'ancien Commons HTTP Client 3 et plus facile à utiliser pour construire votre propre client REST. Vous devrez utiliser quelque chose comme Jackson pour l'analyse JSON et vous pouvez utiliser Composants HTTP URIBuilder pour construire des URI de ressources similaire au client Jersey/JAX-RS Rest. Les composants HTTP supportent également NIO mais je doute que vous obteniez de meilleures performances que BIO étant donné la nature courte des requêtes de REST. Apache HttpComponents 5 prend en charge HTTP/2.
• OkHttp - Remplacement de base du JDK, similaire aux composants http, utilisés par plusieurs autres candidats de cette liste. Prend en charge les protocoles HTTP les plus récents (SPDY et HTTP2). Fonctionne sur Android. Malheureusement, il n'offre pas de véritable option asynchrone basée sur une boucle de réacteur (voir Ning et les composants HTTP ci-dessus). Cependant, si vous utilisez le nouveau protocole HTTP2, cela est moins problématique (en supposant que le nombre de connexions soit un problème).
• Ning Async-http-client - assure la prise en charge de l'interface homme-machine. Précédemment connu sous le nom de Client asynchrone par Sonatype .
• Feindre pour les clients http de niveau inférieur (okhttp, apache httpcomponents). Création automatique de clients basés sur des interfaces similaires à certaines extensions Jersey et CXF. Forte intégration de Spring.
• Rénovation - pour les clients http de niveau inférieur (okhttp). Il crée automatiquement des clients basés sur des interfaces similaires à certaines extensions Jersey et CXF.
• Volley wrapper pour le client http du jdk, par google
• google-http wrapper pour le client http de jdk, ou apache httpcomponents, par google
• Unirest wrapper pour le client http de jdk, par kong
• Resteasy JakartaEE wrapper pour le client http de jdk, par jboss, faisant partie du framework jboss
• jcabi-http enveloppe pour les composants http apache, fait partie de la collection jcabi
• restlet enveloppe pour les composants http apache, fait partie du framework restlet
• repos assuré avec des assertions pour faciliter les tests

Une mise en garde sur le choix des clients HTTP/REST. Assurez-vous de vérifier ce que votre framework utilise comme client HTTP, comment il gère le threading, et idéalement utilisez le même client s'il en propose un. C'est-à-dire que si vous utilisez quelque chose comme Vert.x ou Play, vous pouvez essayer d'utiliser son client de backing pour participer à n'importe quel bus ou boucle de réacteur que le framework fournit... sinon préparez-vous à d'éventuels problèmes de threading.

Answer 2

Comme je l'ai mentionné dans ce fil J'ai tendance à utiliser Jersey qui implémente JAX-RS et s'accompagne d'un client REST sympathique. L'avantage est que si vous implémentez vos ressources RESTful en utilisant JAX-RS, le client Jersey peut réutiliser les fournisseurs d'entités tels que JAXB/XML/JSON/Atom et ainsi de suite - vous pouvez donc réutiliser les mêmes objets du côté serveur que ceux que vous utilisez dans le test unitaire du côté client.

Par exemple Voici un cas de test unitaire de la Projet Apache Camel qui recherche des charges utiles XML à partir d'une ressource RESTful (en utilisant l'objet JAXB Endpoints). La méthode resource(uri) est définie dans le document cette classe de base qui utilise simplement l'API du client Jersey.

par exemple

    clientConfig = new DefaultClientConfig();
    client = Client.create(clientConfig);

    resource = client.resource("http://localhost:8080");
    // lets get the XML as a String
    String text = resource("foo").accept("application/xml").get(String.class);        

BTW J'espère que la future version de JAX-RS ajoutera une API côté client similaire à celle de Jersey.

Answer 3

Vous pouvez utiliser les API standard de Java SE :

private void updateCustomer(Customer customer) { 
    try { 
        URL url = new URL("http://www.example.com/customers"); 
        HttpURLConnection connection = (HttpURLConnection) url.openConnection(); 
        connection.setDoOutput(true); 
        connection.setInstanceFollowRedirects(false); 
        connection.setRequestMethod("PUT"); 
        connection.setRequestProperty("Content-Type", "application/xml"); 

        OutputStream os = connection.getOutputStream(); 
        jaxbContext.createMarshaller().marshal(customer, os); 
        os.flush(); 

        connection.getResponseCode(); 
        connection.disconnect(); 
    } catch(Exception e) { 
        throw new RuntimeException(e); 
    } 
} 

Vous pouvez également utiliser les API client REST fournies par les implémentations JAX-RS telles que Jersey. Ces API sont plus faciles à utiliser, mais nécessitent des pots supplémentaires dans votre chemin de classe.

WebResource resource = client.resource("http://www.example.com/customers"); 
ClientResponse response = resource.type("application/xml");).put(ClientResponse.class, "<customer>...</customer."); 
System.out.println(response); 

Pour plus d'informations, voir :

• http://bdoughan.blogspot.com/2010/08/creating-restful-web-service-part-55.html

Answer 4

Si vous souhaitez uniquement invoquer un service REST et analyser la réponse, vous pouvez essayer la méthode suivante Soyez rassurés

// Make a GET request to "/lotto"
String json = get("/lotto").asString()
// Parse the JSON response
List<String> winnderIds = with(json).get("lotto.winners.winnerId");

// Make a POST request to "/shopping"
String xml = post("/shopping").andReturn().body().asString()
// Parse the XML
Node category = with(xml).get("shopping.category[0]");

Answer 5

Vous pouvez également vérifier Restlet qui possède des capacités complètes côté client, plus orientées REST que les bibliothèques de niveau inférieur telles que HttpURLConnection ou Apache HTTP Client (que nous pouvons exploiter en tant que connecteurs).

Je vous prie d'agréer, Madame, Monsieur, l'expression de mes salutations distinguées, Jérôme Louvel