Spring Boot – 初期プロジェクト作成

はじめに

この記事では、Spring Boot を使用した開発を行う前準備として、プロジェクト作成について、説明しています。
IDE（統合開発環境）には Spring Tool Suite 4（STS4）を使用しています。

プロジェクト作成

プロジェクトを作成します。Spring Initializr にアクセスします。

今回作成するプロジェクトの設定は以下の通りです。
設定内容については自身の環境に合わせて修正してください。

Project	Maven
Spring Boot	v3.2.3
Group	com.kazz_y
Artifact	InitializeProjectSettings
Name	InitializeProjectSettings
Description	Initialize project settings for Spring Boot
Package name	com.kazz_y.InitializeProjectSettings
Packaging	Jar
Java	v17

追加する依存関係は次の通りです。

Spring Boot DevTools
Spring Configuration Processor
Spring Web
Jersey
Spring Data JPA
H2 Database
MariaDB Driver
PostgreSQL Driver
MySQL Driver
Validation
Java Mail Sender
Lombok

こちらから Spring Initializr でのプロジェクトの設定結果を確認できます。
「GENERATE」をクリックして、zip 化されたプロジェクトをダウンロードします。ダウンロードしたプロジェクトを解凍し、STS4 でインポートします。

pom.xml

作成された pom.xml がこちらになります。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.2.3</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.kazz_y</groupId>
    <artifactId>InitializeProjectSettings</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>InitializeProjectSettings</name>
    <description>Initialize project settings for Spring Boot</description>
    <properties>
        <java.version>17</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jersey</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-mail</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>com.h2database</groupId>
            <artifactId>h2</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>com.mysql</groupId>
            <artifactId>mysql-connector-j</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.mariadb.jdbc</groupId>
            <artifactId>mariadb-java-client</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.postgresql</groupId>
            <artifactId>postgresql</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

初期設定

ここからは、出来上がったプロジェクトに簡単な初期設定を行っていきます。

application.yml

読み易さを考慮して設定ファイルは、 application.properties から application.yml に変更します。
application.yml には、読み込むプロファイルのみを記載しています。

spring:
  profiles:
    active:
    - local

application-local.yml

ローカル開発用に application.yml と同じ階層に application-local.yml を作成し、以下のように定義します。
設定内容については自身の環境に合わせて修正してください。

server:
  port: 8080

spring:
## database
  datasource:
    url: jdbc:h2:mem:kazz_y;
    username: sa
    password: 
#  datasource:
#    url: jdbc:postgresql://localhost:15432/kazz_y
#    username: kazz_y
#    password: kazz_y
#  datasource:
#    url: jdbc:mysql://localhost:13306/kazz_y
#    username: kazz_y
#    password: kazz_y
#  datasource:
#    url: jdbc:mariadb://localhost:13307/kazz_y
#    username: kazz_y
#    password: kazz_y

## jpa
  jpa:
    show-sql: true
    properties:
      hibernate:
        '[format_sql]': true
        '[highlight_sql]': true
        '[jdbc.time_zone]': Asia/Tokyo
    open-in-view: true
    hibernate.ddl-auto: create-drop

  h2.console.enabled: true

動作確認

以下の手順でプロジェクトを起動してみます。
「プロジェクト名」を右クリック
「デバッグ」→「Spring Boot アプリケーション」

コンソールログを確認し、以下のような Tomcat の起動ログが確認できれば起動完了です。

Tomcat started on port 8080 (http)

以下URLにアクセスします。
http://localhost:8080

エラーページが表示されますが、動作していることが確認できます。

最後に

プロジェクトの新規作成を行い、動作検証まで行いました。
次回は、証明書を作成および設定し、SSL 化を行います。

Spring Boot – プロジェクトの新規作成