@PathVariable

@PathVariable() は、コントローラーの引数を、/books/{isbn} の isbn のようなマッピングのパスの {variable} にバインドします。

使う理由

パスがリソースを指す場合(/books/978-0、/authors/42/books)、値はクエリではなくパスに置くべきです。このアノテーションは一致したパスから値を取り、デコードして引数の型に変換するため、メソッドは解析が必要なテキストではなく int や enum を受け取ります。

例

import 'package:spring_boot_starter_web/spring_boot_starter_web.dart';

enum Format { pdf, epub }

@RestController()
class BookController {
  // GET /books/978-0: isbn は '978-0'。
  @GetMapping('/books/{isbn}')
  String find(@PathVariable() String isbn) => 'book $isbn';

  // 引数の名前が変数と異なるので、名前を指定する。
  // GET /authors/42/books: authorId は 42。/authors/x/books は 400。
  @GetMapping('/authors/{id}/books')
  String byAuthor(@PathVariable('id') int authorId) => 'author $authorId';

  // 正規表現で数字だけを通す: /orders/abc は 404。
  @GetMapping(r'/orders/{id:\d+}')
  String order(@PathVariable() int id) => 'order $id';

  // enum は大文字小文字を問わず名前で: /downloads/978-0/EPUB。
  @GetMapping('/downloads/{isbn}/{format}')
  String download(@PathVariable() String isbn, @PathVariable() Format format) =>
      '$isbn as ${format.name}';

  // パスの残り、先頭のスラッシュ付き:
  // GET /files/docs/a/b.txt: path は '/docs/a/b.txt'。
  @GetMapping('/files/{*path}')
  String file(@PathVariable() String path) => path;

  // 1 つのセグメントからリスト: GET /books/batch/1,2,3: ids は [1, 2, 3]。
  @GetMapping('/books/batch/{ids}')
  List<int> batch(@PathVariable() List<int> ids) => ids;
}

パラメーター

名前 型 デフォルト 意味
name(位置引数) String? null パス変数の名前。null なら Dart の引数と同じ名前の変数。

ルール

Spring (Java) との対応

@GetMapping("/authors/{id}/books")
List<Book> byAuthor(@PathVariable("id") int authorId) { ... }

重要な違い:

関連項目