Dans JAX RS, les différences entre le retour de la Réponse et de Haricots ou de la Collection de Fèves (DTO)

Je travaille sur la construction d'une api REST. Ma question est, lors de l'utilisation de Jersey, quelles sont les différences entre mes services de construction et de retourner un objet de Réponse ou en retournant le haricot ou de la collection. Je suis le seul souci de réussite des appels, je suis de jeter des exceptions appropriées pour les erreurs et les situations exceptionnelles.

Ici est un exemple:

@Produces(MediaType.APPLICATION_JSON)
public Response search(FooBean foo){
    List<FooBean> results = bar.search(foo);
    return Response.ok(results).build();
}

@Produces(MediaType.APPLICATION_JSON)
public List<FooBean> search(FooBean foo){
    List<FooBean> results = bar.search(foo);
    return results;
}

J'ai vu tant d'exemples, et je préfère le deuxième scénario, juste pour rendre les choses plus faciles à reconnaître la méthode de service. J'ai examiné les réponses de ces deux méthodes, et ils semblent être identiques.

Pensées?

Ils être identiques, compte tenu que vous n'avez pas de retour de certains Exception classe comme vous l'avez dit. Le Response offrir la possibilité de renvoyer n'importe quel type d'objet, et aussi de mettre un HttpStatus. Dans ce cas, il en résultera 200 OK. Mais tu ne peux pas passer à un autre statut que vous le souhaitez à l'aide de Response. C'est mon avis, bien sûr, mais j'aime le Response façon.
Voulez-vous dire que vous POUVEZ passer à un autre statut de la réponse à l'aide de l'objet de la Réponse? Si je retourne une Liste<FooBean>, le statut de la réponse est aussi 200 OK.
Oui, vous pouvez changer si vous le souhaitez. Par défaut Response.ok().entity(entity).build(); sera de retour 200 OK si l'entité n'est pas nul, sinon, sera de retour 204 NO CONTENT. Vous pouvez forcer à retourner un 200 OK état avec Response.ok().entity(entity).status(Status.OK).build(); même de l'entité null;
Je vois. Ainsi, en plus de préférence, quelle est la différence entre le retour du bean vs revenir avec la Réponse builder?
Non, si vous intercepter les exceptions avant ou intercepter après votre classe de ressource, il n'y a pas de diference...

InformationsquelleAutor Half_Duplex | 2013-04-30

36

Les différences sont expliquées dans le JAX-RS spécifications:

3.3.3 Type De Retour

Ressources méthodes PEUVENT retourner void, de Réponse, de GenericEntity, ou un autre type Java, ces types de retour sont mappés à une réaction du corps d'entité comme suit:

vide

Résultats dans un vide du corps de l'entité avec une 204 code d'état.

Réponse

Résultats dans un corps d'entité cartographiés à partir de la propriété d'entité de la Réponse avec le code de statut spécifié par le statut de la propriété de la Réponse. Une valeur de retour null résultats dans un 204 code d'état. Si le statut de la propriété de la Réponse n'est pas définie: un code d'état 200 est utilisé pour un non-nulle de la propriété d'entité et une 204 code d'état est utilisée que si la propriété d'entité est null.

GenericEntity

Résultats dans un corps d'entité cartographiés à partir de la propriété d'Entité de la GenericEntity. Si la valeur de retour n'est pas nulle un code d'état 200 est utilisé, une valeur de retour null résultats dans un 204 code d'état.

Autres

Résultats dans un corps d'entité cartographiés à partir de la classe du retour à l'instance. Si la valeur de retour n'est pas nulle un code d'état 200 est utilisé, une valeur de retour null résultats dans un 204 code d'état.

Méthodes qui en ont besoin pour fournir des métadonnées supplémentaires avec une réponse doit retourner une instance de la Réponse, le ResponseBuilder classe fournit un moyen pratique de créer une instance de Réponse à l'aide d'un générateur de modèle.

"Normales", les haricots sont mappés sur à peu près de la même façon que Response est, à l'exception d'un Response vous permet de définir des métadonnées supplémentaires (en-têtes de réponse, le statut de spécialiste, spécialisé type de contenu, etc). Dans la mesure où l'un pour l'utiliser, c'est entièrement à vous de décider de Response vous donne plus de flexibilité, mais réguliers, les haricots sont plus "auto-documentation'.
- voici le lien pour les specs: download.oracle.com/otndocs/jcp/jaxrs-2_0-fr-spec/index.html
InformationsquelleAutor Perception
8

Il n'y a pas de diference si vous souhaitez renvoyer toujours la réponse 200 - OK , attraper et manipuler toutes les exceptions qui peuvent se produire avant ou après votre retour de méthode le résultat, avec les interceptions ou WebApplicationException. Donc, ces deux méthodes entraînera les mêmes réponses.

La seule diference est à des scénarios spécifiques, comme le retour des objets nuls, ou la création d'objet, comme dans cet exemple:
```
@POST
@Consumes("application/json")
public Response post(String content) {
    URI createdUri = ...
    Object createdContent = create(content);
    return Response.created(createdUri).entity(createdContent).build();
}
```
Dans ce cas, le retour sera 201 - CREATED (Avec l'URI pour accéder à l'objet créé)

Donc, la méthode suivante:
```
@POST
@Consumes("application/json")
public Object post(String content) {
    URI createdUri = ...
    Object createdContent = create(content);
    return createdContent;
}
```
... sera de retour une réponse 200 - OK

Si vous n'avez pas de soins sur laquelle le statut de la réponse de votre client recevra, vous pouvez utiliser l'une des déclarations sans problème.

Source: Jersey.
- La bonne solution, car pour la plupart nous fonctionnons avec des Objets, pas seulement avec des chaînes. Donc, j'ai une question - Comment récupérer l'objet à partir de la Réponse et d'obtenir des données xml ou json représentation de celui-ci?
InformationsquelleAutor Deividi Cavarzan
2

Mon personnel de vue, si la réponse contient DTO (Bean/Collection de fèves), puis repos de service doit toujours retourner DTO, mais pas de Réponse de l'objet.

La motivation: tôt ou tard, il vous sera demandé de faire un usage du service rest plus facile pour les clients, en fournissant client rest api. Habituellement, vous devez extraire interfaces rest pour elle, et de les mettre en œuvre avec votre des services rest. Ces interfaces rest sont utilisés par les clients de votre client rest.

Client et du point de vue, il y a une énorme différence entre le traitement DTO et de la plaine de Réponse. En cas de Réponse est utilisé, le client est obligé:
1. Vérifier le code de réponse explicitement au processus succès de la réponse
2. Gérer les erreurs, la vérification de codes explicitement
3. Convertir des corps de votre réponse en DTO par lui-même.
Qui signifie maniabilité est très similaire à retourner des codes d'erreur dans les méthodes, ce qui est considéré comme une très mauvaise pratique. Afin de gérer les erreurs dans un seul lieu, les exceptions sont utilisées (je ne parle pas de FP façons de gérer les erreurs, ce qui est le meilleur).

Donc, ce qui peut vous faire:
1. Dans le cas où une demande est traitée avec succès, de les convertir dans votre repos de données de service dans DTO/Haricot et le retourner.
2. Dans le cas où si la validation a échoué, ou quelque chose allait mal, lever une exception à votre service rest. Peut-être un défaut exception mappeur n'est pas bon pour vous, donc, vous aurez à mettre en œuvre votre propre exception mappeur.
Donc, si penser à l'avance, vous devez retourner DTO.

Un cas d'utilisation, lors de la plaine de Réponse doivent être retournés - lorsque vous exportez des fichiers, par exemple. Il semble JAX RS ne permettent pas de revenir objet InputStream. Pas sûr, il doit être vérifié.

Les autres cas d'utilisation, a été signalé par @Perception, mais il est plus une exception qu'une règle:

Méthodes qui en ont besoin pour fournir des métadonnées supplémentaires avec une réponse
doit retourner une instance de la Réponse, la ResponseBuilder classe
fournit un moyen pratique de créer une instance de Réponse à l'aide d'un
le générateur de modèle.

Note: c'est une question d'ordre général pour JAX RS, ne dépend pas de l'exacte mise en œuvre, comme Resteasy ou Jersey

InformationsquelleAutor Alexandr

Vous devez vous connecter pour publier un commentaire.