Spring Boot 3 + JPA + PostgreSQLでjsonb型のカラムにinsertする方法

前提条件

前提とする環境のデータベースのテーブルを確認していきます。

環境

Spring Boot ver 3.3.1
gradle
kotlin
jdk 21
psql (PostgreSQL) 14.16

データベース

CREATE TABLE IF NOT EXISTS SAMPLE_TABLE (
    id SERIAL PRIMARY KEY,
    json_data JSONB NOT NULL
);

Spring BootとPostgreSQLサーバーが接続されていることはpsql等を用いてデータベースにデータを入れた状態で JPA の.findeAll()等を用いて事前に確認してください。

サンプルコード

build.gradle.kts

必要なdependenciesを追加

kotlin name=build.gradle.kts

dependencies {
    // jsonb型を設定するために必要
    // hypersistence-utils-hibernateを60にするかどうかは自身の環境に合わせる
	implementation "io.hypersistence:hypersistence-utils-hibernate-60:3.5.2"
}

SampleEntity.kt

kotlin name=SampleEntity.kt

import io.hypersistence.utils.hibernate.type.json.JsonType
import jakarta.persistence.*
import org.hibernate.annotations.Type

@Entity
@Table(name = "SAMPLE_TABLE")
data class SampleEntity(
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "id")
    val id: Long?,

    // @Typeを宣言することでStringをJsonに変換してくれる
    @Type(JsonType::class)
    // columnDefinition で jsonb を指定
    @Column(name = "json_data", columnDefinition = "jsonb")
    val jsonData: String
){
    // 引数なしのコンストラクタを追加
    constructor() : this(null,  "")
}

SampleRepository.kt

kotlin name=SampleRepository.kt

import com.sample.SampleEntity
import org.springframework.data.jpa.repository.JpaRepository
import org.springframework.stereotype.Repository

@Repository
interface SampleRepository : JpaRepository<SampleEntity, Long>

SampleService.kt

kotlin name=SampleService.kt

            val entity = SampleEntity(
                //jsonをstringに直してから渡す
                jsonData = "{\"name\":\"dummyName\"}"
            )
            val savedEntity = sampleEntityRepository.save(entity)