【Spring Boot】PostgresSQLにデータを登録する方法（repository.save()）

【Spring Boot】PostgresSQLにデータを登録する方法

この記事では、前回入力チェックを実装した以下の記事の画面を使って、登録内容をPostgresSQLに保存する方法を説明します。

2021年12月20日【Spring Boot】単項目チェックしてエラーメッセージを表示する（@Validated）

事前準備（PostgresSQLのインストール）
プロジェクトの作成
用意するソース
実行結果

事前準備（PostgresSQLのインストール）

今回はSpringBootプロジェクトからPostgresSQLにデータを登録したいので、予めPostgresSQLをインストールしておく必要があります。
端末にPostgresSQLが入っていない場合は以下よりインストールしてログインできる状態にしておきます。
Download PostgreSQL

プロジェクトの作成

VSCodeでSpringBootのMavenプロジェクトを作成します。
手順は以下の記事を参照。

2021年11月28日【Windows版】VSCodeで始めるSpringBoot(Mavenプロジェクト編)

プロジェクト作成時、以下の6つの依存関係を選択します。6個目(Spring Data JPA)と7個目(PostgresSQL Driver)を選択しておかないとPostgresSQLに接続ができないので注意してください。

Spring Boot DevTools
Spring Web
Thymeleaf
Lombok
validation
Spring Data JPA
PostgresSQL Driver

用意するソース

SpringBootで新規プロジェクトを作成したら、以下のソースを用意して実行できる状態にします。

コントローラー`(BaseController.java)`

前回の記事から少し追記します。

Java

package com.example.demo3.controlloer;

import com.example.demo3.model.Person;
import com.example.demo3.repository.PersonRepository;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.validation.BindingResult;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.PostMapping;

@Controller
public class BaseController{

    private final PersonRepository repository;

    @Autowired
    public BaseController(PersonRepository repository){
        this.repository = repository;
    }

    @GetMapping("/")
    public String home(@ModelAttribute Person person) {
      return "form";
    }

    @PostMapping("/form")
    public String result(@Validated
                        @ModelAttribute Person person,
                        BindingResult result){
        if(result.hasErrors()){
            return "form";
        }
        repository.save(person);
        return "result";
    }
}

解説

@Autowiredアノテーション
Springが自動的にオブジェクトを注入します。コンストラクタインジェクションといいます。

解説

DBに登録するには以下のコードを実行します。
repository.save(person);

モデル`(Person.java)`

前回の記事から少し追記します。

Person.java

package com.example.demo3.model;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
import javax.validation.constraints.Email;
import javax.validation.constraints.Min;
import lombok.Data;

@Entity
@Data
public class Person {

    @Id
    @GeneratedValue
    private long id;

    /**
     * <p>項目名：名前</p>
     * <p>必須入力かつ、最大10文字まで</p>
     */
    @NotBlank
    @Size(max=10)
    private String name;


    /**
     * <p>項目名：年齢</p>
     * <p>1以上</p>
     */
    @NotNull
    @Min(1)
    private Integer age;

    /**
     * <p>項目名：職業</p>
     * <p>必須入力かつ、最大10文字まで</p>
     */
    @NotBlank
    @Size(max=10)
    private String business;

    /**
     * <p>項目名：メールアドレス</p>
     * <p>条件：必須入力かつ、最大64文字まで</p>
     */
    @NotBlank
    @Email
    @Size(max=64)
    private String email;
}

解説

@Entityアノテーション
エンティティクラスであることを示します。
@Idアノテーション
このアノテーションを付与した項目が、テーブルの主キー項目になります。
@GeneratedValueアノテーション
主キーの値を自動採番します。

リポジトリ`(PersonRepository.java)`

com.example.demo3.repository直下に以下の内容でPersonRepository.javaを作成します。

PersonRepository.java

package com.example.demo3.repository;

import com.example.demo3.model.Person;
import org.springframework.data.jpa.repository.JpaRepository;

public interface  PersonRepository extends JpaRepository<Person,Long>{

}

解説

JpaRepositoryクラスを継承しておきます。

遷移元ページ`(form.html)`

前回の記事と同じものを用意します。

form.html

<!DOCTYPE html>
<html lang="ja" xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8">
        <title>form</title>
        <script type="text/javascript"></script>
        <style type="text/css">
            .errorStr {color:red;}
        </style>
    </head>
        <body>
            <form th:action="@{/form}" th:object="${person}" method="post" novalidate>
                <label for="name">名前：</label>
                <input type="text" th:field="*{name}">
                <span class="errorStr" th:errors="*{name}"></span>
                <br>

                <label for="age">年齢：</label>
                <input type="number" th:field="*{age}">
                <span class="errorStr" th:errors="*{age}"></span>
                <br>

                <label for="business">職業：</label>
                <input type="text" th:field="*{business}">
                <span class="errorStr" th:errors="*{business}"></span>
                <br>

                <label for="email">Eメール：</label>
                <input type="text" th:field="*{email}">
                <span class="errorStr" th:errors="*{email}"></span>
                <br>

                <button>送信</button>
            </form>
        </body>
</html>

遷移先ページ`(result.html)`

前回の記事と同じものを用意します。

result.html

<!DOCTYPE html>
<html lang="ja" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>result</title>
<script type="text/javascript"></script>
</head>
<body>
    <p>名前：[[${person.name}]]</p>
    <p>年齢：[[${person.age}]]</p>
    <p>職業：[[${person.business}]]</p>
    <p>Eメール：[[${person.email}]]</p>
</body>
</html>

設定ファイル`（application.properties)`

application.properties

spring.datasource.driver-class-name=org.postgresql.Driver
spring.datasource.url=jdbc:postgresql://localhost:5432/postgres
spring.datasource.username=postgres
spring.datasource.password=admin
logging.level.org.hibernate.SQL=DEBUG
spring.jpa.hibernate.ddl-auto=create
spring.jpa.show-sql=true
spring.jpa.properties.hibernate.format_sql=true

プロパティ名	設定値
`spring.datasource.driver-class-name`	JDBCドライバを設定します。
`spring.datasource.url`	DBの接続先URLを設定します。
`spring.jpa.hibernate.ddl-auto`	SpringBoot起動時にテーブルの自動作成を行います。 `create`→@Entityのテーブルがある場合、削除してから新規作成を行います。 `create-dorop`→`create`の挙動にプラスして、SpringBoot終了時にもテーブルを削除する動作を行います。 `update`→@Entityのテーブルが存在しない場合のみ作成します。存在する場合はそのまま。
`spring.jpa.show-sql`	SpringBootが生成したSQLをログ出力します。
`spring.datasource.username`	DBのユーザ名を指定します。
`spring.datasource.password`	DBのパスワードを指定します。

実行結果

上記のソースを実行すると、Person.javaの内容がPersonテーブルとしてPostgreSQLに登録されます。
ログを見ると以下のように出力されているので早速PostgreSQLのGUIツールであるpgAdmin4でテーブルを覗いてみます。

テーブルが作成されていました。まだレコードはありません。

テーブルが作成されていることが確認できたので、続いてブラウザでhttp://localhost:8080/にアクセスします。
すると以下の画面が表示されます。これは遷移元ページ(form.html)が表示されています。

以下のように保存できる値を入力し、「送信」ボタンを押します。

画面遷移し、以下のように表示されていることを確認します。

これでテーブルにも保存されているはずなのでpgAdmin4で見に行ってみます。

ちゃんと保存されていることが確認できました。
以上です。