← Zurück zum Blog

Java Persistence API: Eine Base Entity erstellen

Übersetzter Artikel. Original lesen

Einleitung

Beim Aufsetzen neuer Java-Projekte wiederholen sich viele Aufgaben. Wer mit JPA arbeitet, muss unter anderem das Design der Entities und den Einsatz einer BaseEntity festlegen 🙂

Eine BaseEntity stellt allen abgeleiteten Klassen gemeinsame Basisfunktionen bereit. So muss beispielsweise die id nicht in jeder Entity erneut definiert werden.

BaseEntity

Ein Blick auf die wichtigsten Bestandteile dieser Klasse:

  • @MappedSuperclass – Die Klasse BaseEntity erhält keine eigene Tabelle. Ihre Felder werden in der Tabelle der abgeleiteten Klasse gespeichert.
  • public abstract class BaseEntity – abstract verhindert, dass BaseEntity direkt instanziiert wird. Nur abgeleitete Klassen können Instanzen erzeugen.
  • id – @Id markiert das Feld als Primärschlüssel der Entity.
  • @GeneratedValue(strategy = GenerationType.AUTO) – Definiert die Erzeugungsstrategie. AUTO wählt abhängig von der Datenbank automatisch eine passende Variante.
  • version – Das optionale Feld aktiviert mit @Version das Optimistic Locking. Eine neue Instanz startet mit Version 0; jedes Speichern oder Aktualisieren erhöht den Wert. Wurde das Objekt zwischenzeitlich verändert, löst das Persistieren eine Exception aus.

Möglicher Engpass bei @GeneratedValue(strategy = GenerationType.AUTO)
Bei PostgreSQL oder Oracle kann GenerationType.AUTO nachteilig sein. Diese Datenbanken verwenden statt aus MySQL bekannten Auto-Increment-Feldern Sequenzen. Abhängig von der Datenbank- und Sequenzkonfiguration teilen sich möglicherweise alle Entities dieselbe Sequenz – ein potenzieller Engpass bei vielen Insert-Operationen.

import javax.persistence.*;
import java.io.Serializable;
import java.util.Objects;

@MappedSuperclass
public abstract class BaseEntity implements Serializable {

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

    @Version
    private Long version;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public Long getVersion() {
        return version;
    }

    public void setVersion(Long version) {
        this.version = version;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        BaseEntity that = (BaseEntity) o;
        return Objects.equals(id, that.id) &&
                Objects.equals(version, that.version);
    }

    @Override
    public int hashCode() {
        return Objects.hash(id, version);
    }

    @Override
    public String toString() {
        return "BaseEntity{" +
                "id=" + id +
                ", version=" + version +
                '}';
    }
}

Base Entity mit Zeit- und Bearbeiterfeldern

Die BaseEntity kann um weitere JPA-Funktionen ergänzt werden. Die folgende Entity enthält die Felder createdBy, updatedBy, createdAt und updatedAt. Die letzten beiden sind Zeitstempel vom Typ TemporalType.

  • @PrePersist – Weist die JPA-Implementierung an, die markierte Methode vor dem ersten Einfügen beziehungsweise Persistieren auszuführen. Hier wird createdAt mit der aktuellen Zeit gefüllt.
  • @PreUpdate – Führt die markierte Methode vor jeder Aktualisierung aus. Hier erhält updatedAt die aktuelle Zeit.
import javax.persistence.*;
import java.io.Serializable;
import java.util.Date;
import java.util.Objects;

@MappedSuperclass
public abstract class BaseEntityAudit extends BaseEntity implements Serializable {

    private String createdBy;
    private String updatedBy;

    @Temporal(TemporalType.TIMESTAMP)
    private Date createdAt;

    @Temporal(TemporalType.TIMESTAMP)
    private Date updatedAt;

    /**
     * Sets createdAt before insert
     */
    @PrePersist
    public void setCreationDate() {
        this.createdAt = new Date();
    }

    /**
     * Sets updatedAt before update
     */
    @PreUpdate
    public void setChangeDate() {
        this.updatedAt = new Date();
    }

    public Date getCreatedAt() {
        return createdAt;
    }

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

    public Date getUpdatedAt() {
        return updatedAt;
    }

    public void setUpdatedAt(Date updatedAt) {
        this.updatedAt = updatedAt;
    }

    public String getCreatedBy() {
        return createdBy;
    }

    public void setCreatedBy(String createdBy) {
        this.createdBy = createdBy;
    }

    public String getUpdatedBy() {
        return updatedBy;
    }

    public void setUpdatedBy(String updatedBy) {
        this.updatedBy = updatedBy;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        if (!super.equals(o)) return false;
        BaseEntityAudit that = (BaseEntityAudit) o;
        return Objects.equals(createdBy, that.createdBy) &&
                Objects.equals(updatedBy, that.updatedBy) &&
                Objects.equals(createdAt, that.createdAt) &&
                Objects.equals(updatedAt, that.updatedAt);
    }

    @Override
    public int hashCode() {
        return Objects.hash(super.hashCode(), createdBy, updatedBy, createdAt, updatedAt);
    }

    @Override
    public String toString() {
        return "BaseEntityAudit{" +
                "createdBy='" + createdBy + '\'' +
                ", updatedBy='" + updatedBy + '\'' +
                ", createdAt=" + createdAt +
                ", updatedAt=" + updatedAt +
                "} " + super.toString();
    }
}