如何在 Spring 3 MVC REST API 中继承 RequestMappings

Question

我正在尝试使用 Spring MVC 构建一个 RESTful API。我正在寻找干净且易于管理的代码，其中包结构遵循 url 结构。

这就是我所拥有的：

// com.test.api.library
@RequestMapping("/library/{libraryId}")
public Library getLibrary(@PathVariable long libraryId) {
   return service.getLibraryById(libraryId);
}

// com.test.api.library.book
@RequestMapping("/library/{libraryId}/book/{bookId}")
public Book getBook(@PathVariable long libraryId, @PathVariable long bookId) {
   Library library service.getLibraryById(libraryId);
   return library.getBookById(bookId);
}

虽然这可行，但我发现必须在所有继承的 @RequestMappings 中重复“/library/{libraryId}”很麻烦且容易出错，/library 很可能是 API 很大一部分的根目录，它应该写一次就重复使用，而不是到处写。

我想把 book-class 改写成这样：

// com.test.api.library.book
@RequestMapping("/book/{bookId}")
public Book getBook(@PathVariable long bookId) {
   // long libraryId magically given to me from the library-class's getLibrary()

   Library library service.getLibraryById(libraryId);
   return library.getBookById(bookId);
}

Spring 有什么办法可以帮助我吗？我可以使用普通的 java 继承、spring 注释或任何其他帮助我不写“/library/{libraryId}”作为我写过的每个 url 的一部分的东西。

Answer 1

我相信这个问题之前已经被问及回答过：Spring MVC @RequestMapping Inheritance

也就是说，这是减少重复信息量的一种方法。我实际上并没有在我自己的代码中这样做，因为我认为将 URI 放在代码旁边更易于维护，即使这意味着一些重复。

@RequestMapping(URI_LIBRARY)
public interface LibraryNamespace {
  public static String URI_LIBRARY = "/library/{libraryId}";
}

@RequestMapping(URI_BOOK)
public interface BookNamespace {
  public static String URI_BOOK = LibraryNamespace.URI_LIBRARY + "/book/{bookId}";
}

@Controller
public class LibraryController implements LibraryNamespace {
  @RequestMapping("")
  public Library get(@PathVariable long libraryId) {
    return service.getLibraryById(libraryId);
  }
}

@Controller
public class BookController implements BookNamespace {
  @RequestMapping("")
  public Book get(@PathVariable long libraryId, @PathVariable long bookId) {
    Library library service.getLibraryById(libraryId);
    return library.getBookById(bookId);
  }
}

由于我自己不会采用这种方法，因此我实际上没有尝试过这种解决方案！根据我对 Spring 的理解，我认为它应该可以工作......

Answer 2

使用多态父方法。

@Controller
public class CommentsController {
    @RequestMapping(value="/comments", method = RequestMethod.GET)
    public @ResponseBody String index() {
        /* kludge to allow optional path parameters */
        return index(null, null);
    }

    @RequestMapping(value="/{parent_collection}/{parent_id}/comments", method = RequestMethod.GET)
    public @ResponseBody String index(@PathVariable("parent_collection") String parentCollection, @PathVariable("parent_id") String parentId) {
        if (parentCollection == null) {
            return "all comments";
        }
        else if ((parentCollection != null) && (parentCollection.equals("posts"))) {
            /* get parent, then get comments for parent */
            return "comments for single post";
        }
        else if ((parentCollection != null) && (parentCollection.equals("customers"))) {
            /* get parent, then get comments for parent */
            return "comments for single customer";
        }
        else if ((parentCollection != null) && (parentCollection.equals("movies"))) {
            /* get parent, then get comments for parent */
            return "comments for single movie";
        }
    }

    @RequestMapping(value = "/comments/{id}", method = RequestMethod.GET)
    public @ResponseBody String show(@PathVariable Integer id) {
        /* kludge to allow optional path parameters */
        return show(null, null, id);
    }

    @RequestMapping(value = "/{parent_collection}/{parent_id}/comments/{id}", method = RequestMethod.GET)
    public @ResponseBody String show(@PathVariable("parent_collection") String parentCollection, @PathVariable("parent_id") String parentId, @PathVariable Integer id) {
        /* get comment, then get parent from foreign key */

        if (parentCollection == null) {
            return "single comment";
        }
        else if ((parentCollection != null) && (parentCollection.equals("posts"))) {
            return "single comment for single post";
        }
        else if ((parentCollection != null) && (parentCollection.equals("customers"))) {
            return "single comment for single customer";
        }
        else if ((parentCollection != null) && (parentCollection.equals("movies"))) {
            return "single comment for single movie";
        }
    }
}

此外，您可以使用基本控制器将 URI 前缀路由到父资源 (/libraries/{library_id}/../..)，将父模型添加到请求范围，然后让常规请求映射处理 URI 到子资源的其余部分(/../../books/1)。我没有这种副手的例子。

旁注。单一嵌套资源通常被视为 URI 设计的反模式。控制器应该处理自己的资源。最常见的实现使单个嵌套资源的键是唯一的，即不依赖于其父资源。例如，数据库记录主键。但是，在某些情况下，键可能不是唯一的，例如序数或位置值（例如，书 1、第 1 章、第 2 章），甚至可能是自然键（例如，书 ISBN、个人 SSN、电子邮件地址, 用户名, 文件名)。

嵌套资源的规范 URI 示例：

• /articles => ArticlesController#index
• /articles/1 => ArticlesController#show
• /articles/1/comments => CommentsController#index
• /articles/1/comments/2 => CommentsController#show（好的，但不是首选）
• /comments/2 => CommentsController#show（首选）

Answer 3

我认为这是不可能的。但是您可以在类本身上添加@RequestMapping 注释，这样至少可以节省一些打字时间。

Answer 4

@Controller
@RequestMapping("/library/{libraryId}")
public class HelloWorldController {

    @RequestMapping(value="/book/{bookId}")
    public ModelAndView helloWorld() {
        ....
    }

}