我正在用java 8创建信使应用程序并使用REST。我在我的应用程序中添加了设置消息。
我想得到一个 JSON 响应作为用户定义的异常，而不是 apache tomcat 抛出的默认异常。
例如，我的地图中有两条消息，ID = 1和2。如果我尝试通过提供消息 id 67 来获取消息，它应该会引发异常。
它是由 apache tomcat 以 HTML 格式抛出异常，这不是我的要求，而是我希望用户定义的异常采用 JSON 格式。
我收到我定义的自定义消息，但不是 JSON 格式。
我正在使用邮递员。
这是我的代码。
消息服务.java
package com.diwakar.messenger.service;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.List;
import java.util.Map;
import com.diwakar.messenger.database.DatabaseClass;
import com.diwakar.messenger.exception.DataNotFoundException;
import com.diwakar.messenger.model.Message;
public class MessageService {
private Map<Long, Message> messages = DatabaseClass.getMessages();
public MessageService() {
messages.put(1L, new Message(1L, "Hello World!", "Diwakar"));
messages.put(2L, new Message(2L, "Hello Jersey!", "Diwakar"));
}
public List<Message> getAllMessages() {
return new ArrayList<Message>(messages.values());
}
public List<Message> getAllMessagesForYear(int year) {
List<Message> messagesForYear = new ArrayList<>();
Calendar cal = Calendar.getInstance();
for (Message message : messages.values()) {
cal.setTime(message.getCreated());
if (cal.get(Calendar.YEAR) == year) {
messagesForYear.add(message);
}
}
return messagesForYear;
}
public List<Message> getAllMessagesPaginated(int start, int size) {
List<Message> list = new ArrayList<Message>(messages.values());
if (start + size > list.size()){
return new ArrayList<Message>();
}
return list.subList(start, start + size);
}
public Message getMessage(long id) {
Message message = messages.get(id);
if (message == null) {
throw new DataNotFoundException("Message with id : " + id + " not found. ");
}
return message;
}
public Message addMessage(Message message) {
message.setId(messages.size() + 1);
messages.put(message.getId(), message);
return message;
}
public Message updateMessage(Message message) {
if (message.getId() <= 0) {
return null;
}else {
messages.put(message.getId(), message);
return message;
}
}
public Message removeMessage(long id) {
return messages.remove(id);
}
}
DataNotFoundException.java
package com.diwakar.messenger.exception;
public class DataNotFoundException extends RuntimeException{
/**
*
*/
private static final long serialVersionUID = 1L;
public DataNotFoundException(String message) {
super(message);
}
}
DataNotFoundExceptionMapper.java
package com.diwakar.messenger.exception;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;
import javax.ws.rs.ext.ExceptionMapper;
import javax.ws.rs.ext.Provider;
import com.diwakar.messenger.model.ErrorMessage;
@Provider
public class DataNotFoundExceptionMapper implements ExceptionMapper<DataNotFoundException> {
@Override
public Response toResponse(DataNotFoundException ex) {
ErrorMessage errorMessage = new ErrorMessage(ex.getMessage(), 404, "http://www.google.com");
return Response.status(Status.NOT_FOUND).entity(errorMessage).build();
}
}
错误消息.java
package com.diwakar.messenger.model;
import javax.xml.bind.annotation.XmlRootElement;
@XmlRootElement
public class ErrorMessage {
private String errorMessage;
private int errorCode;
private String documentation;
public ErrorMessage() {
}
public ErrorMessage(String errorMessage, int errorCode, String documentation){
super();
this.errorMessage = errorMessage;
this.errorCode = errorCode;
this.documentation = documentation;
}
public String getErrorMessage() {
return errorMessage;
}
public void setErrorMessage(String errorMessage) {
this.errorMessage = errorMessage;
}
public int getErrorCode() {
return errorCode;
}
public void setErrorCode(int errorCode) {
this.errorCode = errorCode;
}
public String getDocumentation() {
return documentation;
}
public void setDocumentation(String documentation) {
this.documentation = documentation;
}
}
消息回复
Apache 引发的异常
您必须返回有效的 200 响应，有效负载是序列化的异常数据，然后客户端代码需要能够区分"有效"200 和"错误"200，也可能是有效负载中的标志。
我不是 100% 使用 java 和 tomcat 但硬抛出服务器异常通常会创建一个 500 响应，该响应被包装，但有问题的 REST 框架决定这样做，通常没有敏感的异常数据。控制的唯一方法是使用自定义有效负载数据返回 200 响应。
还要记住，你如何做到这一点可能会将异常细节暴露给客户端（javascript），而你通常不想要。
我得到了答案...
我们可以使用 com.diwakar.messenger 或 （com.diwakar.messenger.resources 和 com.diwakar.messenger.exception），而不是使用 com.diwakar.messenger.resources。
这个 init-parm jersey.config.server.provider.packages 所说的是，Jersey 应该扫描命名包以查找@Path注释的资源类，并@Provider注释的提供程序类并注册它们。
我们只列出了资源包com.diwakar.messenger.resources，但ExceptionMapper在不同的包中。默认行为是递归扫描，这意味着子包也是如此。因此，如果我们编写com.diwakar.messenger，您将同时点击资源包和异常包。或者我们可以列出两个包，用逗号或分号分隔。无论哪种方式都有效
网络.xml
<?xml version="1.0" encoding="UTF-8"?>
<!-- This web.xml file is not required when using Servlet 3.0 container,
see implementation details http://jersey.java.net/nonav/documentation/latest/jax-rs.html -->
<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
<servlet>
<servlet-name>Jersey Web Application</servlet-name>
<servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
<init-param>
<param-name>jersey.config.server.provider.packages</param-name>
<param-value>com.diwakar.messenger</param-value>
<!-- <param-value>com.diwakar.messenger.resources</param-value> -->
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>Jersey Web Application</servlet-name>
<url-pattern>/webapi/*</url-pattern>
</servlet-mapping>
</web-app>
作为 JSON 响应引发的自定义异常