Spring Data Custom Query - Modifying & Transactional

Post ten jest formą ćwiczenia, dlatego udostępniamy kod zródłowy w postaci projektu na Githubie, gdzie możecie sklonować repozytorium albo po prostu ściągnąć plik zip.
Do pełnego zrozumienia przykładu wymagana jest wiedza ogólna dotycząca Spring Data JPA, a w szególności 
zapytań własnych (custom queries), które opisujemy w naszym kursie Spring-a w rozdziale <a ng-href="/kurs-spring/spring-data-jpa-zapytania-wlasne" ng-click="$event.stopPropagation();" target="_blank">Spring Data JPA: Zapytania Własne (Custom Queries)</a>.<br/><br/>
Załóżmy teraz, że w pewnej aplikacji webowej, napisanej z użyciem Spring Boot-a przechowujemy użytkowników uprawnionych do korzystania z tej aplikacji wraz z przypisanymi do nich elementami (itemami). 
Bazę danych inicjujemy rekordami, których nazwy zaczynają się od słowa "Item" albo od słowa "AppaItem".
Dla tak przygotowanych danych chcemy napisać zapytanie Spring Data JPA, które usunie tylko rekordy o nazwie zaczynającej się od słowa "AppaItem". Dodatkowo pobierzemy i wyświetlimy wszystkie pozostałe w bazie rekordy.

<div class="vertical-box-30"></div>
<h2>Adnotacje Modifying i Transactional</h2>
<div class="vertical-box-20"></div> 
Nasze rozwiązanie bazuje na adnotacji <span class="cit annotation">@Query</span>. Używając tej adnotacji tworzymy odpowiednie zapytanie i co również bardzo ważne dodajemy adnotacje: 
<span class="cit annotation">@Transactional</span> i <span class="cit annotation">@Modifying</span>!
To jest zasadnicza różnica w stosunku do zapytania odczytującego dane typu SELECT. W przypadku zapytań modyfikujących (UPDATE, DELETE) mamy obowiązek użyć tych dodatkowych adnotacji, gdyż w przeciwnym wypadku
otrzymamy wyjątki: <br /><br />

W przypadku braku adnotacji <span class="cit annotation">@Transactional</span>... <br /><br />

<div class="pre-div-scrollable">                                       
<pre class="prettyprint col-md-4 center-block font-size-15 prettyprint-extended" style="font-size:99% !important;">
Executing an update/delete query; 
nested exception is javax.persistence.TransactionRequiredException: Executing an update/delete query
</pre>             
</div>                
<div class="vertical-box-40"></div>

W przypadku braku adnotacji <span class="cit annotation">@Modifying</span>... <br /><br />

<div class="pre-div-scrollable">                                       
<pre class="prettyprint col-md-4 center-block font-size-15 prettyprint-extended" style="font-size:99% !important;">
There was an unexpected error (type=Internal Server Error, status=500). 
org.hibernate.hql.internal.QueryExecutionRequestException: Not supported for DML operations 
[DELETE FROM com.javappa.postmodifying.domain.Item i WHERE i.name LIKE :prefix];
</pre>             
</div>                
<div class="vertical-box-40"></div>

Wykonując zapytanie zgodnie z zaleceniami otrzymamy rekordy przefiltrowane i tym samym zawierające tylko itemy o nazwie rozpoczynającej się od słowa "Item":

<div class="vertical-box-30"></div>
<h2>Kod źródłowy</h2>

package com.javappa.postmodifying.domain;

import java.util.HashSet;
import java.util.Set;

import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.JoinColumn;
import javax.persistence.JoinTable;
import javax.persistence.ManyToMany;
import javax.persistence.Table;

@Entity
@Table(name = "items")
public class Item extends AbstractEntity<Long> {

@Column(length = 255)
    private String name;

@Column(length = 4000)
    private String description;

@ManyToMany(cascade = { CascadeType.MERGE })
    @JoinTable(name = "items_users", joinColumns = { @JoinColumn(name = "items_id") }, inverseJoinColumns = {
            @JoinColumn(name = "users_id") })
    private Set<User> users = new HashSet<User>();

public Set<User> getUsers() {
        return users;
    }

public void setUsers(Set<User> users) {
        this.users = users;
    }

public String getName() {
        return name;
    }

public void setName(String name) {
        this.name = name;
    }

public String getDescription() {
        return description;
    }

public void setDescription(String description) {
        this.description = description;
    }
}

package com.javappa.postentityset.domain;

import java.io.Serializable;
import java.util.Date;
import java.util.Objects;

import javax.persistence.Column;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.MappedSuperclass;
import javax.persistence.PrePersist;
import javax.persistence.PreUpdate;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;

import org.springframework.data.domain.Persistable;

@MappedSuperclass
public abstract class AbstractEntity<ID
                extends
                Serializable> implements Persistable<ID> {

@Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(unique = true, nullable = false)
    private ID id;
    
    @Column(name = "creation_date")
    @Temporal(TemporalType.TIMESTAMP)
    private Date creationDate;

@Column(name = "modification_date")
    @Temporal(TemporalType.TIMESTAMP)
    private Date modificationDate;

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

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

@Override
    public boolean isNew() {        
        return null == getId();
    }

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

@Override
    public boolean equals(Object o) {

if (this == o) {
            return true;
        }
        if (!(o instanceof AbstractEntity)) {
            return false;
        }
        AbstractEntity<?> that = (AbstractEntity<?>) o;

return Objects.equals(id, that.id);
    }
    
    @PrePersist
    protected void onCreate() {
        
        if (this.creationDate == null) {
            Date currentDate = new Date();
            this.creationDate = currentDate;
            this.modificationDate = currentDate;
        }
    }

@PreUpdate
    protected void onUpdate() {
        this.modificationDate = new Date();
    }

@Override
    public String toString() {
        
        return String.format("Entity of type %s with id: %s", this.getClass().getName(), getId());
    }
}

Autor: Jarek Klimas
Data: 16 września 2018
Labele:Backend, Poziom średniozaawansowany, Java, Hibernate

Masz swoje przemyślenia na temat artykułu? Podziel się nimi!

Masz pytanie odnośnie zagadnienia omawianego w artykule?
Coś, co napisaliśmy, nie zaspokoiło Twojego głodu wiedzy?

Daj nam znać co myślisz i skomentuj artykuł na facebooku!

www.facebook.com/javappa

Zapisz się do newslettera :

Stale się rozwijamy, a więc bądź na bieżąco!
Na ten adres będziemy przesyłać informacje o ważniejszych aktualizacjach, a także o nowych materiałach pojawiających się na stronie.

Polub nas na Facebooku:

Nasi partnerzy:

stackshare

Javappa to również profesjonalne usługi programistyczne oparte o technologie JAVA. Jeśli chesz nawiązać z nami kontakt w celu uzyskania doradztwa bądź stworzenia aplikacji webowej powinieneś poznać nasze doświadczenia.
Kliknij O nas .

Starter Jak to działa Aplikacja

Obserwuj nas Polityka Cookies Regulamin Licencja Ochrona prywatności

Pozycjonowanie stron: Grupa TENSE