アプリケーションの起動

HelloWorldコントローラーの作成

@Controller

HTTPメソッドのマッピング（GET,POST,PUT,DELETE）

ステータスコードの返却

Jacksonを利用したJSONの返却

SpringBootのアプリケーション実行までを行うレッスンです。
Webアプリケーションの基礎となるコントローラーを学習し、Springフレームワークの動作の基本を身に着けることができるようになります。

「SpringBootアプリケーションの実行」レッスンの総復習クイズです。

SpringBootアプリケーションの実行の総復習クイズ

SpringBootアプリケーションの実行

@RequestParam

@PathVariable

POJOの利用

@Component

@Service,@Repository

@Autowired

@Qualifer

SpringBootの基本技術を学ぶレッスンです。
ユーザーからのパラメータの受け取り方法や、既存のオブジェクトの利用、DIコンテナ技術などを学習し、Springフレームワークの、開発現場で用いられる基礎知識を身に着けることができます。

「SpringBoot基礎」レッスンの総復習クイズです。

SpringBoot基礎の総復習クイズ

SpringBoot基礎

最低限の構成のアプリケーション作成

商品クラスの作成と利用

検索ロジッククラスの作成

検索ロジック本番用クラスの作成

パラメータの対応、商品情報の検索機能追加

個数パラメータへの対応1

個数パラメータへの対応2

POSTメソッドの対応

SpringBootの基本技術を使い、商品情報を返却するAPIを作成するレッスンです。
Springフレームワークを使った簡単なアプリケーション作成を通し、各学習要素への理解を深めていきます。

商品検索APIの作成

ご自身のパソコン（ローカル）上で実際にSpringBootのアプリ作成の準備をします。簡単なアプリの実行まで体験してみましょう。


SpringBootのローカル開発準備（環境構築）

## Spring Bootとは？

Spring Boot（スプリング・ブート）は、Javaで作られたウェブアプリケーションを比較的容易に作成できるフレームワークです。

フレームワークとは、プログラムを作るための土台や道具のことです。例えば、レゴブロックを使って何かを作るときに使う「レゴセット」のようなものです。
レゴブロック無しで例えば、恐竜のような作品を作るのは大変ですね。でも、レゴ恐竜セットを使うと、基本的なブロックや組み立て方が揃っているので、ゼロから全てを準備する必要がなく、簡単に作品を作ることができます。また、あなたの創造力に応じてブロックを追加したり、形を変えたりすることもできます。

同じように、Spring Bootを使うと、基本的な素材/道具があり、基本的な枠組みができているので、複雑な設定をしなくてもすぐにアプリケーションを作り始めることができるようになります。

## このチュートリアルの目的
このチュートリアルでは、Spring Bootを使って簡単なウェブアプリケーションを作る環境を整える方法を説明します。主には、以下のことを学びます。

1. 必要なソフトウェアのインストール（開発の準備）
2. Spring Bootプロジェクトの作成方法
3. 簡単なアプリケーションの作成方法

このチュートリアルを終えると、あなたは自分でSpring Bootを使ってアプリケーションを作ることができるようになります。初心者の方でも安心して進められるように、わかりやすく説明していきますので、一緒に頑張りましょう！

はじめに


SpringBootで必要となるソフトウェアのインストール手順はJavaの

Java入門チュートリアル [__2. 必要なソフトウェアのインストール__](https://code-lesson.com/tutorials/e90d2eee-901f-4638-83f5-2115b6c8bd82) と同じ内容です。

すでにEclipseのインストールが済んでいる場合はこのページは飛ばして、次へ進んでください。


必要なソフトウェアのインストール（開発の準備）

## 3.1 Eclipse(Pleiades)の起動
### MacでのEclipse(Pleiades)起動手順
  1. Launchpadを開き、 __Eclipse_2024-MM__ アイコンを探してクリック。
    ![](https://i.gyazo.com/0d01dfddedd78253a194f0bc45379a78.png)     
    
  2. ワークスペース（プロジェクト作成先フォルダ、デフォルトは、 __../workspace__ だが任意のフォルダに変更も可能）ディレクトリを選択して起動ボタンをクリック
   ![](https://i.gyazo.com/c93faba34604b3ac1b58155b931236d3.png)

### WindowsでのEclipse(Pleiades)起動手順
  1. エクスプローラにて解凍先(c:\pleiades\2024-MM\eclipse)フォルダ中のファイル、eclipse.exeをダブルクリック   
  ![](https://i.gyazo.com/1ec3e9f0dc946ce447621bba873b5e03.png)

  2. ワークスペース（プロジェクト作成先フォルダ、デフォルトは、 __../workspace__ だが任意のフォルダに変更も可能）ディレクトリを選択して起動ボタンをクリック
   ![](https://i.gyazo.com/c423f5263f173d02b69c1f58a6bba0d9.png)

## 3.2 ワークスペース全体設定
### 3.2.1 メニューより、設定を選択する
#### Macでの設定の開き方: 画面左上メニュー [Eclipse] - [設定...]
#### Windowsでの設定の開き方: eclipseウィンドウ内メニュー [ウィンドウ(w)] - [設定(p)]

### 3.2.2 設定項目

以下の設定内容を確認・設定する。
(※画像はMacの画面になりますがWindows環境でも設定対象や内容は同様です)

- __一般 > ワークスペース__  
  - テキストファイルエンコード:  __UTF-8__
  - 新規テキストファイルの区切り文字: __Unix__
 ![](https://i.gyazo.com/c213a303775442e701166f94f16fbeec.png)
(※デフォルトで上記設定になっていない場合、その他から選択する)

- __Java > インストール済みのJRE__
  - インストール済みのJRE: __Java17__ のチェックボックスにチェックを入れる  
![](https://i.gyazo.com/05fb1720d50b9117800446ccb2a451c3.png)
- __Java > コンパイラー__
  - コンパイラ準拠レベル: __17__ に変更する 
![](https://i.gyazo.com/d3d8ac8a769bd9351b8e28f5a079fb54.png)

### 3.2.3 任意設定項目 (設定しない場合は読み飛ばしても良い項目です) 

任意設定項目は主にEclipseの見た目を変更する項目です。テーマの変更やフォントの種類・サイズなどお好みで変更してください。
#### `先を急ぐ方、設定の必要性を感じない方はこのセクションは読み飛ばして下さい。後からゆっくり必要になってからでも設定は可能です。`
- __一般 > 外観__
  - ルック＆フィール: __ライト__ / __ダーク__ などの外観全体のテーマが選べます 。  
  ![](https://i.gyazo.com/044c187df19ac43192dc1128275e8ad8.png)
- __一般 > 外観 > 色とフォント__  
以下の設定項目に対して、　__編集ボタン__ よりフォントの種類やサイズを変更できます。
  - 基本 > ダイアログ・フォント
  - 基本 > テキスト・エディター・ブロック選択フォント
  - 基本 > テキスト・フォント
  - 基本 > バナー・フォント
  - 基本 > ヘッダー・フォント
  ![](https://i.gyazo.com/06f1903ab548b712afa0d7d6e590f2cf.png)

### 重要！！
設定の変更を行った場合、 `必ず 適用ボタン もしくは 適用して閉じるボタン で変更内容の反映` を忘れずに行ってください。

## 3.3 新規プロジェクトの作成
### Spring Initializrを使用したプロジェクト作成
1. 新規プロジェクトの作成
  画面左上の新規アイコンをクリック、メニューより [ __Springスターター・プロジェクト(Spring Initializr)__ ] を選択
  ![](https://i.gyazo.com/df07b93a64a4cf0bac469f0d6e0de4f0.png)
2. 新規Springスタータープロジェクト(Spring Initilizr) の設定
   以下の設定項目の修正と確認
   - 名前: demo から __hello__ に変更
   - タイプ: Gradle から __Maven__ に変更 
   - Javaバージョン: 21 から __17__ に変更 
   - 成果物: demo から __hello__ に変更されていることを確認する。変わっていない場合は変更する。 
   - 説明: Demo project for Spring Boot から __Hello__ project for Spring Boot に変更 
   - パッケージ: com.example.demo から com.example.__hello__ に変更 
   ![](https://i.gyazo.com/4cd54a2a724749e4eaa9c622f7f8b3a9.jpg)
    上記設定が済んだら __次へ__ をクリック
3. 新規Springスタータープロジェクト依存関係の設定

    以下の設定項目の内容の確認 
   - Spring Boot バージョン: 3.3.5 
      (※画像では3.3.5ですが実施時期によって変わる可能性があります。デフォルトのままの設定としてください。)
   - 使用頻度高: 以下の項目にチェックを入れる。
      - Spring Boot DevTools
      - Spring Web
      - Lombok
       
   選択済み: 項目にチェックした3項目が表示されていることを確認する。
   ![](https://i.gyazo.com/d14eecd94babf7d5afc4cfc7a923fd5a.jpg)
上記設定後、 __完了__ をクリック
 
4. プロジェクトの確認
  上記手順を実行後、プロジェクトが生成されるのでパッケージエクスプローラーにhelloプロジェクトが作成されていることを確認する。
  ![](https://i.gyazo.com/2dc28c0378ec149f88b05aae7bbb2008.png)



Spring Bootプロジェクトの作成

## ディレクトリ構成の説明
![](https://i.gyazo.com/4bce614160bc7fc3381b9896122cba4e.png)

### src/main/java
Javaのクラスファイル(.java)などが格納されるディレクトリ。

### src/main/resources
設定ファイル(.properties)やテンプレートファイル(.html)、CSS/JS/TSファイルなどのJavaクラスファイル以外のシステムを構成するファイル群が格納されるディレクトリ。

### src/test/java
クラスファイルに対するテストクラス群が格納されるディレクトリ。

## SpringBootプロジェクトを構成する主要なファイル
### pom.xmlファイル
プロジェクトのビルドに必要な依存ライブラリやプラグインを記述するファイルです。Spring Bootのスターター依存関係や、データベースドライバ、テストフレームワークなど、プロジェクトに必要な全ての依存関係をここに定義します。

### application.propertiesファイル
プロジェクトの設定情報を記述するファイルです。データベース接続情報、サーバーポート、ログレベルなど、アプリケーションの動作を制御する様々なプロパティを定義します。


### コントローラクラス
外部からのリクエストを受け付け、処理をサービス層に委譲するクラスです。REST APIのエンドポイントとなるメソッドを定義し、HTTPメソッド（GET、POST、PUT、DELETEなど）に対応した処理を実装します。

### サービスクラス
ビジネスロジックを実装するクラスです。コントローラから受け取ったリクエストに基づいて、必要な処理を実行し、結果を返します。データベースへのアクセスや、他の外部システムとの連携などもこの層で行われます。

### リポジトリクラス
データベースとのやり取りを行うクラスです。データベースからデータを取得したり、データを保存したりするメソッドを定義します。Spring Data JPAを使用することで、データベースへのアクセスを簡素化することができます。

### その他クラス
#### フォームクラス: Webフォームの入力値を保持するクラスです。ユーザーからの入力値を検証したり、エンティティクラスに変換したりする際に使用されます。

#### エンティティクラス: データベースのテーブルに対応するクラスです。データベースのレコードをJavaオブジェクトとして表現し、オブジェクト指向のプログラミングを可能にします。

## 各ファイルの連携
![](https://i.gyazo.com/3d56fa63a4b3a2fff233ce7bbc9c344f.png)
1. クライアントからのリクエスト: ブラウザなどのクライアントからHTTPリクエストが送られます。
2. コントローラ: リクエストを受け取り、適切なサービスメソッドを呼び出します。
3. サービス: ビジネスロジックを実行し、必要に応じてリポジトリを呼び出してデータベースにアクセスします。
4. リポジトリ: データベースからデータを取得したり、データを保存したりします。
5. クライアントへのレスポンス: サービスから返された結果を元に、コントローラはクライアントにレスポンスを返します。

プロジェクトの構成

以前([__3. SpringBootプロジェクトの作成__](https://dev.code-lesson.com/tutorials/e7536b2a-31d4-4d4c-8b2d-37118f356f4a)の __3.3 SpringBootプロジェクトの作成__)に作成したhelloプロジェクトを元に簡単なアプリケーションの作成並びに実行までを行います。

今回のプロジェクトで作成/関連する範囲は以下の図のとおりです。
![image](https://i.gyazo.com/37ce50e1ef339c7bc0fc72adb18adae4.png)


コントローラクラスを作成し、helloプロジェクトを実行し、ブラウザより動作を確認します。
## 5.1 コントローラクラスの作成

コントローラクラスの作成手順は以下のとおりです。
1. 新規クラスの作成(__HelloController.java__)
2. __@RestController__ アノテーションの追記
3. リクエストの処理を行うメソッドの作成
4.  __@GetMapping__ アノテーションにて、3で作成したメソッドとマッピングするURLと紐づける

### 1. 新規クラスの作成(__HelloController.java__)
新規作成より、 __クラス__ を選択
![](https://i.gyazo.com/d5a9e0cf273a27adfb043d863b6dcce2.png)
新規Javaクラスで
  - 名前: __HelloController__

    として __完了__ をクリック
![](https://i.gyazo.com/f597717c798f5cc251fc21a33a278c57.jpg)

src/main/javaディレクトリ内に作成されたHelloController.javaをダブルクリックして開く。

![](https://i.gyazo.com/91cefed31b797631639880e096d2cf5c.png)

出来上がった `HelloController`クラス
~~~java~HelloController
package com.example.hello;

public class HelloController {

}
~~~

### 2. __@RestController__ アノテーションの追記

ソースコード内、クラスの先頭にコントローラクラスとして扱うための`@RestController` アノテーションを追記し、保存する。なお、保存すると自動で `import文` が追記される。

~~~java~HelloController
package com.example.hello;

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

@RestController
public class HelloController {

}
~~~

### 3. リクエストの処理を行うメソッドの作成

続いて、リクエストの処理を行うメソッド、  `hello` メソッドを追記する。

~~~java~HelloController
package com.example.hello;

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

@RestController
public class HelloController {

	public String hello() {
		return "hello";
	}
}
~~~


### 4. __@GetMapping__ アノテーションにて、3で作成したメソッドとマッピングするURLと紐づける

helloメソッドとURLとの紐づけを行うために `@GetMapping` アノテーションを追記する。なお、保存すると自動で `@GetMapping` の `import文` が追記される。

~~~java~HelloController
package com.example.hello;

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

@RestController
public class HelloController {

	@GetMapping("/hello")
	public String hello() {
		return "hello";
	}
}
~~~

#### (補足説明) 上記コード例では `@GetMapping`に指定したURLのパスとメソッド名は `hello` と一致していますが 必ずしも、URLのパスとメソッド名は`一致させる必要はありません。`

## 5.2 アプリケーションの実行

作成したアプリケーションを実行し、ブラウザから確認します。

### 1. アプリケーションの実行
Bootダッシュボードより localサーバー内の  __hello[devtools]__ を選択し、左上の開始ボタンをクリックする。
![](https://i.gyazo.com/eaa30002b00231ac84d76eae7e1d079c.png)

正常にアプリが起動するとコンソールに以下のように表示される。
![](https://i.gyazo.com/81505357d69bc6ac46ded3b5ee36c37c.png)

なお、Macの場合初めて起動するときに以下のような確認画面が表示されるので __許可__ をクリックする。
![](https://i.gyazo.com/385663d899b44fe6e7db013676795921.png)

また、Windowsでも各種ウィルス対策ソフト等より同様のメッセージが表示される場合がある。その場合は同じく、アクセスを許可するようにして下さい。

### 2. ブラウザからアクセスする

ブラウザのアドレスバーに `*http://localhost:8080/hello*` と入力する
![](https://i.gyazo.com/92c3f7dc49ef46f3b474a2816caca522.png)

以下のような結果となることを確認する。
![](https://i.gyazo.com/e2f06842a189676a9ea4a24b05dc1dc3.png)


簡単なアプリケーションの作成と実行

前回作成したhelloアプリケーションを修正してURLにリクエストパラメータ(nameパラメータ)を付与し、パラメータ値に基づいた表示結果となるように変更します。
#### (補足説明)リクエストパラメータはサーバに追加で送信したい変数データのようなもの。URLの後ろに __?__ を付加してその後に `パラメータ名=パラメータ値` という形で付与します。

## 修正結果イメージ
- URLに付与するnameパラメータを yamada とした場合(`?name=yamada`)
![](https://i.gyazo.com/6e16df5560748f199251d6692052a623.png)
- URLに付与するnameパラメータを tanaka とした場合(`?name=tanaka`)
![](https://i.gyazo.com/4544c1e37fda46e9143f9e74fad57bda.png)

## 6.1. HelloControllerの修正

以下の手順で修正を行います。
1. helloメソッドにパラメータを受け取るための引数を追記
2. 引数に@RequestParamアノテーションを追記
3. helloメソッド内の処理を修正

### helloメソッドにパラメータを受け取るための引数を追記

__public String hello()__ から __public String hello(__`String name`__)__ に修正。

~~~java~HelloController
package com.example.hello;

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

@RestController
public class HelloController {

	@GetMapping("/hello")
	public String hello(String name) {
		return "hello";
	}
}
~~~

### 引数に@RequestParamアノテーションを追記

__@RequestParam("name”)__ を引数 `String name`の前に追記。

~~~java~HelloController
package com.example.hello;

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

@RestController
public class HelloController {

	@GetMapping("/hello")
	public String hello(@RequestParam("name") String name) {
		return "hello";
	}
}
~~~

#### (補足説明) 上記コード例の@RequestParam(`"name"`) の`"name"` はURLのリクエストパラメータ名であり、メソッドの引数 String nameと紐付くの設定となる。この設定により引数のname変数にパラメータ値が代入されてhelloメソッドが呼び出される。なお、リクエストパラメータ名とメソッドの引数名は必ずしも一致させる必要はありません(例えば引数名をString namae などとしても良い)。

### helloメソッド内の処理を修正

引数の name に代入されているパラメータ値を文字列連結するように修正します。

~~~java~HelloController
package com.example.hello;

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

@RestController
public class HelloController {

	@GetMapping("/hello")
	public String hello(@RequestParam("name")String name) {
		return "hello, " + name + "さん";
	}
}
~~~

## 6.2 ブラウザより確認
### 1. アプリケーションの実行
Bootダッシュボードより localサーバー内の  __hello[devtools]__ を選択し、左上の開始ボタンをクリックします。
![](https://i.gyazo.com/eaa30002b00231ac84d76eae7e1d079c.png)

### 2. ブラウザのアドレスバーにnameパラメータ値を任意の文字列を入力して確認
アプリケーションが起動したらブラウザのアドレスバーにURLとともに任意のパラメータ値を入力して動作を確認します。
&nbsp;
<実行確認例>
- URLに付与するnameパラメータを yamada とした場合(`?name=yamada`)
![](https://i.gyazo.com/6e16df5560748f199251d6692052a623.png)
- URLに付与するnameパラメータを tanaka とした場合(`?name=tanaka`)
![](https://i.gyazo.com/4544c1e37fda46e9143f9e74fad57bda.png)


作成したアプリケーションのアレンジ

このチュートリアルを通じてSpringBootを用いてWEBアプリを作成する一連の流れを実際に体験していただきましたが、いかがでしたか？

##  学んだことの振り返り
今回学んだ内容をまとめると
- SpringBootとは何なのか
- SpringBootを用いたWEBアプリケーションの構成について
- SpringBootを用いたWEBアプリケーションの作成方法について
- SpringBootを用いたWEBアプリケーションの実行方法について

となります。

## 次のステップ

慣れてきたら、このチュートリアルで学んだ内容をもとに色々といじくり回して、色々と試してみて下さい。

例えば、
- リクエストパラメータを増やしてみる
- 表示する内容をリクエストパラメータの内容によって変化させてみたりする
- パラメータが指定されていない場合の対応を追加する
- 固定メッセージを変更してみる
- 日時や時間を使ったメッセージを追加する
- パラメータに数字を指定して簡単な計算をする

などなど、皆さんの想像力を働かせ、実際にソースコードを改造してみて下さい。
 
## 最後に

学んだことを振り返ることはとても大切です。

振り返ってみて

- あれ？なんのことだったかな？
- どんな手順で何をしたのかな？

と、気づいたときは成長のチャンスです。必要箇所をもう一度、見返して、ああ、そうか！そうだった！という体験をたくさんしましょう。

また、すべてをいっぺんに理解しようと頑張らなくても良いです。とりあえず、最後まで進める事ができたなら、一旦大丈夫です。また振り返れればよいのですから。

今はできたこと・理解できたことを喜びましょう。そしてできた自分を褒めてあげてくださいね。

少しずつでも良いので日々諦めずに挑戦し続けましょう！





まとめ

SpringBootによるアプリケーション作成

Thymeleafの利用

modelの利用

インスタンスの表示(フィールド1)

インスタンスの表示(フィールド2)

インスタンスの表示(メソッド)

リンク式の利用

コメントの記述方法

条件式の利用

繰り返しの利用

ローカル変数の定義

部品分割

【演習】商品リストの表示

SpringBootの画面表示するためのテンプレートエンジン「Thymeleaf」を学びます。
「HTML + 独自の式言語」で記述可能であるThymeLeafの学習を通じて、その概要と、Webアプリケーションの画面表示の基礎を習得します。


SpringBootコース

SpringBootによるアプリケーション作成

0%
SpringBootアプリケーションの実行
1時間0分

0%
SpringBoot基礎
2時間40分

0%
商品検索APIの作成
4時間0分

0%
SpringBootのローカル開発準備（環境構築）
5時間0分

テンプレートエンジン(thymeleaf)

0%
thymeleafの利用
1時間0分

SpringBootコース

SpringBootによるアプリケーション作成

0%SpringBoot基礎2時間40分

.css-omc9ut{fill:var(--chakra-colors-transparent);stroke:rgba(252, 216, 30, 0.87);opacity:0;transition-property:stroke-dasharray,stroke;transition-duration:0.6s;transition-timing-function:ease;}0%商品検索APIの作成4時間0分

.css-148lib3{fill:var(--chakra-colors-transparent);stroke:#000000;opacity:0;transition-property:stroke-dasharray,stroke;transition-duration:0.6s;transition-timing-function:ease;}0%SpringBootのローカル開発準備（環境構築）5時間0分

テンプレートエンジン(thymeleaf)

0%thymeleafの利用1時間0分

0%
SpringBoot基礎
2時間40分

0%
商品検索APIの作成
4時間0分

0%
SpringBootのローカル開発準備（環境構築）
5時間0分

0%
thymeleafの利用
1時間0分