我们有一个REST API,供一些评论使用。目前,最有趣的URI是:
GET /products/1/comments // get all comments of product 1
GET /products/1/comments/5 // get the 5th comment of product 1
GET /products/1/comments/5/user // get the user of the 5th comment
GET /products/1/comments/latest // get the latest comment of product 1
GET /products/1/comments/latest/user // get the user of the latest comment
此外,您可以直接访问评论
GET /comments/987 // get the comment with id 987
GET /comments/987/user // get the user of comment with id 987
所以,我们有两个@RestController
:
@RestController
@RequestMapping("/products/{productId}")
public class ProductsCommentsResource {
@GetMapping(value = "/comments")
public ResponseEntity<?> getComments(@PathVariable Long productId){
// get all products...
}
@GetMapping(value = "/comments/{commentNr}")
public ResponseEntity<?> getComment(@PathVariable Long productId, @PathVaraible Long commentNr){
// get comment with number commentNr of product productId
}
@GetMapping(value = "/comments/{commentNr}/user")
public ResponseEntity<?> getCommentUser(@PathVariable Long productId, @PathVaraible Long commentNr){
// get the user of comment with commentNr of productId
}
@GetMapping(value = "/comments/latest")
public ResponseEntity<?> getLatestComment(@PathVariable Long productId){
// get latest commentNr and call getComment(productId, commentNr)
}
@GetMapping(value = "/comments/latest/user")
public ResponseEntity<?> getLatestCommentUser(@PathVariable Long productId){
// get latest commentNr and call getCommentUser(productId, commentNr)
}
}
@RestController
@RequestMapping("/comments")
public class CommentsResource {
@GetMapping(value = "/{commentId}")
public ResponseEntity<?> getComment(@PathVaraible Long commentId){
// get comment id commentId
}
@GetMapping(value = "/{commentId}/user")
public ResponseEntity<?> getCommentUser(@PathVaraible Long commendId){
// get the user of comment with id commentId
}
}
latest
因此只是“获取最后一个commentNr并使用此commentId调用相应方法”的替换关键字
这只是一个摘录,除了用户之外,评论还有大约30个子资源和子资源(包括POST,DELETE等方法)。 因此,我们或多或少都有三次。
所以,显然,我们需要改进这一点,删除重复的代码等。
我们的想法是“封装”评论资源,并使用在课堂上注释的@RequestMapping
使其可重复使用。
我们考虑过像:
这样的机制/products/1/comments/latest/user
被称为因此,我们需要有重定向的东西
- /products/1/comments/latest[what ever]
至/comments/{commentId}[what ever]
- /products/1/comments/5[what ever]
也发送到/comments/{commentId}[what ever]
和/ comments / {commentId}将是唯一的实现。
但是,我们在春季文档中找不到任何合适的内容......
答案 0 :(得分:5)
您可以在控制器@RequestMapping
中添加其他网址路径前缀。
@RequestMapping(value = { "/products/{productId}", "/" })
这意味着您可以删除CommentsResource
控制器,并且您可以访问相同的资源:
/products/1/comments/5
和
/comments/5
例如,在这里:
@GetMapping(value = "/comments/{commentNr}")
public ResponseEntity<?> getComment(@PathVariable Long productId, @PathVaraible Long commentNr){
// get comment with number commentNr of product productId
}
显而易见的问题是productId
路径变量。如果您正在使用Java 8,那么使用Optional
:
@GetMapping(value = "/comments/{commentNr}")
public ResponseEntity<?> getComment(@PathVariable Optional<Long> productId, @PathVaraible Long commentNr){
// get comment with number commentNr of product productId
// Check whether productId exists
}