JPA & Spring Data¶

A gyakorlat célja, hogy a hallgatók megismerjék a JPA és a Spring Data használatát. A főbb témák: entitások fejlesztése, lekérdezések megfogalmazása különböző módokon, módosítások végrehajtása. A kódokat egy webalkalmazás projektbe integráljuk, amiben a projekt alapvető konfigurációja és egy teszteléshez használható egyszerű webes felületet már készen áll.

Előfeltételek¶

A labor elvégzéséhez szükséges eszközök:

Spring Tool Suite (Eclipse alapú IDE)
Microsoft SQL Server Express edition (localdb ezúttal nem jó)
SQL Server Management Studio
Adatbázis létrehozó script: mssql.sql
Kiinduló webalkalmazás kódja: https://github.com/bmeviauac01/gyakorlat-jpa-kiindulo

Amit érdemes átnézned¶

JPA előadás
EJB, Spring előadás

Gyakorlat menete¶

A gyakorlat végig vezetett, a gyakorlatvezető utasításai szerint haladjunk. Egy-egy részfeladatot próbáljunk meg először önállóan megoldani, utána beszéljük meg a megoldást közösen. Az utolsó feladat opcionális, ha belefér az időbe.

Emlékeztetőként a megoldások is megtalálhatóak az útmutatóban is. Előbb azonban próbáljuk magunk megoldani a feladatot!

Tippek az IDE használatához¶

Típus (osztály, interfész, enum) keresése: Ctrl+Shift+T (Nem érdemes a Project explorer-ben a mappákat nyitogatni)
Fájl keresése: Ctrl+Shift+R
Hiányzó importok megjavítása: Ctrl+Shift+O
Kód formázása: Ctrl+Shift+F
Ha a Java Resources alatt egy package-en jobb klikk / New Class/Interfaces, akkor abba a package-be rakja az új elemet
Ha a nézeteket becsukjuk/átrendezzük, a default elrendezés visszaállítható: Window / Reset perspective
Font megnövelése (a tanári gépen hasznos):
- Window menü / Preferences, ott elkezdjük gépelni, hogy font, így megtalálja azt a beállítást, hogy Fonts and Colors
- Azt kiválasztva, a Basic kategória alatt kell a Text Fontot kijelölni, és a méretét pl. 18-asra állítani

Feladat 0: Adatbázis létrehozása¶

Csatlakozzunk Microsoft SQL Server Management Studio-val a szerverhez. Ezúttal nem localdb-t használunk, a szerver címe: localhost\sqlexpress. A bejelentkezéshez SQL Server Authentication módot válasszuk, a felhasználónév és a jelszó is sa.
Hozzunk létre egy adatvez nevű adatbázist. Ügyeljünk a névre, különben a Java projektben módosítanunk kell. Az adatbázis létrehozásának mikéntjét lásd az első gyakorlat anyagában. Ha a gépen már létezik az adatbázis, akkor nem kell újat létrehozni.
Futtassuk le az adatbázis inicializáló sql szkriptet az adatbázisban. Akkor is futtassuk le a szkriptet, ha már létezne az adatbázis (hogy a kezdeti állapotot visszakapjuk.)

Feladat 1: IDE indítása¶

Indítsuk el a Spring Tool Suite-ot innen: c:\Work\hatteralkalmazasok\sts-4.5.1.RELEASE\SpringToolSuite4.exe.
Indításkor megkérdezi, hova akarunk dolgozni (workspace), itt válasszuk ezt: c:\Work\hatteralkalmazasok\workspaces\adatvez
Ha az indulás után a Project Explorer-ben ott van egy korábbi gyakorlatról a webshop nevű projekt, azt töröljük ki: a projekten jobb klikk / Delete, amikor rákérdez, pipáljuk be, hogy a fájlrendszerről is törlődjön.

Feladat 2: Projekt importálása¶

Töltsük le a méréshez tartozó projekt vázat!
- Nyissunk egy command prompt-ot
- Navigáljunk el egy tetszőleges mappába, például c:\work\NEPTUN
- Adjuk ki a következő parancsot: git clone --depth 1 https://github.com/bmeviauac01/gyakorlat-jpa-kiindulo.git
Importáljuk a letöltött forráskódot a workspace-be:
- Nyissuk meg a File / Import...-ot
- Kezdjük el gépelni a textboxba, hogy Existing Maven Projects, így rá fog szűrni erre a típusra, és válasszuk ki ezt
- Keressük meg a letöltött webshop projektet (a webshop mappát a saját könyvtárunk alatt), Open Folder, utána a dialogban pipáljuk be a webshop-ot (lehet, hogy by default be lesz pipálva a pom.xml)
- Finish
Tekintsük át röviden a projektet:
- Ez egy maven alapú projekt. A maven parancssori build eszköz, ami IDE-khez is illeszthető. Fontos tulajdonsága, hogy képes a szükséges library függőségeket online repository-kból letölteni. Ha megnyitjuk a projekt gyökerében pom.xml-t, a maven konfig fájlját, dependency tagekben függőségeket látunk, amik (tranzitív módon) behúzzák a Hibernate-et mint JPA implementációt, a Spring Boot-ot, a Spring Data-t és a webréteghez szükséges Spring MVC-t és Thymeleaf-et. A laborban a maven offline működésre van konfigurálva, és előre le van töltve az összes függőség, így megelőzzük az esetleges hálózati problémákat.
- Az application.properties-ben van pár alapvető beállítás, itt a DB eléréshez ellenőrizzük az adatbázis URL-t (spring.datasource.url), a usernevet (spring.datasource.username) és jelszót (spring.datasource.password). Klasszikus Java EE alkalmazásban a persistence.xml-be írnánk be az adatbázis JNDI nevét, de a Spring Boot XML nélküli konfigurációt is támogat, itt ezt használjuk ki.
- A WebshopApplication a Spring Boot alkalmazás belépési pontja. Egy hagyományos webalkalmazást egy külön processzben futó webkonténerre (pl. Tomcat, Jetty) kellene telepíteni. Spring Boot-os fejlesztés esetében viszont maga a Spring Boot fog elindítani egy beágyazott webkonténert (alapértelmezésben Tomcat-et).
- A webes felület egyetlen oldal, az src\main\resources\templates\testPage.html. Ebbe nem fogunk majd belenyúlni. Standard html + Thymeleaf-es attribútumok láthatóak benne.
- WebshopController: a webréteget megvalósító controller osztály, ennek metódusai kezelik az alkalmazáshoz érkező HTTP kéréseket. Jellemzően lekérdezések eredményét akarjuk megjeleníteni az oldalon, ezért a lekérdezés eredményét a modellbe tesszük valamilyen néven, amire hivatkozni tudunk a Thymeleaf segítségével. A //TODO részekre kell majd bekötni az egyes feladatokat megvalósító metódusok meghívását.

Feladat 3: Entitások áttekintése¶

Az entitások már előre készen a hu.bme.aut.adatvez.webshop.model package-ben találhatók. Ezeket általában vagy kézzel írjuk meg, vagy generáljuk a DB táblákból pl. az Eclipse-es JPA plugin segítségével.
Az entitások közül nyissunk meg egyet, pl. Vat, látszik benne a @Entity, a @Id annotáció, illetve a kapcsolatok definiálására @OneToMany vagy @ManyToOne
Az entitásokhoz a Criteria API használatakor hasznos metamodel osztályok is generálódnak, ezekből nézzünk meg egyet a target\generated-sources\apt alatt (A pom.xml-ben látható maven-processor-plugin generálja egyébként őket a build során.)

Feladat 4: Lekérdezések¶

A leképzett adatmodellen fogalmazd meg az alábbi lekérdezéseket! A lekérdezéseket JPA és Spring Data használata esetén több módon is megvalósíthatjuk. Az alábbi feladatokban azt is megadjuk, milyen módon kell elkészíteni a lekérdezést, hogy mindegyikre lássunk példát.

Fontos megjegyezni, hogy ezek a módszerre vonatkozó megkötések csak oktatási szempontok miatt szerepelnek, valójában bármelyik módszerrel bármelyik lekérdezés megvalósítható lenne.

Az egyes feladatokat megvalósító metódusokat mindig a WebshopController osztály megfelelő //TODO kommentjeinél kell meghívni, majd a webalkalmazást futtatni és böngészőből tesztelni a http://localhost:9080 URL-en.

a) Listázd azon termékek nevét és raktárkészletét, melyből több mint 30 darab van raktáron! Módszer: Spring Data repository interfész, metódusnévből származtatott lekérdezés.

b) Írj olyan lekérdezést, mely kilistázza azon termékeket, melyből legalább kétszer rendeltek! Módszer: Spring Data repository custom implementációval, injektált EntityManagerrel készített JPQL query.

c) Listázd ki a legdrágább termék adatait! Módszer: Named query, amelyet Spring Data repository-ból hívunk meg, vagy custom implementációból, injektált EntityManagerrel hívunk meg, vagy a metódusnév és query név egyezése alapján.

Futás közben a Console nézetben látszódnak a Hibernate által generált SQL utasítások az application.properties-beli spring.jpa.show-sql=true konfig miatt.

Futtatás¶

Jobb klikk a webshop projekten > Debug As / Spring Boot App Ez debug módban indítja az alkalmazást, aminek hatására a beágyazott webkonténer elindul, és böngészőből a http://localhost:9080 URL-en elérhető az alkalmazás. Ha ezt egyszer jobb klikkel megcsináltuk, akkor később a toolbar Debug ikonját lenyitva is megtehetjük:

A futó alkalmazást a Console nézet piros Terminate ikonjával lehet leállítani. Ha leállítás nélkül próbáljuk újra futtatni, akkor a második processz ütközést jelent a 9080-as porton, és leáll. Ilyenkor a sikertelen második futtatás látszik a Console nézetben, a Terminate gomb pedig inaktív, mivel ez a futás már leállt. Nyomjuk meg a Terminate ikon melletti dupla szürke X ikont, ez el fogja távolítani a már leállított futtatásokat, és csak az aktív futtatás látszik, amin viszont már tudunk Terminate-et nyomni.

Ha a teljes Console nézetet bezárjuk véletlenül, elő lehet szedni Alt+Shift+Q, C gyorsbillentyűvel, vagy Window / Show View / Console menüvel.

A leállítás utáni újrafuttatáshoz az F11-et is használhatjuk.

A debug módban való futtatás jellegzetessége, hogy a HTML és bizonyos Java kód módosítások azonnal életbe lépnek. (A böngészőt persze frissíteni kell.) Újra kell viszont indítani az alkalmazást, ha a Java kódban:

új típust adtunk hozzá
annotációt adtunk hozzá/töröltünk/módosítottunk
új osztály- vagy tagváltozót, metódust vettünk fel
metódus szignatúrát módosítottunk

Röviden: a metódus törzsön belüli változásokon kívül mindig újraindítás lesz szükséges.

Megoldás

4.a feladat

Nyissuk meg a dao package-ben lévő ProductRepository interfészt, amely a Spring Data-s JpaRepository-ból származik (és az egyelőre üres ProductRepositoryCustom-ból). Találunk benne későbbi feladathoz kapcsolódó metódusokat, azokat csak figyeljük meg. Valamelyik @Query annotációval definiálja a futtatandó lekérdezést, valamelyiknél az is hiányzik. Nekünk sem lesz szükség @Query annotációra, mert a metódus neve alapján a Spring Data képes kitalálni a query-t. Tegyük tehát bele ezt az új metódust:

package hu.bme.aut.adatvez.webshop.dao;

import java.math.BigDecimal;
import java.util.List;
import hu.bme.aut.adatvez.webshop.model.Product;
import org.springframework.data.jpa.repository.JpaRepository;

public interface ProductRepository extends JpaRepository<Product, Long>, ProductRepositoryCustom {
  ...
  List<Product> findByStockGreaterThan(BigDecimal limit);
}

A WebshopController-ben már be van injektálva egy ProductRepository típusú tagváltozó, hívjuk meg rajta a metódust az 4.a TODO-nál:

@Controller
public class WebshopController {

  @Autowired
  ProductRepository productRepository;

  //...
  // 4.a feladat
  private List<Product> findProductsOver30() {
    return productRepository.findByStockGreaterThan(BigDecimal.valueOf(30));
  }
}

4.b feladat

A dao package-ben lévő ProductRepositoryCustom interfészbe vegyük fel egy findProductsOrderedAtLeastTwice nevű metódust:

package hu.bme.aut.adatvez.webshop.dao;

import hu.bme.aut.adatvez.webshop.model.Product;
import java.util.List;

public interface ProductRepositoryCustom {
  List<Product> findProductsOrderedAtLeastTwice();
}

A dao package-ben lévő ProductRepositoryImpl osztály hibás lesz emiatt, mert nem implementálja a ProductRepositoryCustom-ot. Nyissuk meg az osztályt, és az osztály elején, a sor elején megjelenő kis villanykörtére kattintva belegeneráltathatjuk a nem implementált metódus vázát:

Utána a törzsbe írhatjuk az implementációt, melynek lényege: injektált EntityManager-rel hozzuk létre és futtatjuk le a query-t. (Most látszik igazán, hogy az előző, Spring Data-s megoldás mennyi boilerplate kódot spórolt meg nekünk.)

package hu.bme.aut.adatvez.webshop.dao;

import hu.bme.aut.adatvez.webshop.model.Product;

import java.util.List;

import javax.persistence.EntityManager;
import javax.persistence.PersistenceContext;

public class ProductRepositoryImpl implements ProductRepositoryCustom {

  @PersistenceContext
  EntityManager em;

  @Override
  public List<Product> findProductsOrderedAtLeastTwice(){
    return em.createQuery("SELECT DISTINCT p FROM Product p " +
                          "LEFT JOIN FETCH p.orderitems " +
                          "WHERE size(p.orderitems) >= :itemsMin", Product.class)
          .setParameter("itemsMin", 2)
          .getResultList();
  }
}

Megjegyzés a megoldáshoz: az első ötletünk ez lehetne: SELECT p FROM Product p WHERE size(p.orderitems) /= :itemsMin. Írjuk be és próbáljuk ki előbb ezt, ilyenkor viszont org.hibernate.LazyInitializationException dobódik teszteléskor, mert lecsatolt állapotban akarunk kapcsolódó entitást elérni (amikor a táblázatot generálja a webréteg, és az orderitems listára hivatkozunk). Lehetséges megoldások:

Az application.properties-ben spring.jpa.open-in-view=true (ez lenne amúgy a default Spring Boot esetében, de a példa projektben direkt false-ra van állítva): Ilyenkor az EntityManager már a webes kérés legelején létrejön, és csak a view renderelése után záródik be, vagyis a Spring bean-beli metódusok visszatérése után is menedzselt állapotban lenne a Product entitás, és el lehetne kérni a kapcsolódó orderitems listát.
vagy @OneToMany(fetch=EAGER) az orderitems változóra
vagy EntityGraph definiálása és annak alkalmazása a query létrehozásakor
vagy LEFT JOIN FETCH, mi ezt választottuk a fenti megoldásban. E mellé a DISTINCT is kell, különben minden kapcsolódó Orderitem példányra külön Product sor is lesz.

A meghívás a WebshopController-ben triviális:

// 4.b feladat
private List<Product> findProductsOrderedAtLeastTwice() {
  // TODO
  return productRepository.findProductsOrderedAtLeastTwice();
}

4.c feladat

A Product osztályt nyissuk meg, ott a gyorsabb haladás érdekében már fogunk találni kész named query-ket, a másodikat kell használnunk:

@NamedQueries({
@NamedQuery(name="Product.findAll", query="SELECT p FROM Product p"),
@NamedQuery(name="Product.findMostExpensive", query="SELECT p FROM Product p WHERE p.price IN (SELECT MAX(p2.price) FROM Product p2)")
})

A named query-t két módon is meghívhatjuk. Ha lassú a haladás, elég az első módszerrel megcsinálni. Az első módszer, hogy a named query-vel egyező nevű metódust teszünk a ProductRepository-ba (leszámítva a Product. előtagot.) Vagyis:

public List<Product> findMostExpensive();

A másik lehetőség, hogy a ProductRepositoryImpl-ben, EntityManager-en keresztül hívjuk meg a named query-t:

@Override
public List<Product> findMostExpensiveProducts(){
  return em.createNamedQuery("Product.findMostExpensive", Product.class).getResultList();
}

Ilyenkor ezt a metódust ki kell még tenni a ProductRepositoryCustom interfészbe. Leggyorsabb így: Jobb klikk / Refactor / Pull up, és ott a metódus kiválasztható

Végül valamelyik verziót hívjuk meg a WebshopController megfelelő pontján:

// 4.c feladat
private List<Product> findMostExpensiveProducts() {
  // TODO
  // return productRepository.findMostExpensiveProducts();
  return productRepository.findMostExpensive();
}

Feladat 5: Adatmódosítás¶

A JPA nemcsak lekérdezéshez használható, hanem rajta keresztül módosítások is végrehajthatóak.

a) Írj olyan JPQL lekérdezést a ProductRepository interfészbe, mely a "Building items" árát megemeli 10 százalékkal!

b) Írj egy olyan metódust, amely létrehoz egy új kategóriát "Expensive toys" névvel, ha még nem létezik ilyen, és sorold át ide az összes olyan terméket, melynek ára, nagyobb, mint 8000 Ft!

c) Egyszerű önálló feladat: az 5.b feladat közös megoldásában egy EntityManager-en keresztül lefuttatott lekérdezéssel ellenőrizzük, hogy létezik-e "Expensive toys" nevű kategória. Valósítsd meg ugyanezt a lekérdezést Spring Data repository interfészben, metódus névből származtatott lekérdezéssel, és hívd meg a megfelelő ponton.

Megoldás

5.a feladat

A ProductRepository interfészben egy UPDATE query-t definiálunk. Azt, hogy ez módosító query, közölni kell a Spring Data-val (@Modifying), valamint tranzakcióba is kell tennünk @Transactional, az org.springframework... package-ből):

@Modifying
@Transactional
@Query("UPDATE Product p SET p.price=p.price*1.1 WHERE p.id IN
(SELECT p2.id FROM Product p2 WHERE p2.category.name=:categoryName)")
void categoryRaisePrice(@Param("categoryName") String categoryName);

Meghívása a WebshopController-ből:

// 5.a feladat
@RequestMapping(value = "/raisePriceOfBuildingItems", method = {
        RequestMethod.POST, RequestMethod.GET })
private String raisePriceOfBuildingItems() {
  // TODO
  productRepository.categoryRaisePrice("Building items");
  return "redirect:/";
}

Böngészőben a gomb megnyomása után a gomb alatti táblázatban látszódik az átárazás hatása.

5.b feladat

A dao package-be új osztály, CategoryService néven, @Service annotációval, szintén @Transactional metódussal:

@Service
public class CategoryService {

  @PersistenceContext
  private EntityManager em;

  @Autowired
  ProductRepository productRepository;

  @Transactional
  public void moveToExpensiveToys(double priceLimit){
    String name = "Expensive toys";
    Category categoryExpensive = null;
    List<Category> resultList =
      em.createQuery("SELECT c from Category c WHERE c.name=:name", Category.class)
        .setParameter("name", name)
        .getResultList();

    if(resultList.isEmpty()){
      //0 vagy null id érték esetén fog a @GeneratedValue működésbe lépni. Most primitív long az id-nk, az csak 0 tud lenni, null nem.
      categoryExpensive = new Category(0, name);
      em.persist(categoryExpensive);
    }else{
      categoryExpensive = resultList.get(0);
    }

    List<Product> expensiveProducts = productRepository.findByPriceGreaterThan(priceLimit);

    for (Product product : expensiveProducts) {
      categoryExpensive.addProduct(product);
    }
  }
}

Figyeljük meg, hogy a menedzselt entitás példányokat (amit tranzakción belül találunk meg query-vel, vagy most persist-áltunk frissen) nem kell explicit módon visszamenteni, tranzakció végén automatikusan DB-be íródnak a memóriabeli változások.

Meghívás a WebshopController-ből:

@Autowired
CategoryService categoryService;
...

// 5.b feladat
@RequestMapping(value = "/moveToExpensiveToys", method = {
        RequestMethod.POST, RequestMethod.GET })
private String moveToExpensiveToys() {
  // TODO
  categoryService.moveToExpensiveToys(8000.0);
  return "redirect:/";
}

Böngészőben a gomb megnyomása után látszódik a Drága játékok kategória tartalma

5.c feladat

A dao package-ben hozzunk létre egy új interfészt CategoryRepository néven, a ProductRepository mintájára (a Custom-os leszármazás nem kell, mert nem lesznek custom lekérdezéseink) egy metódussal:

public interface CategoryRepository extends JpaRepository<Category, Long>{
  List<Category> findByName(String name);
}

Ezután a CategoryService így egyszerűsödik le:

@Service
public class CategoryService {
...

  @Autowired
  CategoryRepository categoryRepository;

  @Transactional
  public void moveToExpensiveToys(double priceLimit){
    // ...
    List<Category> resultList = categoryRepository.findByName(name);
    //  ...
  }
}

Feladat 6: Tárolt eljárások használata¶

Hívd meg a JPA-ból a CreateNewPaymentMethod nevű tárolt eljárást, mely új fizetési mód rögzítésére szolgál, és visszaadja az új rekord azonosítóját!

Az SQL Server Management Studioban ellenőrizzük, hogy az adatbázis tartalmazza-e a CreateNewPaymentMethod nevű tárolt eljárást!

Ha nem, akkor az alábbi kódot futtasd le a Management Studioban a tárolt eljárás létrehozásához!

CREATE PROCEDURE CreateNewPaymentMethod
(
@Method nvarchar(20),
@Deadline int
)
AS
insert into PaymentMethod
values(@Method,@Deadline)
select scope_identity() as NewId

Megoldás

A PaymentMethod entitáson megtaláljuk az alábbi annotációt. Vessük össze a tárolt eljárást definiáló kóddal a változó neveket!

@NamedStoredProcedureQueries({
  @NamedStoredProcedureQuery(name = "createMethodSP",
      procedureName = "CreateNewPaymentMethod",
      parameters = {
            @StoredProcedureParameter(mode = ParameterMode.IN, name = "Method", type = String.class),
            @StoredProcedureParameter(mode = ParameterMode.IN, name = "Deadline", type = BigDecimal.class)
          })
})
public class Paymentmethod implements Serializable {
...

A named stored procedure query meghívható Spring Data repositoryból (dao package-en New Interface ... / PaymentmethodRepository):

public interface PaymentmethodRepository extends JpaRepository<Paymentmethod, Long> {

  @Procedure(name="createMethodSP")
  void newMethod(@Param("Method") String method, @Param("Deadline") BigDecimal deadline);
}

Spring Data nélkül így menne, EntityManager-en keresztül, erre valószínűleg már nem lesz idő:

@Service
public class PaymentmethodService {

  @PersistenceContext
  private EntityManager em;

  public void createNewMethod(Paymentmethod paymentMethod){
    StoredProcedureQuery sp = em.createNamedStoredProcedureQuery("createMethodSP");
    sp.setParameter("Method", paymentMethod.getMethod());
    sp.setParameter("Deadline", paymentMethod.getDeadline());
    sp.execute();
  }
}

A webrétegbeli meghívás:

Injektáljuk a WebshopController-be a PaymentmethodRepository interfészt:

@Autowired
PaymentmethodRepository paymentmethodRepository;

A WebshopController utolsó TODO-jánál hívjuk meg

paymentmethodRepository.newMethod(paymentMethod.getMethod(), paymentMethod.getDeadline());

A Paymentmethod entitás deadline és method tagváltozóin validációs constraint-eket találunk. Ezek az annotációk a Bean Validation API részei, amivel a webes rétegben használt Spring MVC, de a JPA és integrálódik, így a webrétegbeli és adatrétegbeli validáció konzisztens módon, redundanciamentesen definiálható.
```
@NotNull
private BigDecimal deadline;

@Column(name="METHOD")
@NotEmpty
private String method;
```

2023-09-04 Szerzők