Javaの@RequestMappingアノテーションの使い方を完全ガイド！初心者でもわかる基本と実践

1. @RequestMappingアノテーションとは？

1. @RequestMappingアノテーションとは？

JavaのSpringフレームワークでは、@RequestMappingアノテーションは、特定のURLパスに対してHTTPリクエストをマッピングするために使われます。これにより、クライアントからのリクエストがどのメソッドで処理されるかを決定することができます。

例えば、Webアプリケーションでユーザーのリクエストに応じて、異なるページやデータを表示させたい時に@RequestMappingを使用します。@GetMappingや@PostMappingなどの派生アノテーションもありますが、@RequestMappingはこれらすべての基礎となるアノテーションです。

2. 基本的な@RequestMappingの使い方

2. 基本的な@RequestMappingの使い方

まずは、@RequestMappingの基本的な使い方を見ていきましょう。

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @RequestMapping("/hello")
    public String sayHello() {
        return "Hello, Spring!";
    }
}

上記の例では、/helloというURLにアクセスすると、「Hello, Spring!」というメッセージが表示されます。@RequestMapping("/hello")がURLパスを指定しており、そのパスにリクエストが来ると、sayHello()メソッドが実行されます。

3. HTTPメソッドの指定（GET, POSTなど）

3. HTTPメソッドの指定（GET, POSTなど）

次に、@RequestMappingでHTTPメソッド（GET, POSTなど）を指定する方法を紹介します。method属性を使って、リクエストの種類を指定できます。

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    @RequestMapping(value = "/user", method = RequestMethod.GET)
    public String getUser() {
        return "Fetching User Data";
    }

    @RequestMapping(value = "/user", method = RequestMethod.POST)
    public String createUser() {
        return "Creating New User";
    }
}

この例では、/userエンドポイントに対して、GETリクエストなら「Fetching User Data」、POSTリクエストなら「Creating New User」が返されます。

4. パスパラメータとクエリパラメータの使い方

4. パスパラメータとクエリパラメータの使い方

@RequestMappingを使って、URLから動的なパスパラメータを取得することも可能です。例えば、ユーザーIDを指定して情報を取得する方法を見てみましょう。

import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ProfileController {

    @RequestMapping("/profile/{userId}")
    public String getProfile(@PathVariable String userId) {
        return "Profile for user: " + userId;
    }
}

この場合、/profile/123のようにアクセスすると「Profile for user: 123」といったレスポンスが返されます。

実行結果

Profile for user: 123

5. @RequestMappingの応用：パラメータの条件指定

5. @RequestMappingの応用：パラメータの条件指定

さらに応用として、クエリパラメータを使ってリクエストを条件分岐させることもできます。

import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class SearchController {

    @RequestMapping("/search")
    public String search(@RequestParam String keyword) {
        return "Results for: " + keyword;
    }
}

このコードでは、/search?keyword=Springというリクエストに対して「Results for: Spring」というレスポンスを返します。

6. クラスレベルの@RequestMappingで共通パスを指定する

6. クラスレベルの@RequestMappingで共通パスを指定する

@RequestMappingはメソッドだけでなくクラスに付与することもできます。クラスに指定したパスは「共通のプレフィックス」として扱われ、同じコントローラー内の複数メソッドに共通のURLを持たせたい時に便利です。

例えば、ユーザーに関するAPIをまとめたい場合、クラスに@RequestMapping("/users")を付けると、メソッド側ではその下の階層だけを書けばよくなり、URL設計が整理されます。

@RestController
@RequestMapping("/users")
public class UserApiController {

    @RequestMapping("/list")
    public String listUsers() {
        return "ユーザー一覧を取得しました";
    }

    @RequestMapping("/info")
    public String userInfo() {
        return "ユーザー情報を表示します";
    }
}

このように@RequestMappingをクラスとメソッドで組み合わせることで、API設計が見やすくなり、URLの階層構造が整理されます。

7. @RequestMappingと@GetMapping / @PostMappingとの違い

7. @RequestMappingと@GetMapping / @PostMappingとの違い

@RequestMappingはHTTPメソッドやURLパスなどを柔軟に指定できる反面、記述が少し長くなりがちです。そのためSpring 4.3以降では、用途に応じた派生アノテーションである@GetMappingや@PostMappingが用意されています。

例えばGET専用の処理なら@GetMappingを使うとスッキリ書けます。

// @RequestMappingを使う場合
@RequestMapping(value = "/hello", method = RequestMethod.GET)
public String hello() { return "Hello"; }

// @GetMappingを使った場合（省略形）
@GetMapping("/hello")
public String hello() { return "Hello"; }

機能的にはどちらも同じ結果になりますが、可読性や保守性の面では@GetMappingなどの専用アノテーションを使うのが一般的です。ただし、複数条件を組み合わせたい場合は@RequestMappingが役立ちます。

8. @RequestMappingを使ったパラメータのバリデーション設計

8. @RequestMappingを使ったパラメータのバリデーション設計

Webアプリケーションでは、受け取るパラメータをそのまま処理すると不正な値が入り、エラーにつながる可能性があります。@RequestMappingでは@RequestParamや@PathVariableと組み合わせてバリデーションを明示することで、安全なAPIを設計できます。

@RequestMapping("/age")
public String checkAge(@RequestParam(required = true) Integer age) {
    if (age < 0) return "年齢は0以上を指定してください";
    return "入力された年齢: " + age;
}

required=trueを付けることで、パラメータが指定されていない場合にエラーを返せるため、API利用者に正しい使い方を促せます。安全で信頼性のあるREST APIを作るためには、こうしたチェックを積極的に行うことが大切です。

まとめ

まとめ

この記事を通して、JavaのSpringフレームワークで使用される@RequestMappingアノテーションについて詳しく学びました。@RequestMappingを使うことで、特定のURLに対してHTTPリクエストを簡単にマッピングし、Webアプリケーションのルーティングを制御できるようになります。基本的な使い方から、GETやPOSTなどのHTTPメソッドの指定方法、さらにはパスパラメータやクエリパラメータの利用方法についても解説しました。

特に、API開発においては@RequestMappingを活用することで、URLパターンに応じたメソッドの処理が可能になり、シンプルでメンテナンスしやすいコードを書くことができます。また、HTTPメソッドを明示的に指定することで、処理の安全性を高めることもできます。これにより、よりセキュアで効率的なWebアプリケーションを構築できるようになります。

サンプルプログラムで復習しよう

最後に、これまで学んだ内容をまとめたサンプルプログラムを紹介します。以下のプログラムでは、異なるHTTPメソッドやパスパラメータ、クエリパラメータの使い方をすべて網羅しています。

import org.springframework.web.bind.annotation.*;

@RestController
public class DemoController {

    // 基本的なGETリクエスト
    @RequestMapping(value = "/hello", method = RequestMethod.GET)
    public String sayHello() {
        return "Hello, Spring!";
    }

    // パスパラメータの使用
    @RequestMapping("/user/{id}")
    public String getUserById(@PathVariable int id) {
        return "User ID: " + id;
    }

    // クエリパラメータの使用
    @RequestMapping("/search")
    public String search(@RequestParam String keyword) {
        return "Searching for: " + keyword;
    }

    // POSTリクエストの処理
    @RequestMapping(value = "/submit", method = RequestMethod.POST)
    public String handlePost(@RequestBody String data) {
        return "Data submitted: " + data;
    }
}

実行結果例

GET /hello
=> Hello, Spring!

GET /user/10
=> User ID: 10

GET /search?keyword=Java
=> Searching for: Java

POST /submit with body "Test Data"
=> Data submitted: Test Data

この記事を読んだ人からの質問

この記事を読んだ人からの質問

プログラミング初心者からのよくある疑問／質問を解決します

@RequestMappingアノテーションとは何ですか？Spring MVCで何のために使うのですか？

@RequestMappingは、JavaのSpringフレームワークにおいて、特定のURLに対するHTTPリクエストを処理するためのアノテーションです。Webアプリケーションでどのメソッドがどのリクエストを処理するかを指定するために使われます。