HibernateおよびMySQLでの作成タイムスタンプと最終更新タイムスタンプ

特定のHibernateエンティティについては、その作成時刻と最後に更新された時刻を保存する必要があります。これをどのように設計しますか？

• データベースでどのデータ型を使用しますか（MySQLの場合、JVMとは異なるタイムゾーンの可能性があります）？データ型はタイムゾーンを認識しますか？

• あなたはJavaでどのようなデータ型を使用しますか（Date、Calendar、long、...）？

• データベース、ORMフレームワーク（Hibernate）、またはアプリケーションプログラマーの誰がタイムスタンプの設定を担当しますか？

• マッピングにはどのアノテーションを使用し@Temporalますか（例：）？

実用的なソリューションだけでなく、安全で適切に設計されたソリューションも探しています。

JPAアノテーションを使用している場合@PrePersist、@PreUpdateイベントフックを使用してこれを行うことができます。

@Entity
@Table(name = "entities")    
public class Entity {
  ...

  private Date created;
  private Date updated;

  @PrePersist
  protected void onCreate() {
    created = new Date();
  }

  @PreUpdate
  protected void onUpdate() {
    updated = new Date();
  }
}

または@EntityListener、クラスのアノテーションを使用して、イベントコードを外部クラスに配置することもできます。

あなただけ使用することができます@CreationTimestampと@UpdateTimestamp：

@CreationTimestamp
@Temporal(TemporalType.TIMESTAMP)
@Column(name = "create_date")
private Date createDate;

@UpdateTimestamp
@Temporal(TemporalType.TIMESTAMP)
@Column(name = "modify_date")
private Date modifyDate;

この投稿のリソースと、さまざまなソースから左右に取得した情報を利用して、このエレガントなソリューションを思い付き、次の抽象クラスを作成しました

import java.util.Date;

import javax.persistence.Column;
import javax.persistence.MappedSuperclass;
import javax.persistence.PrePersist;
import javax.persistence.PreUpdate;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;

@MappedSuperclass
public abstract class AbstractTimestampEntity {

    @Temporal(TemporalType.TIMESTAMP)
    @Column(name = "created", nullable = false)
    private Date created;

    @Temporal(TemporalType.TIMESTAMP)
    @Column(name = "updated", nullable = false)
    private Date updated;

    @PrePersist
    protected void onCreate() {
    updated = created = new Date();
    }

    @PreUpdate
    protected void onUpdate() {
    updated = new Date();
    }
}

そして、あなたのすべてのエンティティにそれを拡張させます、例えば：

@Entity
@Table(name = "campaign")
public class Campaign extends AbstractTimestampEntity implements Serializable {
...
}

1.使用する必要があるデータベース列のタイプ

最初の質問は：

データベースでどのデータ型を使用しますか（MySQLの場合、JVMとは異なるタイムゾーンの可能性があります）？データ型はタイムゾーンを認識しますか？

MySQLでは、TIMESTAMPカラムタイプはJDBCドライバーのローカルタイムゾーンからデータベースのタイムゾーンにシフトしますが'2038-01-19 03:14:07.999999、最大でまでのタイムスタンプしか保存できないため、将来的には最適ではありません。

そのため、DATETIMEこの上限の制限がない代わりに使用することをお勧めします。ただし、DATETIMEタイムゾーンは認識されません。したがって、このため、データベース側でUTCを使用し、hibernate.jdbc.time_zoneHibernateプロパティを使用するのが最善です。

hibernate.jdbc.time_zone設定の詳細については、こちらの記事をご覧ください。

2.使用する必要があるエンティティプロパティタイプ

2つ目の質問は次のとおりです。

Javaではどのデータ型を使用しますか（日付、カレンダー、ロングなど）？

Java側では、Java 8を使用できますLocalDateTime。レガシーを使用することもできますDateが、Java 8の日付/時刻型は不変であり、ログに記録するときにタイムゾーンをローカルタイムゾーンにシフトしないため、より優れています。

HibernateでサポートされているJava 8の日付/時刻型の詳細については、こちらの記事をご覧ください。

これで、この質問にも答えることができます。

マッピングにはどのアノテーションを使用し@Temporalますか（例：）？

LocalDateTimeまたはjava.sql.Timestampを使用してタイムスタンプエンティティプロパティをマップする場合@Temporal、HIbernateはこのプロパティがJDBCタイムスタンプとして保存されることをすでに認識しているため、使用する必要はありません。

を使用している場合のみ、次のように注釈java.util.Dateを指定する必要があります@Temporal。

@Temporal(TemporalType.TIMESTAMP)
@Column(name = "created_on")
private Date createdOn;

しかし、次のようにマッピングすると、はるかに優れています。

@Column(name = "created_on")
private LocalDateTime createdOn;

監査列の値を生成する方法

3つ目の質問は次のとおりです。

データベース、ORMフレームワーク（Hibernate）、またはアプリケーションプログラマーの誰がタイムスタンプの設定を担当しますか？

マッピングにはどのアノテーションを使用しますか（例：@Temporal）？

この目標を達成する方法はたくさんあります。データベースにそれを許可することができます。

以下のためにcreate_on列に、あなたが使用することができますDEFAULTように、DDL制約を：

ALTER TABLE post 
ADD CONSTRAINT created_on_default 
DEFAULT CURRENT_TIMESTAMP() FOR created_on;

updated_on列については、DBトリガーを使用してCURRENT_TIMESTAMP()、特定の行が変更されるたびに列の値を設定できます。

または、JPAまたはHibernateを使用して設定します。

次のデータベーステーブルがあるとします。

そして、各テーブルには次のような列があります。

• created_by
• created_on
• updated_by
• updated_on

Hibernate @CreationTimestampと@UpdateTimestampアノテーションの使用

Hibernateは、および列のマッピングに使用できる@CreationTimestampおよび@UpdateTimestampアノテーションを提供します。created_onupdated_on

を使用@MappedSuperclassして、すべてのエンティティによって拡張される基本クラスを定義できます。

@MappedSuperclass
public class BaseEntity {

    @Id
    @GeneratedValue
    private Long id;

    @Column(name = "created_on")
    @CreationTimestamp
    private LocalDateTime createdOn;

    @Column(name = "created_by")
    private String createdBy;

    @Column(name = "updated_on")
    @UpdateTimestamp
    private LocalDateTime updatedOn;

    @Column(name = "updated_by")
    private String updatedBy;

    //Getters and setters omitted for brevity
}

そして、すべてのエンティティは次のBaseEntityようにを拡張します。

@Entity(name = "Post")
@Table(name = "post")
public class Post extend BaseEntity {

    private String title;

    @OneToMany(
        mappedBy = "post",
        cascade = CascadeType.ALL,
        orphanRemoval = true
    )
    private List<PostComment> comments = new ArrayList<>();

    @OneToOne(
        mappedBy = "post",
        cascade = CascadeType.ALL,
        orphanRemoval = true,
        fetch = FetchType.LAZY
    )
    private PostDetails details;

    @ManyToMany
    @JoinTable(
        name = "post_tag",
        joinColumns = @JoinColumn(
            name = "post_id"
        ),
        inverseJoinColumns = @JoinColumn(
            name = "tag_id"
        )
    )
    private List<Tag> tags = new ArrayList<>();

    //Getters and setters omitted for brevity
}

の使用について詳しくは@MappedSuperclass、こちらの記事をご覧ください。

しかし、場合でもcreatedOn及びupdateOn特性は、Hibernateの固有によって設定される@CreationTimestampと@UpdateTimestamp、注釈createdBy及びupdatedBy以下JPA溶液によって示されるように、アプリケーションのコールバックを登録する必要があります。

JPAの使用 @EntityListeners

監査プロパティをEmbeddableにカプセル化できます。

@Embeddable
public class Audit {

    @Column(name = "created_on")
    private LocalDateTime createdOn;

    @Column(name = "created_by")
    private String createdBy;

    @Column(name = "updated_on")
    private LocalDateTime updatedOn;

    @Column(name = "updated_by")
    private String updatedBy;

    //Getters and setters omitted for brevity
}

そして、AuditListener監査プロパティを設定するを作成します。

public class AuditListener {

    @PrePersist
    public void setCreatedOn(Auditable auditable) {
        Audit audit = auditable.getAudit();

        if(audit == null) {
            audit = new Audit();
            auditable.setAudit(audit);
        }

        audit.setCreatedOn(LocalDateTime.now());
        audit.setCreatedBy(LoggedUser.get());
    }

    @PreUpdate
    public void setUpdatedOn(Auditable auditable) {
        Audit audit = auditable.getAudit();

        audit.setUpdatedOn(LocalDateTime.now());
        audit.setUpdatedBy(LoggedUser.get());
    }
}

を登録するAuditListenerには、@EntityListenersJPAアノテーションを使用できます。

@Entity(name = "Post")
@Table(name = "post")
@EntityListeners(AuditListener.class)
public class Post implements Auditable {

    @Id
    private Long id;

    @Embedded
    private Audit audit;

    private String title;

    @OneToMany(
        mappedBy = "post",
        cascade = CascadeType.ALL,
        orphanRemoval = true
    )
    private List<PostComment> comments = new ArrayList<>();

    @OneToOne(
        mappedBy = "post",
        cascade = CascadeType.ALL,
        orphanRemoval = true,
        fetch = FetchType.LAZY
    )
    private PostDetails details;

    @ManyToMany
    @JoinTable(
        name = "post_tag",
        joinColumns = @JoinColumn(
            name = "post_id"
        ),
        inverseJoinColumns = @JoinColumn(
            name = "tag_id"
        )
    )
    private List<Tag> tags = new ArrayList<>();

    //Getters and setters omitted for brevity
}

JPAでの監査プロパティの実装の詳細については@EntityListener、チェックアウトこの記事を。

インターセプターを使用して値を設定することもできます

エンティティが実装するTimeStampedというインターフェースを作成します

public interface TimeStamped {
    public Date getCreatedDate();
    public void setCreatedDate(Date createdDate);
    public Date getLastUpdated();
    public void setLastUpdated(Date lastUpdatedDate);
}

インターセプターを定義する

public class TimeStampInterceptor extends EmptyInterceptor {

    public boolean onFlushDirty(Object entity, Serializable id, Object[] currentState, 
            Object[] previousState, String[] propertyNames, Type[] types) {
        if (entity instanceof TimeStamped) {
            int indexOf = ArrayUtils.indexOf(propertyNames, "lastUpdated");
            currentState[indexOf] = new Date();
            return true;
        }
        return false;
    }

    public boolean onSave(Object entity, Serializable id, Object[] state, 
            String[] propertyNames, Type[] types) {
            if (entity instanceof TimeStamped) {
                int indexOf = ArrayUtils.indexOf(propertyNames, "createdDate");
                state[indexOf] = new Date();
                return true;
            }
            return false;
    }
}

そしてそれをセッションファクトリーに登録します

Olivierのソリューションでは、更新ステートメントの実行中に次のことが発生する可能性があります。

com.mysql.jdbc.exceptions.jdbc4.MySQLIntegrityConstraintViolationException：列 'created'をnullにすることはできません

これを解決するには、 "created"属性の@Columnアノテーションにupdatable = falseを追加します。

@Temporal(TemporalType.TIMESTAMP)
@Column(name = "created", nullable = false, updatable=false)
private Date created;

助けてくれたみんなに感謝します。自分でいくつかの調査を行った後（私が質問したのは私です）、ここで私が最も理解できることがわかりました。

• データベース列タイプ：decimal(20)1 ^ 70からのタイムゾーンに依存しないミリ秒数。2^ 64は20桁で、ディスク容量が少ないため、次のように表されます。簡単にしましょう。また、DEFAULT CURRENT_TIMESTAMPもトリガーも使用しません。DBに魔法は必要ありません。

• Javaフィールドタイプ：long。Unixタイムスタンプはさまざまなライブラリで十分にサポートされてlongおり、Y2038の問題はありません。タイムスタンプの計算は高速で簡単です（主に演算子<と演算子+、計算に日/月/年が含まれないと仮定しています）。そして最も重要なのは、プリミティブlongとjava.lang.Longの両方が不変であり、実質的にsとは異なり値によって渡されることjava.util.Dateです。foo.getLastUpdate().setTime(System.currentTimeMillis())他の誰かのコードをデバッグするときのようなものを見つけるのに本当に腹が立つでしょう。

• ORMフレームワークは、データを自動的に入力する必要があります。

• 私はまだこれをテストしていませんが、私がそれで@Temporalうまくいくと想定しているドキュメントのみを調べています。@Versionこの目的で使用するかどうかはわかりません。 @PrePersistそして@PreUpdateそれを手動で制御するための良い代替手段です。すべてのエンティティのための層のスーパータイプ（共通の基底クラス）にそれを追加し、あなたが本当にのためのタイムスタンプをしたいというキュートなアイデアが提供され、すべてのあなたのエンティティの。

Session APIを使用している場合、PrePersistおよびPreUpdateコールバックはこの回答に従って機能しません。

私はコードでHibernate Sessionのpersist（）メソッドを使用しているため、この作業を行う唯一の方法は、以下のコードとこのブログ投稿（回答にも投稿されています）を使用することでした。

@MappedSuperclass
public abstract class AbstractTimestampEntity {

    @Temporal(TemporalType.TIMESTAMP)
    @Column(name = "created")
    private Date created=new Date();

    @Temporal(TemporalType.TIMESTAMP)
    @Column(name = "updated")
    @Version
    private Date updated;

    public Date getCreated() {
        return created;
    }

    public void setCreated(Date created) {
        this.created = created;
    }

    public Date getUpdated() {
        return updated;
    }

    public void setUpdated(Date updated) {
        this.updated = updated;
    }
}

@CreatedDateおよび@LastModifiedDateアノテーションも追加されました。

=> https://programmingmitra.blogspot.fr/2017/02/automatic-spring-data-jpa-auditing-saving-CreatedBy-createddate-lastmodifiedby-lastmodifieddate-automatically.html

（春のフレームワーク）

次のコードは私のために働いた。

package com.my.backend.models;

import java.util.Date;

import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.MappedSuperclass;

import com.fasterxml.jackson.annotation.JsonIgnore;

import org.hibernate.annotations.ColumnDefault;
import org.hibernate.annotations.CreationTimestamp;
import org.hibernate.annotations.UpdateTimestamp;

import lombok.Getter;
import lombok.Setter;

@MappedSuperclass
@Getter @Setter
public class BaseEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    protected Integer id;

    @CreationTimestamp
    @ColumnDefault("CURRENT_TIMESTAMP")
    protected Date createdAt;

    @UpdateTimestamp
    @ColumnDefault("CURRENT_TIMESTAMP")
    protected Date updatedAt;
}

すべてのエンティティに共通の基本クラスを用意することをお勧めします。この基本クラスでは、すべてのエンティティ（一般的なデザイン）、作成、および最終更新日のプロパティで一般的に名前が付けられている場合、idプロパティを使用できます。

作成日は、java.util.Dateプロパティを保持するだけです。常にnew Date（）で初期化してください。

最後の更新フィールドには、Timestampプロパティを使用できます。@ Versionでマップする必要があります。このアノテーションにより、プロパティはHibernateによって自動的に更新されます。Hibernateは楽観的ロックも適用することに注意してください（これは良いことです）。

強調するだけです：java.util.CalenderTimestampsではありません。 java.util.Date一時的なもので、タイムゾーンなどの地域的な事柄にとらわれません。ほとんどのデータベースは、この方法で物事を保存します（そうでない場合でも、これは通常、クライアントソフトウェアのタイムゾーン設定です。データは良好です）

JAVAのデータ型として、java.util.Dateを使用することを強くお勧めします。カレンダーを使用すると、かなり厄介なタイムゾーンの問題が発生しました。このスレッドを参照してください。

タイムスタンプを設定するには、AOPアプローチを使用するか、テーブルでトリガーを使用することをお勧めします（実際には、これがトリガーの使用を許容できると思う唯一のものです）。

時間をDateTimeとして保存し、UTCで保存することもできます。MySqlは日付をUTCに変換し、データを格納および取得するときに現地時間に戻すため、通常はTimestampではなくDateTimeを使用します。そのようなロジックは1か所（ビジネスレイヤー）に保持したいと思います。Timestampを使用する方が望ましい状況は他にもあると思います。

私たちにも同じような状況がありました。Mysql 5.7を使用していました。

CREATE TABLE my_table (
        ...
      updated_time TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
    );

これでうまくいきました。

メソッドで@Transactionalを使用している場合、@ CreationTimestampと@UpdateTimestampはDBに値を保存しますが、save（...）の使用後にnullを返します。

この状況で、saveAndFlush（...）を使用してトリックを行いました

Javaコードではこれを行わない方がいいと思います。MySqlテーブル定義で列のデフォルト値を設定するだけです。