【8/27まで】Udemyの人気コースが今なら1,200円から!!

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

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

この記事では、前回入力チェックを実装した以下の記事の画面を使って、登録内容をPostgresSQLに保存する方法を説明します。
【Spring Boot】単項目チェックしてエラーメッセージを表示する(@Validated) 【Spring Boot】単項目チェックしてエラーメッセージを表示する(@Validated)

事前準備(PostgresSQLのインストール)

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

プロジェクトの作成

VSCodeでSpringBootのMavenプロジェクトを作成します。
手順は以下の記事を参照。
【Windows版】VSCodeで始めるSpringBoot(Mavenプロジェクト編) 【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.demo5.controller;

import com.example.demo5.model.Otoiawase;
import com.example.demo5.repository.OtoiawaseRepository;

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 OtoiawaseRepository repository;

    @Autowired
    public BaseController(OtoiawaseRepository repository){
        this.repository = repository;
    }
    @GetMapping("/")
    public String home(@ModelAttribute Otoiawase otoiawase){
      return "form";
    }

    @PostMapping("/")
    public String result(@Validated 
                        @ModelAttribute Otoiawase otoiawase,
                        BindingResult result){
        if(result.hasErrors()){
            return "form";
        }

        repository.save(otoiawase);
        return "result";
    }
}
解説
@Autowiredアノテーション
Springが自動的にオブジェクトを注入します。コンストラクタインジェクションといいます。
解説
DBに登録するには以下のコードを実行します。
repository.save(otoiawase);

モデル(Otoiawase.java)

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

Java

package com.example.demo5.model;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.validation.constraints.Email;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Size;

import org.springframework.format.annotation.NumberFormat;

import lombok.Data;

@Entity
@Data
public class Otoiawase {

    @Id
    @GeneratedValue
    private long id;
    /**
     * <p>項目名:氏名</p>
     * <p>必須入力かつ、最大20文字まで</p>
     */
    @NotBlank
    @Size(max=20)
    private String name;

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

    /**
     * <p>項目名:電話番号</p>
     * <p>条件:必須入力かつ、数値のみ、最大12文字まで</p>
     */
    @NotBlank
    @NumberFormat
    @Size(max=12)
    private String tel;

    /**
     * <p>項目名:内容</p>
     * <p>条件:必須入力かつ、最大200文字まで</p>
     */
    @NotBlank
    @Size(max=200)
    private String contents;
}
解説
@Entityアノテーション
エンティティクラスであることを示します。このアノテーションが付与されたクラスの内容でテーブルが作成されます。
@Idアノテーション
このアノテーションを付与した項目が、テーブルの主キー項目になります。
@GeneratedValueアノテーション
主キーの値を自動採番します。

リポジトリ(OtoiawaseRepository.java)

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

OtoiawaseRepository.java

package com.example.demo5.repository;

import com.example.demo5.model.Otoiawase;
import org.springframework.data.jpa.repository.JpaRepository;

public interface OtoiawaseRepository extends JpaRepository<Otoiawase,Long>{

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

遷移元ページ(form.html)

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

遷移先ページ(result.html)

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

プロパティファイル(messages_ja.properties)

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

設定ファイル(pom.xml)

Bootstrapを使用するため、前回の記事と同じように追記します。

設定ファイル(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-doropcreateの挙動にプラスして、SpringBoot終了時にもテーブルを削除する動作を行います。
update→@Entityのテーブルが存在しない場合のみ作成します。存在する場合はそのまま。
spring.jpa.show-sql SpringBootが生成したSQLをログ出力します。
spring.datasource.username DBのユーザ名を指定します。
spring.datasource.password DBのパスワードを指定します。

実行結果

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


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

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

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

画面遷移し、「以下の内容で登録しました。」とメッセージが表示されていることを確認します。

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

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

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です