プロパティファイルの@RequestMapping値

投稿日: 2022-11-09 2022-11-09
タグ: Spring Web

1. 概要

このチュートリアルでは、プロパティファイルで@RequestMapping値を設定する方法を見ていきます。また、必要なすべての構成を説明する実際的な例を使用します。

まず、基本的な@RequestMappingとその構成を定義しましょう。

2. @ RequestMappingの基本

まず、クラスWelcomeControllerを作成して@RequestMappingでアノテーションを付け、Webリクエストをマップします。このクラスは、ハンドラーメソッド getWelcomeMessage（）。を割り当てます。

それで、それを定義しましょう：

@RestController
@RequestMapping("/welcome")
public class WelcomeController {

   @GetMapping
   public String getWelcomeMessage() {
       return "Welcome to Baeldung!";
   }
}

また、 getWelcomeMessage（）に@GetMappingアノテーションを付けて、GETリクエストのみをマップすることに注意してください。ご覧のとおり、パスにはハードコードされた文字列を使用しており、アクセスするパスを静的に示しています。この構成を使用すると、以下に示すように、関心のあるリソースに完全にアクセスできます。

curl http://localhost:9006/welcome
> Welcome to Baeldung!

しかし、パスを構成パラメーターに依存させたい場合はどうでしょうか。次に説明するように、application.propertiesを利用できます。

3. @ RequestMappingおよびプロパティファイル

まず、ドキュメントでわかるように、@RequestMappingアノテーションのパターンはローカルプロパティやシステムプロパティおよび環境変数に対して${…}プレースホルダーをサポートします。このようにして、プロパティファイルをコントローラーにリンクできます。

一方では、プロパティファイル自体を作成する必要があります。 これをresourcesフォルダーに配置し、application.propertiesという名前を付けます。次に、選択した名前でプロパティを作成する必要があります。この例では、 welcome-controller.path という名前を設定し、リクエストのエンドポイントとして必要な値を設定します。これで、application.propertiesは次のようになります。

welcome-controller.path=welcome

一方、 @RequestMappingで静的に確立したパスを変更して、作成した新しいプロパティを読み取る必要があります：

@RestController
@RequestMapping("/${welcome-controller.path}")
public class WelcomeController {
    @GetMapping
    public String getWelcomeMessage() {
        return "Welcome to Baeldung!";
    }
}

したがって、このようにして、Springはエンドポイントの値をマップでき、ユーザーがこのURLにアクセスすると、このメソッドがその処理を担当します。同じリクエストで同じメッセージがどのように表示されるかを以下に示します。

curl http://localhost:9006/welcome 
> Welcome to Baeldung!

4. 結論

この短い記事では、プロパティファイルで@RequestMapping値を設定する方法を学びました。さらに、説明されている概念を理解するのに役立つ完全に機能する例を作成しました。

記事の完全なソースコードは、GitHubでから入手できます。

getdocs

13036