如何在 Spring 3 中使用注释配置 RESTful 控制器？

Question

我正在尝试使用Spring 3.0 创建一个RESTful 控制器。控制器用于门户应用程序的管理 API。我要执行的操作是：

• GET /api/portals 列出所有门户
• 发布 /api/portals 以创建新门户
• GET /api/portals/{id} 以检索现有门户
• PUT /api/portals/{id} 以更新现有门户
• DELETE /api/portal/{id} 删除现有门户

如下图所示注释控制器后，我发现列出所有门户或创建新门户的操作没有得到映射。

所以我的问题是：

• 我是否正确注释了类？
• 我是否遵循了实现 RESTful Web 服务的正确约定？
• 春天会不会有什么东西坏了？

下面的代码摘录显示了我是如何注释我的类的：

@Controller
@RequestMapping("/api/portals")
public final class PortalAPIController
{
    private final static Logger LOGGER = LoggerFactory.getLogger(PortalAPIController.class);

    @RequestMapping(value = "/", method = RequestMethod.GET)
    public String listPortals(final Model model)
    {
         PortalAPIController.LOGGER.debug("Portal API: listPortals()");
         .
         .
         return "portals";
    }

    @RequestMapping(value = "/", method = RequestMethod.POST)
    public String createPortal(@RequestBody final MultiValueMap<String, String> portalData, final Model model)
    {
        PortalAPIController.LOGGER.debug("Portal API: createPortal()");
        .
        .
        return "portal";
    }

    @RequestMapping(value = "/{id}", method = RequestMethod.GET)
    public String getPortal(@PathVariable("id") final String portalId, final Model model, final HttpServletResponse response)
        throws IOException
    {
        PortalAPIController.LOGGER.debug("Portal API: getPortal()");
        .
        .
        return "portal";
    }

    @RequestMapping(value = "/{id}", method = RequestMethod.PUT)
    public String updatePortal(@PathVariable("id") final String portalId,
        @RequestBody final MultiValueMap<String, String> portalData, final Model model, final HttpServletResponse response)
        throws IOException
    {
        PortalAPIController.LOGGER.debug("Portal API: updatePortal()");
        .
        .
        return "portal";
    }

    @RequestMapping(value = "/{id}", method = RequestMethod.DELETE)
    public String deletePortal(@PathVariable("id") final String portalId, final Model model, final HttpServletResponse response)
        throws IOException
    {
        PortalAPIController.LOGGER.debug("Portal API: deletePortal()");
        .
        .
        return "portal";
    }

    .
    .
}

在启动期间，我看到 Spring 的东西已经注册了端点：

2010-02-19 01:18:41,733 INFO [org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping] - Mapped URL path [/api/portals/] onto handler [com.btmatthews.mars.portal.web.controller.PortalAPIController@141717f]
2010-02-19 01:18:41,734 INFO [org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping] - Mapped URL path [/api/portals/{id}] onto handler [com.btmatthews.mars.portal.web.controller.PortalAPIController@141717f]
2010-02-19 01:18:41,734 INFO [org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping] - Mapped URL path [/api/portals/{id}.*] onto handler [com.btmatthews.mars.portal.web.controller.PortalAPIController@141717f]
2010-02-19 01:18:41,735 INFO [org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping] - Mapped URL path [/api/portals/{id}/] onto handler [com.btmatthews.mars.portal.web.controller.PortalAPIController@141717f]
2010-02-19 01:18:41,735 INFO [org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping] - Mapped URL path [/api/portals] onto handler [com.btmatthews.mars.portal.web.controller.PortalAPIController@141717f]
2010-02-19 01:18:41,735 INFO [org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping] - Mapped URL path [/api/portals.*] onto handler [com.btmatthews.mars.portal.web.controller.PortalAPIController@141717f]

但是当我尝试使用 cURL 调用我的 API 时

curl http://localhost:8080/com.btmatthews.minerva.portal/api/portals/

或

curl http://localhost:8080/com.btmatthews.minerva.portal/api/portals

我收到以下错误：

2010-02-19 01:19:20,199 WARN [org.springframework.web.servlet.PageNotFound] - No mapping found for HTTP request with URI [/com.btmatthews.minerva.portal/api/portals] in DispatcherServlet with name 'portal'
2010-02-19 01:19:32,360 WARN [org.springframework.web.servlet.PageNotFound] - No mapping found for HTTP request with URI [/com.btmatthews.minerva.portal/api/portals/] in DispatcherServlet with name 'portal'

我在尝试创建时遇到了同样的问题：

curl -F ...... --request POST http://localhost:8080/com.btmatthtews.minerva/api/portals

但如果尝试对现有资源进行操作（检索、更新或删除），它可以正常工作。

更新：@axtavt 在评论中提供了解决方案。我在我的 web.xml servlet 映射中使用了 /api/*。需要改为/

Answer 1

仔细检查 web.xml 中的 url-pattern 并将其与 curl 参数进行比较。

Here is an example我写的它会引导你完成整个 Spring MVC 过程。

Answer 2

您在 curl 摘录中发布的 URL

http://localhost:8080/portal/api/portals

与 Spring 警告中的 URL 不匹配

/com.btmatthews.minerva.portal/api/portals

如果不知道您的 web 应用程序是如何设置的、它位于什么上下文路径、Spring 上下文是什么样的等等，很难诊断，但这对我来说似乎是一个很大的线索。

Answer 3

你犯了一些错误。

@RequestMapping(value = "/", method = RequestMethod.GET)

public String listPortals(final Model model)
{
}

这里的方法必须接受一些参数模型，但没有传递。 您必须在内部方法中编写该方法。或者如果你想传递它，你必须将它作为路径变量或请求参数发送。

@RequestMapping(value = "/{id}", method = RequestMethod.GET)

public String getPortal(@PathVariable("id") 

这里正确的语法是@PathVariable(value="id")

如果这不起作用 然后试试这个：

@RequestMapping(value = "/SOMETHING", method = RequestMethod.GET)

Answer 4

在 Spring 3 中，Rest Controller 只不过是一个常规控制器（@Component），唯一的区别是 Rest 控制器返回 JSON/XML 而不是“视图”。所以我认为你在注释方面做得很好。但是，我看不到两件事： 1-每种方法都需要有一个“生产”值（用于内容协商）： @RequestMapping(value = "/{id}", method = RequestMethod.GET,produces = "application/json")

2- 您需要某种类型的 ObjectMapper（例如：Marshaller 和 Unmarshaller）才能将对象映射到 JSON/XML，反之亦然。这两个应该在您的 servlet 配置中，而不是配置视图解析器。 应该就是这样。