devkuma – Spring Boot

Spring Boot

kc@example.com (kc kim) — Tue, 15 Aug 2017 22:34:03 +0900

Spring Boot

Spring Boot 概要

kc@example.com (kc kim) — Tue, 15 Aug 2017 22:34:03 +0900

Spring Boot とは

Spring プロジェクトが提供するさまざまなライブラリとフレームワークを素早く利用できるようにするフレームワークである。
Dropwizard の Spring 版のようなものである。
ビルドすると単一の jar ファイルが作成される。
- Web アプリケーションの場合、組み込み Tomcat を起動する（Jetty や Undertow に切り替え可能）。
- Web アプリケーションではなく、通常の Java プログラムとしても動作させることができる。
Maven や Gradle などのビルドツールを使用する。（Ant では不可）
使用したいコンポーネントを依存関係として追加すると、統合に必要な設定が自動的に行われる。
Spring アプリケーションを独立して作成、ビルド、実行でき、Embedded Tomcat、Jetty を使用できるため、WAR ファイルにまとめてデプロイする必要がない。
Tomcat や Jetty が組み込まれており、プロジェクトを .jar ファイル形式で簡単にデプロイできる。
複雑な XML 設定を簡素化し、アノテーションベースの Java config に置き換えることで、サーバー設定を容易にできる。
Django や Ruby on Rails のように、Web プロジェクトを素早く作成できる。

Spring Boot の自動設定

@SpringBootApplication
- @Configuration、@EnableAutoConfiguration、@ComponentScan をデフォルトで一緒に使用するという意味である。
@Configuration
- クラスの上に宣言する。
- クラス内に 1 つ以上の @Bean メソッドを提供し、Spring コンテナが該当 Bean を生成、管理できるようにする。
@EnableAutoConfiguration
- embedded Tomcat サーバー設定、Spring MVC の DispatcherServlet 自動登録など、さまざまな基本設定作業を行う。
@ComponentScan
- @Component、@Service、@Repository、@Controller が付与された class を自動で scan し、Bean として登録する。

Spring 初期プロジェクトの作成

kc@example.com (kc kim) — Sat, 13 Aug 2022 09:49:00 +0900

Spring Initializr

Spring Initializr は、条件に合わせて初期 Spring Boot プロジェクトを生成する Web サービスである。Web UI でプロジェクト設定と使用する Spring Project を指定すると、Spring Boot プロジェクト開発を簡単に始めることができる。

curl を使用した Spring Initializr

Spring の検証などで何度もプロジェクトをスキャフォールドまたはビルドする場合、Web UI での作業は手間がかかる。そのため、ここでは curl を使用して Spring Initializr の API にアクセスし、初期プロジェクトを作成する。

% curl https://start.spring.io/
  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
:: Spring Initializr ::  https://start.spring.io

This service generates quickstart projects that can be easily customized.
Possible customizations include a project's dependencies, Java version, and
build system or build structure. See below for further details.

The services uses a HAL based hypermedia format to expose a set of resources
to interact with. If you access this root resource requesting application/json
as media type the response will contain the following links:
+-----------------+------------------------------------------+
| Rel             | Description                              |
+-----------------+------------------------------------------+
| gradle-build    | Generate a Gradle build file.            |
| gradle-project  | Generate a Gradle based project archive. |
| maven-build     | Generate a Maven pom.xml.                |
| maven-project * | Generate a Maven based project archive. |
+-----------------+------------------------------------------+


The URI templates take a set of parameters to customize the result of a request
to the linked resource.
+-----------------+------------------------------------------+------------------------------+
| Parameter       | Description                              | Default value                |
+-----------------+------------------------------------------+------------------------------+
| applicationName | application name                         | DemoApplication              |
| artifactId      | project coordinates (infer archive name) | demo                         |
| baseDir         | base directory to create in the archive  | no base dir                  |
| bootVersion     | spring boot version                      | 2.7.2                        |
| dependencies    | dependency identifiers (comma-separated) | none                         |
| description     | project description                      | Demo project for Spring Boot |
| groupId         | project coordinates                      | com.example                  |
| javaVersion     | language level                           | 17                           |
| language        | programming language                     | java                         |
| name            | project name (infer application name)    | demo                         |
| packageName     | root package                             | com.example.demo             |
| packaging       | project packaging                        | jar                          |
| type            | project type                             | maven-project                |
| version         | project version                          | 0.0.1-SNAPSHOT               |
+-----------------+------------------------------------------+------------------------------+

... 省略 ...

Examples:

To create a default demo.zip:
	$ curl -G https://start.spring.io/starter.zip -o demo.zip

To create a web project using Java 11:
	$ curl -G https://start.spring.io/starter.zip -d dependencies=web \
			-d javaVersion=11 -o demo.zip

To create a web/data-jpa gradle project unpacked:
	$ curl -G https://start.spring.io/starter.tgz -d dependencies=web,data-jpa \
		   -d type=gradle-project -d baseDir=my-dir | tar -xzvf -

To generate a Maven POM with war packaging:
	$ curl -G https://start.spring.io/pom.xml -d packaging=war -o pom.xml

Spring Boot Web アプリケーションの起動

kc@example.com (kc kim) — Tue, 15 Aug 2017 22:34:03 +0900

Web アプリケーションの起動

ここでは Spring Boot - Hello World を修正する。

Web アプリケーションの依存関係変更

build.gradle

dependencies {
-   compile 'org.springframework.boot:spring-boot-starter'
+   compile 'org.springframework.boot:spring-boot-starter-web'
}

Web アプリケーションを作成する場合は、spring-boot-starter-web モジュールを使用する。
基本的に Spring MVC を使用して Web アプリケーションを作成することになる。

起動方法の変更

サーバー起動後にコンテナが終了してしまうため、try-with-resources 文を使用しないように変更する。

src/main/java/sample/springboot/Main.java

package sample.springboot;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Main {

    public static void main(String[] args) {
        SpringApplication.run(Main.class, args);
    }
}

Spring MVC コントローラークラス

Web API のエントリーポイント（Entry point）となるクラスを作成する場合、クラスに @RestController を付与する。
Web API ではなく MVC の C となるコントローラーが必要であれば、@Controller アノテーションを付与する。
@RequestMapping でパスおよび HTTP メソッドをマッピングする（おおよそ JAX-RS に似た雰囲気である）。

src/main/java/sample/springboot/web/HelloController.java

package sample.springboot.web;

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

@RestController
@RequestMapping("/hello")
public class HelloController {

    @RequestMapping(method=RequestMethod.GET)
    public String hello() {
        return "Hello Spring MVC";
    }
}

アプリケーションの実行

Gradle で実行

$ gradle bootRun
(省略)
> :bootRun

curl でテスト

$ curl http://localhost:8080/hello
Hello Spring MVC

ソースコード

https://github.com/devkuma/tutorial/tree/master/spring-boot-hello-world-2

Spring Boot サーバーポート番号の変更

kc@example.com (kc kim) — Tue, 15 Aug 2017 22:34:03 +0900

サーバーポート番号を変更する

application.properties 設定ファイルで server.port によりポート番号を指定できる。

次のように設定ファイルを変更する。 application.properties

server.port=1598

アプリケーション実行

$ gradle bootRun
(省略)
2017-08-17 22:30:13.211  INFO 14485 --- [           main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 1598 (http)
(省略)

説明

application.properties についての説明はこちら。
その他にも、次のような変更が可能である。
- server.address: サーバーアドレス。localhost にするとローカルからのみアクセスできる。
- server.sessionTimeout: セッションタイムアウト時間。