JPAとHibernateでデータベース生成のカラム値をreadonlyフィールドとして定義する方法

2024-07-27

@Generatedアノテーションを使用する

@Generatedアノテーションは、JPA 2.1以降で導入されたアノテーションです。このアノテーションを使用して、データベース生成のカラム値をreadonlyフィールドとして定義することができます。

@Entity
public class MyEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Column(name = "created_at", updatable = false)
    @Generated(value = GenerationType.ALWAYS)
    private LocalDateTime createdAt;

    // ...
}

上記の例では、createdAtフィールドはデータベース生成のカラムであり、updatable = false オプションによって更新できないように設定されています。また、@Generatedアノテーションによって、このフィールドが常にデータベースによって生成されることを指定しています。

@Transientアノテーションを使用する

@Transientアノテーションは、JPAでエンティティクラスのフィールドがデータベースに永続化されないことを指定するために使用されます。このアノテーションを使用して、データベース生成のカラム値をreadonlyフィールドとして定義することができます。

@Entity
public class MyEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Transient
    private LocalDateTime createdAt;

    // ...

    public LocalDateTime getCreatedAt() {
        return createdAt;
    }

    public void setCreatedAt(LocalDateTime createdAt) {
        this.createdAt = createdAt;
    }
}

上記の例では、createdAtフィールドはデータベースに永続化されませんが、getterとsetterメソッドを使用してアクセスすることができます。

エンティティクラスのカラム名を変更する

データベース生成のカラム値は、通常、エンティティクラスのカラム名と同じ名前になります。エンティティクラスのカラム名を変更することで、データベース生成のカラム値へのアクセスを制限することができます。

@Entity
public class MyEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Column(name = "_created_at")
    private LocalDateTime createdAt;

    // ...

    public LocalDateTime getCreatedAt() {
        return createdAt;
    }

    public void setCreatedAt(LocalDateTime createdAt) {
        this.createdAt = createdAt;
    }
}

上記の例では、createdAtフィールドはデータベースでは_created_atという名前で作成されます。エンティティクラスでは、getCreatedAt()とsetCreatedAt()メソッドを使用して、このフィールドにアクセスすることができます。

これらの方法のいずれを使用しても、JPAとHibernateでデータベース生成のカラム値をreadonlyフィールドとして定義することができます。どの方法を使用するかは、要件と開発環境によって異なります。

上記の例は、JPAとHibernateのバージョン 5.6.10に基づいています。
使用するバージョンによって、アノテーションのオプションや使用方法が異なる場合があります。

@Entity
public class MyEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Column(name = "created_at", updatable = false)
    @Generated(value = GenerationType.ALWAYS)
    private LocalDateTime createdAt;

    // ...

    public LocalDateTime getCreatedAt() {
        return createdAt;
    }

}

public class Main {

    public static void main(String[] args) {

        EntityManagerFactory emf = Persistence.createEntityManagerFactory("my-persistence-unit");
        EntityManager em = emf.createEntityManager();

        MyEntity entity = new MyEntity();
        entity.setCreatedAt(LocalDateTime.now());

        em.getTransaction().begin();
        em.persist(entity);
        em.getTransaction().commit();

        em.close();
        emf.close();

    }

}

このコードは、MyEntityエンティティクラスと、そのエンティティクラスを永続化するMainクラスを定義しています。

MyEntityエンティティクラスには、以下のフィールドがあります。

id: 主キー
createdAt: データベース生成のカラム値

Mainクラスは、MyEntityエンティティクラスのインスタンスを作成し、データベースに永続化します。

このコードを実行すると、created_atカラムに現在の時刻が設定されてデータベースに挿入されます。その後、MyEntityエンティティクラスのgetCreatedAt()メソッドを使用して、created_atカラム値を取得することができます。

注意

使用するデータベースやJPA/Hibernateのバージョンによって、コードを変更する必要があります。

@Entity
public class MyEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Column(name = "_created_at")
    private LocalDateTime createdAt;

    // ...

    public LocalDateTime getCreatedAt() {
        return createdAt;
    }

    public void setCreatedAt(LocalDateTime createdAt) {
        this.createdAt = createdAt;
    }
}

getterメソッドのみを提供する

エンティティクラスのフィールドに対して、getterメソッドのみを提供することで、フィールドへの書き込みを制限することができます。

@Entity
public class MyEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private LocalDateTime createdAt;

    // ...

    public LocalDateTime getCreatedAt() {
        return createdAt;
    }

}

上記の例では、createdAtフィールドにはsetterメソッドが提供されていないため、エンティティクラスの外部からこのフィールドに書き込むことはできません。

インターフェースを使用する

エンティティクラスのフィールドへのアクセスを制御するために、インターフェースを使用することができます。

public interface MyEntity {

    Long getId();

    LocalDateTime getCreatedAt();

}

@Entity
public class MyEntityImpl implements MyEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private LocalDateTime createdAt;

    // ...

    @Override
    public Long getId() {
        return id;
    }

    @Override
    public LocalDateTime getCreatedAt() {
        return createdAt;
    }

}