第2回/HelloSpringBoot の履歴(No.9)

Spring Bootで初めての開発†

新規プロジェクトの作成†

Spring initializrにアクセス
作成例 :
- Project : Gradle Project
- Language : Java
- Spring Boot : 2.5.0
- Project Metadata
  - Group : jp.kobespiral
  - Artifact : hello
  - Name : hello (Artifactに入力されたものが自動で入ってる)
  - Description : (お好きに…)
  - Package name : jp.kobespiral.hello (ほかのものに合わせて自動で入力されているはず)
  - Packaging : War
  - Java : 11
- あとは依存関係(Dependencies)を入れる
  - 最低限「Thymeleaf」・「Lombok」・「Spring Boot DevTools」・「Spring Web」
[GENERATE]をクリックすると，プロジェクトのzipがダウンロードされる
解凍してvscodeで開くことで準備完了

build.gradleの末尾に追記

war {
    enabled = true
    archiveName='demo.war' // <-ここはプロジェクトに合わせて書き換えてください
}

↑

Hello World!†

↑

Controller編†

Helloapplication.java, Servletinitializer.javaと同一ディレクトリに，HelloController.javaを作成

package jp.kobespiral.hello;

import java.util.ArrayList;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestParam;

@Controller
public class HelloController {

    private ArrayList<String> list = new ArrayList<>();

    @GetMapping("{name}/hello")
    public String SayHelloRequestParam(@PathVariable String name, Model model) {
        model.addAttribute("greeting", createGreetingMessage());
        model.addAttribute("name", name);
        return "hello";
    }

    @PostMapping("{name}/hello/add")
    public String addHello(@PathVariable String name, @RequestParam("text") String text, Model model) {
        list.add(text);
        model.addAttribute("greeting", text);
        model.addAttribute("name", name);
        return "post_hello";
    }

    private String createGreetingMessage() {
        if (this.list.size() == 0) {
            return "挨拶がまだ登録されていません";
        }
        String greeting = "";
        for (String s : this.list) {
            greeting = greeting + s + "、";
        }
        return greeting;
    }
}

アクセス時のレスポンス用htmlとして，プロジェクト内 src/main/resources/templates に hello.htmlを作成し，以下を記述

<!DOCTYPE html>
<html lang="ja" xmlns:th="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="UTF-8" />
    <title>Hello World</title>
  </head>
  <body>
    <h1>ここはhello.htmlです</h1>
    <div>[あいさつ文]</div>
    <p th:text="${greeting}"></p>

    <div>[本文]</div>
    <p>[[${name}]]さん、Spring Bootへようこそ！</p>

    <div>FORM</div>
    <form action="./add" method="post">
      <div>
        <label for="text">挨拶を入力</label>
        <input name="text" id="text" />
      </div>
      <div>
        <button>POST</button>
      </div>
    </form>
  </body>
</html>

↑

RestController編†

Heloapplication.java, Servletinitializer.javaと同一ディレクトリに，HelloRestController.javaを作成

package jp.kobespiral.hello;

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

@RestController
@RequestMapping("/api")
public class HelloRestController {
    @GetMapping("/hello")
    public String SayHelloRestRequestParam() {
        return "Hello APIをGETで呼び出しました！";
    }

    @PostMapping("/hello")
    public String SayHelloPostMethod(@RequestParam("name") String name) {
        return name + "さん、こんにちは！ hello APIをPOSTで呼び出しました！";
    }
}

↑

実行編†

↑

テスト方法1(SpringBootに内包されたtomcatを利用)†

javaファイルを開いてる状態で，[F5]を押す
vscode上でTomcatが起動する。
以下のリンクから「GET」の挙動を確認できる
- http://localhost:8080/{name}/hello/
  - {name}は各自の名前に変更すること
  - Thymeleafでパラメータなどがhtml内に埋め込まれた状態で、hello.htmlが表示される
- http://localhost:8080/api/hello/
  - RESTで"Hello APIをGETで呼び出しました！"と表示される
- http://localhost:8080/{name}/hello/ の下にあるformからPOSTしてみる
  - Thymeleafでパラメータなどがhtml内に埋め込まれた状態で、post_hello.htmlが表示される
  - http://localhost:8080/manda/hello/add にアクセスしているが、ブラウザに入力して(GETでアクセスして)表示してもエラーになる。
  - POSTメソッドでしかアクセスできないようにしている

Postmanでアクセスしてみる
- メソッドを「POST」に、URLをhttp://localhost:8080/api/hello/ にする

↑

テスト方法2（外部tomcatを利用）†

[Ctrl+Shift+@]でターミナルを開き，以下を実行
```
./gradlew.bat war
```
エクスプローラから「プロジェクト\build\libs\」にあるwarを tomcat\webapp\ に移動(デプロイ)
以下のリンクから挙動を確認できる
- demo.warなら http://localhost:8080/demo/{name}/hello/ をたたくと上と同様の表示になる

2つの実行方法があるが，やり方によってエンドポイント(URL)が変化することに注意すること

↑

既知の不具合†

HTMLファイルのデプロイがうまくいかず，Controller編の呼び出し時にThymeleafが例外を吐いて落ちる場合がある
- 原因：gradleビルドの問題だと思うが詳細は不明
- 対応：プロジェクトの clean Ctrl+Shift+p → Clean the Java language server workspace をしたり，htmlを一旦移動させたりなどしているとうまくいったりする

↑

SpringBootのフォルダ構造†

gradle/wrapper
src
- いろんなソースコードやテスト
- servletInitializer.java
- DemoApplication.java
- main/resources/application.properties
build.gradle
gradlew.dat
settings.gradle

↑