Come restituisco la risposta HTTP 404 JSON/XML in JAX-RS (Jersey) su Tomcat?

Question

Ho il seguente codice:

@Path("https://stackoverflow.com/users/{id}") 
public class UserResource { 

    @Autowired 
    private UserDao userDao; 

    @GET 
    @Produces({MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON}) 
    public User getUser(@PathParam("id") int id) { 
     User user = userDao.getUserById(id); 
     if (user == null) { 
      throw new NotFoundException(); 
     } 
     return user; 
    } 

Se chiedo per un utente che non esiste, come /users/1234, con "Accept: application/json", questo codice restituisce un HTTP 404 risposta, come ci si aspetterebbe, ma restituisce Content-Type set a text/html e un messaggio corpo di html. L'annotazione @Produces viene ignorata.

Si tratta di un problema di codice o di un problema di configurazione?

Answer 1

tuo @Produces annotazione viene ignorato perché le eccezioni non gestite fanno vengono elaborati dal runtime JAX-RS utilizzando un predefinito (di default) ExceptionMapper Se si desidera personalizzare il messaggio restituito in caso di una deroga specifica è possibile creare il possedere ExceptionMapper per gestirlo. Nel tuo caso avete bisogno di uno per gestire l'eccezione NotFoundException e interrogare l'intestazione "accetta" per il tipo di risposta richiesto:

@Provider 
public class NotFoundExceptionHandler implements ExceptionMapper<NotFoundException>{ 

    @Context 
    private HttpHeaders headers; 

    public Response toResponse(NotFoundException ex){ 
     return Response.status(404).entity(yourMessage).type(getAcceptType()).build(); 
    } 

    private String getAcceptType(){ 
     List<MediaType> accepts = headers.getAcceptableMediaTypes(); 
     if (accepts!=null && accepts.size() > 0) { 
      //choose one 
     }else { 
      //return a default one like Application/json 
     } 
    } 
} 

Answer 2

che 404 viene restituito dal server in quanto si prevede che si passa le cose in forma seguente

/users/{id} 

ma si passa come

/users/user/{id} 

quale risorsa non è esistente a tutti

provare ad accedere a risorse come /users/1234

EDIT:

creare una classe come

class RestResponse<T>{ 
private String status; 
private String message; 
private List<T> objectList; 
//gettrs and setters 
} 

ora nel caso in cui si vuole risposta per User si può creare come segue

RestResponse<User> resp = new RestResponse<User>(); 
resp.setStatus("400"); 
resp.setMessage("User does not exist"); 

e la firma del metodo resto sarebbe come segue

public RestResponse<User> getUser(@PathParam("id") int id) 

mentre in caso di risposta riuscita è possibile impostare cose come

RestResponse<User> resp = new RestResponse<User>(); 
List<User> userList = new ArrayList<User>(); 
userList.add(user);//the user object you want to return 
resp.setStatus("200"); 
resp.setMessage("User exist"); 
resp.setObjectList(userList); 

Answer 3

È possibile utilizzare il ritorno di risposta. Esempio di seguito:

@GET 
@Path("{id}") 
@Produces(MediaType.APPLICATION_JSON) 
public Response get(@PathParam("id") Long id) { 
    ExampleEntity exampleEntity = getExampleEntityById(id); 

    if (exampleEntity != null) { 
     return Response.ok(exampleEntity).build(); 
    } 

    return Response.status(Status.NOT_FOUND).build(); 
} 

Answer 4

Questo ha funzionato per me con JAX-RS:

jsonText = "{\n" + " \"account\": {\n" + "  \"billing_account\": \"" + ipResponse.getResult().getParentGUID() + "\",\n" + "}" + ",\n" + "}"; 
parser = new JSONParser(); 

//build our JSON response object 
try { 
    jSONObject = (JSONObject) parser.parse(jsonText); 
    return Response.status(200).entity(jSONObject.toJSONString()).build(); 
} catch (ParseException e) { 
    e.printStackTrace(); 
    jsonEText = "{\n" + " \"account\": {\n" + "  \"billing_account\": \"" + e.getMessage() + "\",\n" + "}" + ",\n" + "}"; 
    jSONObject = (JSONObject) parser.parse(jsonEText); 
    return Response.status(404).entity(jSONObject.toJSONString()).build(); 
} 

anche avevo bisogno di annotare il metodo con @Produces(MediaType.APPLICATION_JSON) come @Tiago indicato.