web-dev-qa-db-ja.com

Spring Rest Controller、オーバーライドされたメソッド引数のパス変数

_@RestController_で注釈が付けられたコントローラーがあり、インターフェイスを実装しています。

_ public interface ContratEndpoint {

      String ROOT = "/api/contrats";

      String GET_CONTRAT = "";

      String GET_CONTRAT_PER_PK = "/{idContrat}";

      @RequestMapping(value = GET_CONTRAT)
      Contrat getContrat(@RequestParam(value = "contratId")Long contratId);


      @RequestMapping(value = GET_CONTRAT_PER_ID)
      ExtContrat getContratById(@PathVariable("idContrat") Long idContrat);
}
_

コントローラー:

_@RestController
@RequestMapping(value = ContratEndpoint.ROOT)
public class ContratController implements ContratEndpoint {

    //Injecting Services....

    @Resource
    private Mapper mapper;


    @Override
    public Contrat getContrat(Long contratId) {
    return mapper.map(contratService.get(contratId),Contrat.class);
    }

    @Override
    public ExtContrat getContratById(@PathVariable("idContrat") Long idContrat){
        Preconditions.checkArgument(idContrat !=null);
        return mapper.map(contratService.get(idContrat),ExtContrat.class);
    }
_

上記のコードは問題なく機能します。

。しかし、最初に継承されたメソッドの場合、引数に_@RequestParam_の注釈を付ける必要はなく、問題なく機能しました。

私が最初に試した2番目の方法については:

_ @Override
        public ExtContrat getContratById(Long idContrat){
            Preconditions.checkArgument(idContrat !=null);
            return mapper.map(contratService.get(idContrat),ExtContrat.class);
        }
_

。最初のメソッドと同じ動作を期待していましたが、間違っていたため、コードはPreconditions.checkArgument(idContrat!=null)のチェックインのためにIllegalArgumentExceptionを起動しました。

私の質問は、_@PathVariable_について、私が見逃したほど具体的なものは何ですか?それとも、私のアプローチに何か問題があるのでしょうか?

ありがとう。

4
Rafik BELDI

リクエストパラメータとパス変数には違いがあります。例外の原因をURIで確認できる以下の投稿を参照してください。

@PathVariable is to obtain some placeholder from the uri (Spring call it an URI Template) — see Spring Reference Chapter 16.3.2.2 URI Template Patterns
@RequestParam is to obtain an parameter — see Spring Reference Chapter 16.3.3.3 Binding request parameters to method parameters with @RequestParam

このURLを想定 http:// localhost:8080/SomeApp/user/1234/invoices?date = 12-05-201 (今日のユーザー1234の請求書を取得するため)

@RequestMapping(value="/user/{userId}/invoices", method = RequestMethod.GET)
public List<Invoice> listUsersInvoices(
            @PathVariable("userId") int user,
            @RequestParam(value = "date", required = false) Date dateOrNull) {
  ...
}
6
Viresh