Wie gebe ich HTTP 404 JSON/XML Antwort in JAX-RS (Jersey) auf Tomcat zurück?

Question

Ich habe den folgenden Code:

@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; 
    } 

Wenn ich für einen Benutzer anfordern, die nicht, wie /users/1234, mit „Accept: application/json“ nicht existiert, dieser Code gibt eine HTTP 404 Antwort wie man erwarten würde, gibt aber Content-Type Sets zu text/html und eine Body-Nachricht von HTML. Anmerkung @Produces wird ignoriert.

Ist es ein Problem des Codes oder ein Problem der Konfiguration?

Answer 1

Ihre @Produces Anmerkung ignoriert wird, weil nicht abgefangene Ausnahmen von der JAX-RS-Laufzeit einen vordefinierten (default) ExceptionMapper Wenn Sie anpassen möchten die zurückgegebene Meldung bei einer bestimmten Ausnahme verarbeitet verwenden, können Sie erstellen Ihre eigene ExceptionMapper, um damit umzugehen. In Ihrem Fall müssen Sie eine der NotFoundException Ausnahme und abfragen, um die „accept“ Header für die gewünschte Art der Antwort zu handhaben:

@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

dass 404 wird von Ihrem Server zurückgegeben, wie es erwartet wird, dass Sie die Dinge in folgenden Form

/users/{id} 

passieren werden, aber sie sind vorbei als

/users/user/{id} 

welche Ressource überhaupt nicht vorhanden ist

try zugreifenden Ressource als /users/1234

EDIT:

erstellen eine Klasse wie

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

jetzt im Fall, dass Sie Antwort wollen für User können Sie es schaffen, wie folgend

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

und Unterschrift des Rest-Methode wie folgt

wäre

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

während im Falle einer erfolgreichen Antwort können Sie einstellen Dinge wie

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

Sie die Antwort verwenden zurückkehren können. Beispiel unten:

@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

Dieser arbeitete für mich mit 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(); 
} 

ich brauchte auch die Methode mit @Produces(MediaType.APPLICATION_JSON) zu annotieren als @Tiago angegeben.