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

第2回

Spring Bootで開発†

↑

vscodeへの拡張機能のインストール†

以下の拡張機能をインストールしておく
- Spring Boot Tools
- Spring Boot Dashboard
- Spring Boot Extension Pack

↑

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

↑

ブラウザから作成†

Spring initializrにアクセス
作成例 :
- Project : Gradle Project
- Language : Java
- Spring Boot : 2.3.1
- Project Metadata
  - Group : jp.kobespiral
  - Artifact : hello
  - Name : hello (Artifactに入力されたものが自動で入ってる)
  - Description : (お好きに…)
  - Package name : jp.kobespiral.hello (ほかのものに合わせて自動で入力されているはず)
  - Packaging : War
  - Java : 8
- あとは依存関係を好きに入れる
  - 最低限「Thymeleaf」・「Lombok」・「Spring Boot DevTools」
[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 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.RequestParam;

@Controller
public class HelloController {
    @GetMapping("/hello")
    public String SayHelloRequestParam(@RequestParam("name") String name, Model model) {
        model.addAttribute("msg",name);
        return "hello";
    }
    

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

アクセス時のレスポンス用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>
  This is hello.html<br>
  <p th:text="${msg}"></p>
  <p th:text="${msgnull}"></p>
  <p>Hello [[${msg}]]. Welcome to Path Param World!</p>
  <p>Hello [[${msgnull}]]. Welcome to Path Param World!</p>
</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.PathVariable;
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(@RequestParam("name") String name) {
        return "Hello " + name +". Welcome to REST Request Param API World!";
    }
    
    @GetMapping("/hello/{name}")
    public String SayHelloRestPathParam(@PathVariable String name) {
        return "Hello "+ name +". Welcome to REST Path Param API World!";
    }
}

↑

実行編†

テスト方法1(SpringBootに内包されたtomcatを利用)
- javaファイルを開いてる状態で，[F5]を押す
- vscode上でTomcatが起動
- SayHelloRequestParam → http://localhost:8080/hello?name=KobeTaro にアクセスすると，hello.html が返り，Thymeleafでパラメータなどがhtml内に埋め込まれている
- SayHelloPathParam → http://localhost:8080/hello/KobeTaro にアクセスすると，hello.html が返り，Thymeleafでパラメータなどがhtml内に埋め込まれている
- SayHelloRestRequestParam → http://localhost:8080/api/hello?name=KobeTaro にアクセスすると，Hello REST API World! が表示される
- SayHelloRestPathParam → http://localhost:8080/api/hello/KobeTaro にアクセスすると，Hello test が表示される

テスト方法2（外部tomcatを利用）
- [Ctrl+Shift+@]でターミナルを開き，以下を実行
```
 ./gradlew.bat war
```
- エクスプローラから「プロジェクト\build\libs\」にあるwarを tomcat\webapp\ にデプロイ
- demo.warなら http://localhost:8080/demo/hello?name=World をたたくと "Hello World!"が出力される

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

↑

Thymeleafの動き†

hello.htmlの中であえて存在しない変数名を指定しているが，その場所がどうなっているか書き方による違いで比較してみる

↑

既知の不具合†

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

↑