【Java】「Spring Boot」でAPIの作成。「Hello World！」を返すサンプル。

どうも、とがみんです。

この記事では、Javaの「Spring Boot」というフレームワークを使用して、「Hello World！」を返すプログラムの作成方法について紹介しています。

開発環境には「STS(Spring Tools Suite)」を利用しているので、開発環境の構築がまだの場合は以下の記事を参考にしてください。

Contents

作成するもの
作成手順
プログラムの実行
まとめ
参考文献

作成するもの

今回作成するものは、ブラウザ上でhttp://localhost:8080/helloを入力すると、「Hello World！」が表示されるプログラムです。

これを、Javaの「Spring Boot」というフレームワークを利用して作成します。

作成手順

作成の手順として、以下のステップで説明していきます。

Spring Boot でのプロジェクトの作成
デフォルトで用意されているファイルの説明
「Hello World !」を表示するプログラムの作成

Spring Boot でのプロジェクトの作成

まず、Spring Bootを使用したプロジェクトの作成方法について紹介してきます。

以下の図のように、ファイル→新規→Springスターター・プロジェクトを選択します。

次に、プロジェクト名を入力し、次へボタンを押します。

次に、使用するフレームワークを選択します。

今回は、Webに「Hello World !」と表示するプログラムを書くので、「Spring Web スターター」にチェックし、「完了」ボタンを押します。

Webスターターをチェックすることで、「Spring MVC」、「Tomcat」、「Jackson」のようなライブラリを使用することができます。

完了ボタンを押すと、以下のようなディレクトリ構成のフォルダ、ファイルが生成されます。

次に、src/main/java/com.example.dem/のフォルダにデフォルトで、HelloApplication.javaというファイルが入っているので、それについて説明します。

デフォルトで用意されているファイルの説明

src/main/java/com.example.dem/のフォルダにデフォルトで入っている、HelloApplication.javaというファイルに書かれているプログラムについて説明していきます。

HelloApplication.javaのファイルに書かれているコードは以下のような感じです。

package com.example.demo;//①パッケージの指定。
 
 //②「import」で他のパッケージ内のクラスやインターフェイスを参照する。
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 
 @SpringBootApplication//③アノテーション
 public class HelloApplication {
 	//④mainメソッド
 	public static void main(String[] args) {
 		SpringApplication.run(HelloApplication.class, args);
 	}
 }

package com.example.demo;//①パッケージの指定。

//②「import」で他のパッケージ内のクラスやインターフェイスを参照する。

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication//③アノテーション

public class HelloApplication {

//④mainメソッド

public static void main(String[] args) {

SpringApplication.run(HelloApplication.class, args);

}

上のコード中の番号に合わせて説明していきます。

①パッケージの指定

パッケージとは、Javaのクラスをまとめて分類するための仕組みです。
クラスの先頭で「package」と宣言することで、そのクラスが分類されるパッケージを指定することができます。もし、パッケージが未指定だと、デフォルトパッケージに分類されます。

②クラス・インターフェースを参照

importを利用することで、他のパッケージ内のクラスやインターフェースを利用することができます。

③アノテーション

「アノテーション」とは、あるデータに対して、関連する情報を付与し、コンパイラや実行環境に対してプログラムがどういうものかを伝えるものです。

@SpringBootApplicationをつけることで、HelloApplicationクラスが、Spring Bootの起動クラスであることを伝え、起動に必要な機能や設定が自動で組み込まれるようになってます。

＞18. Using the @SpringBootApplication Annotation

④mainメソッド

mainメソッドは、プログラムを実行する時に最初に呼び出されるメソッドです。

mainメソッドでは、SpringApplication.run(HelloApplication.class, args);が実行されていますが、これが、Spring Bootによるアプリケーションを起動するための処理です。

これが実行されることで、APIを受けれるようになります。

「Hello World !」を表示するプログラムの作成

最後に、http://localhost:8080/helloというリクエストに対して、「Hello World !」と返すプログラムを作成します。

以下の図のように、新規→クラスで、新しいクラスのファイルを作成します。

以下の新規Javaクラス作成用のWindowが表示されるので、クラス名を入力し、完了ボタンを押します。

以下のコードがかかれたファイルが生成されます。

package com.example.demo;
 public class HelloControler {
 }

package com.example.demo;

public class HelloControler {

}

上記のコードを以下のように変更します。

package com.example.demo;
 
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
 @RestController//①
 public class HelloControler {
 	@RequestMapping("/hello")//②
 	public String helloworld() {
 		return "Hello World!";
 	}
 }