使用 Spring 我可以創建一個可選的路徑變量嗎？

Question

使用 Spring 3.0，我可以有一個可選的路徑變量嗎？

例如

@RequestMapping(value = "/json/{type}", method = RequestMethod.GET)
public @ResponseBody TestBean testAjax(
        HttpServletRequest req,
        @PathVariable String type,
        @RequestParam("track") String track) {
    return new TestBean();
}

這里我希望/json/abc或/json調用相同的方法。
一種明顯的解決方法是將type聲明為請求參數：

@RequestMapping(value = "/json", method = RequestMethod.GET)
public @ResponseBody TestBean testAjax(
        HttpServletRequest req,
        @RequestParam(value = "type", required = false) String type,
        @RequestParam("track") String track) {
    return new TestBean();
}

然后/json?type=abc&track=aa或/json?track=rr將工作

Answer 1

你不能有可選的路徑變量，但你可以有兩個調用相同服務代碼的控制器方法：

@RequestMapping(value = "/json/{type}", method = RequestMethod.GET)
public @ResponseBody TestBean typedTestBean(
        HttpServletRequest req,
        @PathVariable String type,
        @RequestParam("track") String track) {
    return getTestBean(type);
}

@RequestMapping(value = "/json", method = RequestMethod.GET)
public @ResponseBody TestBean testBean(
        HttpServletRequest req,
        @RequestParam("track") String track) {
    return getTestBean();
}

Answer 2

如果您使用的是 Spring 4.1 和 Java 8，則可以使用 Spring MVC 中的@RequestParam 、 @PathVariable 、 @RequestHeader和@MatrixVariable支持的java.util.Optional -

@RequestMapping(value = {"/json/{type}", "/json" }, method = RequestMethod.GET)
public @ResponseBody TestBean typedTestBean(
    @PathVariable Optional<String> type,
    @RequestParam("track") String track) {      
    if (type.isPresent()) {
        //type.get() will return type value
        //corresponds to path "/json/{type}"
    } else {
        //corresponds to path "/json"
    }       
}

Answer 3

眾所周知，您還可以使用 @PathVariable 注釋注入路徑變量的 Map。 我不確定這個特性是否在 Spring 3.0 中可用，或者是否是后來添加的，但這是解決示例的另一種方法：

@RequestMapping(value={ "/json/{type}", "/json" }, method=RequestMethod.GET)
public @ResponseBody TestBean typedTestBean(
    @PathVariable Map<String, String> pathVariables,
    @RequestParam("track") String track) {

    if (pathVariables.containsKey("type")) {
        return new TestBean(pathVariables.get("type"));
    } else {
        return new TestBean();
    }
}

Answer 4

你可以使用一個：

@RequestParam(value="somvalue",required=false)

用於可選參數而不是 pathVariable

Answer 5

Spring 5 / Spring Boot 2 示例：

阻塞

@GetMapping({"/dto-blocking/{type}", "/dto-blocking"})
public ResponseEntity<Dto> getDtoBlocking(
        @PathVariable(name = "type", required = false) String type) {
    if (StringUtils.isEmpty(type)) {
        type = "default";
    }
    return ResponseEntity.ok().body(dtoBlockingRepo.findByType(type));
}

反應性

@GetMapping({"/dto-reactive/{type}", "/dto-reactive"})
public Mono<ResponseEntity<Dto>> getDtoReactive(
        @PathVariable(name = "type", required = false) String type) {
    if (StringUtils.isEmpty(type)) {
        type = "default";
    }
    return dtoReactiveRepo.findByType(type).map(dto -> ResponseEntity.ok().body(dto));
}

Answer 6

Nicolai Ehmann 的評論和 wildloop 的答案的簡化示例（適用於 Spring 4.3.3+），基本上您現在可以使用required = false ：

  @RequestMapping(value = {"/json/{type}", "/json" }, method = RequestMethod.GET)
  public @ResponseBody TestBean testAjax(@PathVariable(required = false) String type) {
    if (type != null) {
      // ...
    }
    return new TestBean();
  }

Answer 7

檢查這個Spring 3 WebMVC-Optional Path Variables 。 它顯示了對 AntPathMatcher 進行擴展以啟用可選路徑變量的文章，可能會有所幫助。 感謝塞巴斯蒂安·赫羅德( Sebastian Herold)發布這篇文章。

Answer 8

這是直接來自 baeldung 參考頁面的答案：- https://www.baeldung.com/spring-optional-path-variables

Answer 9

感謝 Paul Wardrip 在我的情況下我使用 required。

@RequestMapping(value={ "/calificacion-usuario/{idUsuario}/{annio}/{mes}", "/calificacion-usuario/{idUsuario}" }, method=RequestMethod.GET)
public List<Calificacion> getCalificacionByUsuario(@PathVariable String idUsuario
        , @PathVariable(required = false) Integer annio
        , @PathVariable(required = false) Integer mes) throws Exception {
    return repositoryCalificacion.findCalificacionByName(idUsuario, annio, mes);
}

Answer 10

$.ajax({
            type : 'GET',
            url : '${pageContext.request.contextPath}/order/lastOrder',
            data : {partyId : partyId, orderId :orderId},
            success : function(data, textStatus, jqXHR) });

@RequestMapping(value = "/lastOrder", method=RequestMethod.GET)
public @ResponseBody OrderBean lastOrderDetail(@RequestParam(value="partyId") Long partyId,@RequestParam(value="orderId",required=false) Long orderId,Model m ) {}