REST控制器spring 4中的可选@Pathvariable

Question

我正在编写一个Rest服务（HTTP获取endpoint），在下面的uri中执行以下操作

http://localhost:8080/customers/{customer_id}

1. 获取uri中传递的客户id的详细信息

代码：

@RequestMapping(method = RequestMethod.GET, value = "customers/{customer_id}")
public List<Customer> getCustomers(
@PathVariable(name = "customer_id", required = false) final String customerId) {
LOGGER.debug("customer_id {} received for getCustomers request", customerId);

}

但是，在上面的代码中，对于第二个场景，控件将流向getCustomers（）。

注意：我使用的是Java8和SpringWeb4.3.10版本

非常感谢任何对此的帮助。

Answer 1

您应该在这里创建两个endpoint来处理单个请求：

@GetMapping("/customers")
public List<Customer> getCustomers() {
LOGGER.debug("Fetching all customer");  
}

@GetMapping("/customers/{id}")
public List<Customer> getCustomers(@PathVariable("id") String id) {
LOGGER.debug("Fetching customer by Id {} ",id);  
}

@GetMapping相当于@RequestMapping（method=RequestMethod.GET），@GetMapping（“/customers/{id}”）相当于@RequestMapping（method=RequestMethod.GET，value=“customers/{id}”）

更好的方法是这样的：

@RestController
@RequestMapping("/customers")
public class CustomerController {

    @GetMapping
    public List<Customer> getAllCustomers() {
    LOGGER.debug("Fetching all customer");  
    }

    @GetMapping("/{id}")
    public Customer getCustomerById(@PathVariable("id") String id) {
    LOGGER.debug("Fetching customer by Id {} ",id);  
    }

Answer 2

这可能有助于试图使用多个可选路径变量的人。

如果有多个变量，则始终可以接受多个路径。例如：

@GetMapping(value = {"customers/{customerId}&{startDate}&{endDate}",
"customers/{customerId}&{startDate}&",
"customers/{customerId}&&{endDate}",
"customers/{customerId}&&"
})
public Customer getCustomerUsingFilter(@PathVariable String customerId, @PathVariable Optional<Date> startDate, @PathVariable Optional<Date> endDate)

然后您将使用所有路径分隔符调用此URL（在本例中

喜欢
获取 /customers/1

Answer 3

只有当您想将GET/customers/{customer_id}和GET customers映射到单个java方法时，才使用可选的@PathVariable。

如果不发送customer_id，则无法发送将发送到GET /customers/{customer_id}的请求。

所以在你的情况下，它将是：

@RequestMapping(method = RequestMethod.GET, value = {"/customers", "customers/{customer_id}"})
public List<Customer> getCustomers(@PathVariable(name = "customer_id", required = false) final String customerId) {
    LOGGER.debug("customer_id {} received for getCustomers request", customerId);
}

需要公共抽象布尔值

path变量是否是必需的。

默认为true，如果传入请求中缺少路径变量，则会引发异常。如果您喜欢null或Java8，请将此选项切换为falsejava.util.在这种情况下是可选的。

您可以使用java8中的null或Optional