3分間プログラミング講座 第14回:O/RマッピングとDI ～Spring Data JPAでデータベース連携～

// Javaオブジェクトのイメージ
class Task {
    Long id;
    String title;
    String description;
    boolean completed;
    // ...
}

-- データベーステーブルのイメージ (PostgreSQL)
CREATE TABLE tasks (
    id BIGSERIAL PRIMARY KEY,
    title VARCHAR(255) NOT NULL,
    description TEXT,
    is_completed BOOLEAN DEFAULT FALSE
    -- ...
);

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>

    <dependency>
        <groupId>org.postgresql</groupId>
        <artifactId>postgresql</artifactId>
        <scope>runtime</scope>
    </dependency>

    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <scope>runtime</scope>
        <optional>true</optional>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

# src/main/resources/application.yml

spring:
  datasource:
    url: jdbc:postgresql://localhost:5432/your_database_name # ① データベースURL (適宜変更)
    username: your_username # ② データベースユーザー名 (適宜変更)
    password: your_password # ③ データベースパスワード (適宜変更)
    driver-class-name: org.postgresql.Driver # PostgreSQLのJDBCドライバー
    # 接続プールの設定 (HikariCP) - 本番環境では重要なチューニングポイント
    hikari:
      maximum-pool-size: 10 # プール内の最大接続数
      minimum-idle: 5       # プール内のアイドル状態の最小接続数

  jpa:
    hibernate:
      ddl-auto: update # ④ アプリケーション起動時にDBスキーマを自動更新
      # 注意：この設定は開発環境でのみ使用すること。本番環境では以下を推奨：
      # - validate: スキーマの検証のみ行い、変更は行わない
      # - - none: 何もしない（手動でのDBマイグレーション推奨）
    show-sql: true # ⑤ 実行されるSQLをログに出力
    properties:
      hibernate:
        format_sql: true # ⑤ 出力されるSQLを整形する
        dialect: org.hibernate.dialect.PostgreSQLDialect # ⑥ 使用するデータベースの方言を明示的に指定
  profiles:
    active: dev # デフォルトで'dev'プロファイルをアクティブにする（後述）

// src/main/java/com/example/demo/Task.java (パッケージ名は適宜変更)
import jakarta.persistence.*; // JPAのアノテーションをインポート
import java.time.LocalDateTime;
import org.hibernate.annotations.CreationTimestamp; // タイムスタンプ自動設定用
import org.hibernate.annotations.UpdateTimestamp;  // タイムスタンプ自動設定用
import lombok.Data;             // Lombokのアノテーション: Getter/Setter/equals/hashCode/toString を自動生成
import lombok.NoArgsConstructor; // Lombokのアノテーション: 引数なしコンストラクタを自動生成（JPAに必須）

@Entity // ① このクラスがJPAのエンティティ（データベーステーブルに対応）であることを示す
@Table(name = "tasks") // ② 対応するテーブル名を指定 (クラス名と異なる場合)
@Data // Lombokにより、Getter, Setter, equals(), hashCode(), toString() が自動生成される
@NoArgsConstructor // Lombokにより、引数なしコンストラクタが自動生成される（JPAに必須）
public class Task {

    @Id // ③ プライマリキーであることを示す
    @GeneratedValue(strategy = GenerationType.IDENTITY) // ④ IDの生成戦略（PostgreSQLではIDENTITYが一般的）
    private Long id;

    @Column(nullable = false) // ⑤ NOT NULL制約を設定
    private String title;

    @Column(columnDefinition = "TEXT") // ⑥ データベースのカラム定義を直接指定
    private String description;

    @Column(name = "is_completed") // ⑦ カラム名とフィールド名が異なる場合
    private boolean completed = false; // デフォルト値を設定

    @CreationTimestamp // ⑧ レコード作成時に自動で現在日時を設定
    private LocalDateTime createdAt;

    @UpdateTimestamp // ⑨ レコード更新時に自動で現在日時を設定
    private LocalDateTime updatedAt;

    // 特定のコンストラクタが必要な場合のみ追加
    public Task(String title, String description) {
        this.title = title;
        this.description = description;
    }

    // Lombokにより上記メソッドは自動生成されるため、明示的に記述する必要はなくなる
}

// src/main/java/com/example/demo/TaskRepository.java (パッケージ名は適宜変更)
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.query.Param;
import org.springframework.stereotype.Repository;

import java.time.LocalDateTime;
import java.util.List;

@Repository // ① Springにこのインターフェースがリポジトリであることを教える
public interface TaskRepository extends JpaRepository<Task, Long> { // ② JpaRepositoryを継承する

    // --- Spring Data JPAが自動生成してくれるメソッドの例 ---
    // Spring Data JPAはメソッド名からSQLを自動生成する（命名規則に従う）
    List<Task> findByCompletedFalse(); // 完了していないタスクを検索
    List<Task> findByTitleContainingIgnoreCase(String title); // タイトルに特定の文字列を含むタスクを大文字小文字無視で検索
    boolean existsByTitle(String title); // ③ タイトルが存在するかどうかをチェックするカスタムメソッド

    // --- カスタムクエリの例 ---
    // @Queryアノテーションを使って、任意のJPQL（Java Persistence Query Language）やネイティブSQLを書くこともできる
    @Query("SELECT t FROM Task t WHERE t.createdAt >= :startDate ORDER BY t.createdAt DESC")
    List<Task> findTasksCreatedAfter(@Param("startDate") LocalDateTime startDate);

    // 特定のIDのタスクを完了済みに更新する（更新系は@Modifyingと@Transactionalが必要）
    // @Modifying
    // @Transactional
    // @Query("UPDATE Task t SET t.completed = true WHERE t.id = :id")
    // int markTaskAsCompleted(@Param("id") Long id);
}

// src/main/java/com/example/demo/TaskService.java (パッケージ名は適宜変更)
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional; // トランザクション管理用

import java.time.LocalDateTime;
import java.util.List;
import java.util.Optional; // 検索結果がnullの場合の安全なハンドリング用

@Service // Springにサービス層のコンポーネントであることを教える
public class TaskService {

    private final TaskRepository taskRepository; // TaskRepositoryへの依存

    // コンストラクタインジェクション：SpringがTaskRepositoryのインスタンスを注入する
    public TaskService(TaskRepository taskRepository) {
        this.taskRepository = taskRepository;
        System.out.println("TaskServiceが初期化され、TaskRepositoryが注入されました。");
    }

    @Transactional // ① メソッド全体をトランザクション管理下に置く
    public Task addTask(Task task) {
        System.out.println("新しいタスクを追加: " + task.getTitle());
        return taskRepository.save(task); // ② saveメソッドでデータベースに保存
    }

    @Transactional(readOnly = true) // ③ 読み取り専用トランザクション
    public List<Task> getAllTasks() {
        System.out.println("全てのタスクを取得します。");
        return taskRepository.findAll(); // ④ 全てのタスクを取得
    }

    @Transactional(readOnly = true)
    public Optional<Task> getTaskById(Long id) {
        if (id == null) {
            throw new IllegalArgumentException("IDがnullです"); // 例外処理の追加
        }
        System.out.println("ID: " + id + "のタスクを検索します。");
        return taskRepository.findById(id); // ⑤ IDでタスクを検索
    }

    @Transactional
    public Task updateTask(Long id, Task updatedTask) {
        System.out.println("ID: " + id + "のタスクを更新します。");
        return taskRepository.findById(id).map(task -> { // ⑥ 既存タスクを取得し、存在すれば更新
            task.setTitle(updatedTask.getTitle());
            task.setDescription(updatedTask.getDescription());
            task.setCompleted(updatedTask.isCompleted());
            return taskRepository.save(task); // ⑦ 更新内容を保存
        }).orElseThrow(() -> new RuntimeException("Task not found with id " + id)); // 見つからなければ例外
    }

    @Transactional
    public void deleteTask(Long id) {
        System.out.println("ID: " + id + "のタスクを削除します。");
        taskRepository.deleteById(id); // ⑧ IDでタスクを削除
    }

    @Transactional(readOnly = true)
    public List<Task> getIncompleteTasks() {
        System.out.println("未完了のタスクを取得します。");
        return taskRepository.findByCompletedFalse(); // ⑨ 自動生成されたメソッドを呼び出し
    }

    @Transactional(readOnly = true)
    public List<Task> getTasksCreatedAfter(LocalDateTime date) {
        System.out.println("指定日時以降に作成されたタスクを取得します。");
        return taskRepository.findTasksCreatedAfter(date); // ⑩ カスタムクエリのメソッドを呼び出し
    }

    @Transactional(readOnly = true)
    public boolean existsByTitle(String title) {
        System.out.println("タイトル '" + title + "' の存在を確認します。");
        return taskRepository.existsByTitle(title); // ⑪ 自動生成された存在チェックメソッドを呼び出し
    }
}