@RestController

@RestController() は、メソッドが HTTP リクエストに応答するクラス、つまり REST コントローラーを示します。クラスは Bean であり、マッピングアノテーションを持つすべてのメソッドがエンドポイントになります。

使う理由

Web API の出発点です。クラスは @Component と同じく Bean なので、依存はコンストラクターから受け取ります。スターターは各リクエストを、マッピング(@GetMapping、@PostMapping など)がそのメソッドとパスに一致するメソッドに送り、リクエストから引数を埋め、戻り値をボディとして書きます。オブジェクトなら JSON、String ならテキストです。

HTTP に応答するすべてのクラスに使ってください。ビジネスロジックはサービスに置き、コントローラーには HTTP とそれらのサービスの間の変換をさせます。

例

import 'package:spring_boot_starter_web/spring_boot_starter_web.dart';

class Book {
  const Book({required this.isbn, required this.title});

  final String isbn;
  final String title;
}

@Service()
class BookService {
  Future<Book> find(String isbn) async => Book(isbn: isbn, title: 'Dune');
}

@RestController()
@RequestMapping('/api/books')
class BookController {
  BookController(this.books);

  final BookService books;

  // GET /api/books/978-0 は本を JSON で返す。
  @GetMapping('/{isbn}')
  Future<Book> find(@PathVariable() String isbn) => books.find(isbn);

  // マッピングのない普通のメソッドはエンドポイントではない。
  String describe(Book book) => '${book.title} (${book.isbn})';
}

// 名前で Bean を探すコードのための、明示的な Bean 名。
@RestController('adminBooks')
@RequestMapping('/admin/books')
class AdminBookController {
  @GetMapping('/count')
  int count() => 1;
}

クラスに付けた @ResponseStatus は、自身のステータスを持たないすべてのメソッドのステータスを設定します。

// このコントローラーのすべてのメソッドは 202 Accepted で応答する。
@RestController()
@RequestMapping('/api/jobs')
@ResponseStatus(HttpStatus.accepted)
class JobController {
  @PostMapping()
  void start() {}

  // メソッド自身のアノテーションが優先される。
  @GetMapping('/health')
  @ResponseStatus(HttpStatus.ok)
  String health() => 'UP';
}

パラメーター

名前 型 デフォルト 意味
name(位置引数) String? null Bean 名。null ならクラス名の lowerCamelCase(bookController)。

ルール

Spring (Java) との対応

@RestController
@RequestMapping("/api/books")
class BookController {
  private final BookService books;

  BookController(BookService books) { this.books = books; }

  @GetMapping("/{isbn}")
  Book find(@PathVariable String isbn) { return books.find(isbn); }
}

重要な違い:

関連項目