在REST/Java中，如果我的对象为空，我应该返回什么？

Question

@GET
@Path("/domains/{domainid}")
@Override
public Domain getDomain(@PathParam("domainid") UUID domainID) throws Exception {
    logger.info("Retrieving domain "+ domainID);
    Domain d = null;
    try {
        d = MyClient.getDomains().get(domainID.toString());
        logger.debug("Returning "+d.getName());
    } catch (Exception e) {
        logger.error("Could not retrieve domain", e);
    }
    return d;
}

注意，包括d.getname()在内的log语句实际上可以抛出一个NPE，然后捕获并记录该NPE。这并不漂亮，但这也不是这里的重点。

最终，无论d是否有值，我都会返回它。

在null值的情况下，客户端将收到HTTP 204状态码。这是wget显示的内容:HTTP请求已发送，正在等待响应...204无内容

null

谢谢

这里有一个关于相同主题的很好的问题：当没有找到REST资源时返回404是正确的吗？

Answer 1

如果请求试图获取/定位/查找资源，但找不到，传统上，我们应该发送404 Not found。有关进一步讨论，请参见此处。

也就是说，我通常喜欢让我的资源方法返回响应，因为这样更容易按照我想要的方式对响应进行微调（这里有一点--不是很多--更多的细节）。但是，考虑到您的方法是如何重写接口契约（并返回模型对象）的，JAX-RS为我们提供了一个很好的异常层次结构，这些异常将映射到特定的响应/状态。名单可以在这里看到。

因此，在您的特殊情况下，如果找不到资源，可以抛出WebApplicationException(response.status.not_find)或NotFoundException，异常将映射到404 Not found。类似于

d = MyClient.getDomains().get(domainID.toString());
if (d == null) {
    throw new NotFoundException();  // <-- JAX-RS 2.0
    // or throw new WebApplicationException(Response.Status.NOT_FOUND);
                                    // ^^  JAX-RS 1.x 
}

该方法将在引发异常时退出，客户端将收到状态为404未找到的响应。

相关问答

• 如何在不依赖于JAX-RS实现的情况下捕获404(NotFoundException）？
• 找不到REST资源时返回404是否正确？

@PUT
@Path("/customers/{id}")
public Response updateCustomer(@PathParam("id") long id, Customer customer) {
    ...
}